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

upload¶

Validate and upload data to RCMIP’s S3 bucket.

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

timeseries is the file in which the timeseries output is stored. model_reported is the file in which the model reported metrics are stored. metadata is the 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

MODEL_REPORTED¶: Required argument

METADATA¶: Required argument

validate¶

Validate submission input

timeseries is the file in which the timeseries output is stored. model_reported is the file in which the model reported metrics are stored. metadata is the file in which the metadata output is stored.

rcmip validate [OPTIONS] TIMESERIES MODEL_REPORTED METADATA

Arguments

TIMESERIES¶: Required argument

MODEL_REPORTED¶: Required argument

METADATA¶: Required argument