Module with data plugins that represent remote resources and so effectively are symbolic links.
Store a link to a file or folder on a remote machine.
Remember to pass a computer!
backend_entity (aiida.orm.implementation.entities.BackendEntity) – the backend model supporting this entity
Remove all content of the remote folder on the remote computer
Perform validation of the Data object.
validation of data source checks license and requires
attribution to be provided in field ‘description’ of source in
the case of any CC-BY* license. If such requirement is too
strict, one can remove/comment it out.
Connects to the remote folder and retrieves the content of a file.
relpath – The relative path of the file on the remote to retrieve.
destpath – The absolute path of where to store the file on the local machine.
Check if remote folder is empty
Connects to the remote folder and lists the directory content.
relpath – If ‘relpath’ is specified, lists the content of the given subfolder.
a flat list of file/directory names (as strings).
a list of dictionaries, where the documentation is in :py:class:Transport.listdir_withattributes.
Data plugin that models an archived folder on a remote computer.
A stashed folder is essentially an instance of RemoteData that has been archived. Archiving in this context can
simply mean copying the content of the folder to another location on the same or another filesystem as long as it is
on the same machine. In addition, the folder may have been compressed into a single file for efficiency or even
written to tape. The stash_mode attribute will distinguish how the folder was stashed which will allow the
implementation to also unstash it and transform it back into a RemoteData such that it can be used as an input
for new CalcJobs.
This class is a non-storable base class that merely registers the stash_mode attribute. Only its subclasses,
that actually implement a certain stash mode, can be instantiated and therefore stored. The reason for this design
is that because the behavior of the class can change significantly based on the mode employed to stash the files and
implementing all these variants in the same class will lead to an unintuitive interface where certain properties or
methods of the class will only be available or function properly based on the stash_mode.
Construct a new instance
stash_mode – the stashing mode with which the data was stashed on the remote.
Return the mode with which the data was stashed on the remote.
the stash mode.
Data plugin that models a folder with files of a completed calculation job that has been stashed through a copy.
This data plugin can and should be used to stash files if and only if the stash mode is StashMode.COPY.
target_basepath – the target basepath.
source_list – the list of source files.
Return the list of source files that were stashed.
the list of source files.
Return the target basepath.
the target basepath.
Data plugin that models a folder on a remote computer.