Command Line Interface¶
Attention
The rmellipse CLI is designed to interact with an instance of NIST’s CDCS that is configured to behave as a repository that serves datasets and their metrological records. It is under active development, and this interface is expected to be extremely volatile. Instructions to configure and host this data archive are not a part of this repository. Documentation is presented only as part of the development process.
rme¶
A tool for executing traceable data-analysis workflows. Contains tools to help define, run, map, and release workflows that can be consumed downstream by other analysis as packages.
Usage
rme [OPTIONS] COMMAND [ARGS]...
Options
- --version¶
Show the version and exit.
log¶
Interact with log files created by jobs.
Usage
rme log [OPTIONS] JOB
Options
- --file¶
Print the log file path.
Arguments
- JOB¶
Required argument
map¶
Make a map of a workflow’s project structure.
Usage
rme map [OPTIONS] WORKFLOW_FILE
Options
- --show-attrs¶
Show the attrs of mapped items.
Arguments
- WORKFLOW_FILE¶
Required argument
release¶
Release a workflow to an archive.
Usage
rme release [OPTIONS] WORKFLOW_FILE HOST
Options
- --no-blobs¶
- --repeat-release¶
- --workspace <workspace>¶
- --max-threads <max_threads>¶
Maximum number of threads to use.
Arguments
- WORKFLOW_FILE¶
Required argument
- HOST¶
Required argument
run¶
Run a workflow in the project.
Usage
rme run [OPTIONS] WORKFLOW_FILE
Options
- --default-host <default_host>¶
- --max-threads <max_threads>¶
Arguments
- WORKFLOW_FILE¶
Required argument
sync¶
Synchronize the data environment with requirements.
Usage
rme sync [OPTIONS] WORKFLOW_FILE __DEFAULT_HOST
Options
- --force-download¶
- --force-relink¶
- --max-threads <max_threads>¶
- --update-all¶
Arguments
- WORKFLOW_FILE¶
Required argument
- __DEFAULT_HOST¶
Required argument