Command-line interface

rcmip

Command-line interface for pyrcmip

rcmip [OPTIONS] COMMAND [ARGS]...

Options

--log-level <log_level>

Options: DEBUG | INFO | WARNING | ERROR | EXCEPTION | CRITICAL

download

Download submitted files

rcmip download [OPTIONS] OUTDIR

Options

--token <token>: Required Authentication token. Contact zebedee.nicholls@climate-energy-college.org for a token

--bucket <bucket>

--model <model>: Required

--version <version>: Required Version of the data that was uploaded. Must be a valid semver version string (https://semver.org/). For example 2.0.0

Arguments

OUTDIR: Required argument

upload

Validate and upload data to RCMIP’s S3 bucket.

All the files for a given version have to be uploaded together.

One or more TIMESERIES files in which the timeseries output is stored. These should be CSV or NetCDF files conforming to the format expected by scmdata. Multiple timeseries inputs can be specified, but care must be taken to ensure that all of the individual timeseries have unique metadata. Each timeseries file will be validated and uploaded independently.

MODEL_REPORTED is the CSV file in which the model reported metrics are stored.

METADATA is the CSV file in which the metadata output is stored.

rcmip upload [OPTIONS] TIMESERIES... MODEL_REPORTED METADATA

Options

--token <token>: Required Authentication token. Contact zebedee.nicholls@climate-energy-college.org for a token

--bucket <bucket>

--model <model>: Required

--version <version>: Required Version of the data being uploaded. Must be a valid semver version string (https://semver.org/). For example 2.0.0

Arguments

TIMESERIES: Required argument(s)

MODEL_REPORTED: Required argument

METADATA: Required argument

validate

Validate submission input

Three different types of input data are required for validation, namely:

One or more TIMESERIES files in which the timeseries output is stored. These should be CSV or NetCDF files conforming to the format expected by scmdata. Multiple timeseries inputs can be specified, but care must be taken to ensure that all of the individual timeseries have unique metadata.

MODEL_REPORTED is the CSV file in which the model reported metrics are stored.

METADATA is the CSV file in which the metadata output is stored.

rcmip validate [OPTIONS] TIMESERIES... MODEL_REPORTED METADATA

Arguments

TIMESERIES: Required argument(s)

MODEL_REPORTED: Required argument

METADATA: Required argument