AqueductHub / aqueductcore

Aqueduct Core is responsible for the core functionality of Aqueduct, an experiment management system.
https://aqueducthub.github.io/aqueductcore/
MIT License
23 stars 3 forks source link

CLI interface for importing/exporting instance data (Core) #102

Closed samiralavi closed 1 month ago

samiralavi commented 1 month ago

Interface for Importing/Exporting Data

Import and Export functionality runs by the admin user through the CLI interface of Aqueductcore. Depending on the installation of Aqueductcore (docker container, python package, source code, etc…), the user first needs to establish a terminal to the environment where Aqueductcore is installed. The environment should already have the required prerequisites and variables. Then the specified command can be executed like this:

> aqueductcore export [file path] -e/--experiment-files
> aqueductcore import[file path]

The -e/--experiment-files argument is a flag that determines if experiment files should be included or not. By default, if the flag is not provided, it has false value and experiment files won’t be exported.

The decision of partial (without experiments' files) or full (with experiments' files) export/import is left to the user. Partial export is useful when the file server is a NAS (network-attached storage) and it will be used for the new instance.