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

convert-to-csvs

Convert a NetCDF scenario file to CSVs.

This command will produce two CSV files:

a main data CSV file with the numerical values of the scenario variables
a metadata CSV file

rcmip convert-to-csvs [OPTIONS] FILE OUTDIR

Arguments

FILE: Required argument

OUTDIR: Required argument

download

Download submitted files.

rcmip download [OPTIONS] OUTDIR

Options

--token <token>: Required Authentication token. Contact eearp@leeds.ac.uk 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

--unzip: If set, unzip .gz files directly instead of saving compressed file.

--endpoint <endpoint>: S3 endpoint (for testing)

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. Notice that this command will convert the data into a netCDF file prior to uploading it to the remote server if not already in that format.

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. Each file must contain all the variables pertaining to any simulation scenarios included in that file.

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

Optionally, a CSV file with comments about the data to be uploaded can be included in the submission with the –comments flag.

rcmip upload [OPTIONS] TIMESERIES... METADATA

Options

--token <token>: Required Authentication token. Contact eearp@leeds.ac.uk 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

--comments <comments>: CSV with comments to upload along data.

--endpoint <endpoint>: S3 endpoint (for testing)

Arguments

TIMESERIES: Required argument(s)

METADATA: Required argument

validate

Validate submission input.

Two 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.

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

Optionally, a CSV file with comments about the data to be uploaded can be included in the submission with the –comments flag. If included, it will also be validated.

rcmip validate [OPTIONS] TIMESERIES... METADATA

Options

--comments <comments>: CSV with comments to upload along data.

Arguments

TIMESERIES: Required argument(s)

METADATA: Required argument