diff --git a/.zenodo.json b/.zenodo.json index cc6cbbd..ac2eb22 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -1,5 +1,5 @@ { - "title": "CADET-RDM: Version 1.1.2", + "title": "CADET-RDM: Version 1.2.0", "upload_type": "software", "creators": [ { @@ -8,17 +8,17 @@ "affiliation": "Forschungszentrum Jülich" }, { - "name": "Schmölder, Johannes", - "orcid": "0000-0003-0446-7209", + "name": "Lanzrath, Hannah", + "orcid": "0000-0002-2675-9002", "affiliation": "Forschungszentrum Jülich" }, { - "name": "Hannah, Lanzrath", - "orcid": "0000-0002-2675-9002", + "name": "Schmölder, Johannes", + "orcid": "0000-0003-0446-7209", "affiliation": "Forschungszentrum Jülich" }, { - "name": "Katharina, Paul", + "name": "Paul, Katharina", "orcid": "0009-0008-5016-0340", "affiliation": "Forschungszentrum Jülich" }, @@ -32,7 +32,7 @@ "keywords": [ "research data management", "simulation", "reproducibility" ], - "version": "1.1.2", + "version": "1.2.0", "access_right": "open", "communities": [ { "identifier": "open-source" } diff --git a/cadetrdm/__init__.py b/cadetrdm/__init__.py index 8ca5c1d..f05fb59 100644 --- a/cadetrdm/__init__.py +++ b/cadetrdm/__init__.py @@ -1,4 +1,4 @@ -__version__ = "1.1.2" +__version__ = "1.2.0" from cadetrdm.conda_env_utils import prepare_conda_env from cadetrdm.options import Options diff --git a/docs/source/user_guide/cases.md b/docs/source/user_guide/cases.md index 7d956cc..2bb39af 100644 --- a/docs/source/user_guide/cases.md +++ b/docs/source/user_guide/cases.md @@ -1,5 +1,5 @@ (cases)= -# Cases: options, environments and reproducible results +# Cases CADET-RDM identifies every result by the combination of three things: @@ -148,6 +148,23 @@ results_path = case.load( ) ``` +### Loading results from the command line + +Cases are created and run in Python, but their results can also be loaded with the CLI. +`rdm data log` lists all runs in the output log, with their output branch, project commit and options hash: + +```bash +rdm data log +``` + +Copy the results of a run into the cache by its output branch: + +```bash +rdm data cache +``` + +The CLI does not look up results by options or environment; use `Case.load()` for that. + ## Results are unique and read-only Every run creates its own output branch, named after the time of the run, the project branch and commit, plus a random suffix (see {ref}`Python interface `). diff --git a/docs/source/user_guide/command-line-interface.md b/docs/source/user_guide/command-line-interface.md index 6ba9e92..cf59da5 100644 --- a/docs/source/user_guide/command-line-interface.md +++ b/docs/source/user_guide/command-line-interface.md @@ -112,7 +112,13 @@ Each run is stored in an output branch named: The random six-character suffix keeps runs that start at the same time apart. The prefix is optional and set with `options.branch_prefix`. -Cache results locally: +List all runs in the output log, including their output branches and options hashes: + +```bash +rdm data log +``` + +Cache the results of a run locally: ```bash rdm data cache