cli

Define CO2MPAS command line interface.

co2mpas

CO2MPAS command line tool.

co2mpas [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

conf

Writes a CO2MPAS model-configuration file into OUTPUT_FILE.

OUTPUT_FILE: File path .yaml. [default: ./conf.yaml]

co2mpas conf [OPTIONS] [OUTPUT_FILE]

Options

-MC, --model-conf <model_conf>

Model-configuration file path .yaml.

-v, --verbosity <LVL>

Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

OUTPUT_FILE

Optional argument

demo

Writes a CO2MPAS demo files into OUTPUT_FOLDER.

OUTPUT_FOLDER: Folder path. [default: ./inputs]

co2mpas demo [OPTIONS] [OUTPUT_FOLDER]

Options

-v, --verbosity <LVL>

Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

OUTPUT_FOLDER

Optional argument

plot

Plots the full CO2MPAS model into CACHE_FOLDER.

co2mpas plot [OPTIONS]

Options

-C, --cache-folder <cache_folder>

Folder to save temporary html files.

Default

./cache_plot

-H, --host <host>

Hostname to listen on.

Default

127.0.0.1

-P, --port <port>

Port of the webserver.

Default

5000

-v, --verbosity <LVL>

Either CRITICAL, ERROR, WARNING, INFO or DEBUG

run

Run CO2MPAS for all files into INPUT_FILES.

INPUT_FILES: List of input files and/or folders

(format: .xlsx, .dill, .co2mpas.ta, .co2mpas).

co2mpas run [OPTIONS] [INPUT_FILES]...

Options

-O, --output-folder <output_folder>

Output folder.

Default

./outputs

-EK, --encryption-keys <encryption_keys>

Encryption keys for TA mode.

Default

./DICE_KEYS/dice.co2mpas.keys

-SK, --sign-key <sign_key>

User signature key for TA mode.

Default

./DICE_KEYS/sign.co2mpas.key

-C, --cache-folder <cache_folder>

Folder to save temporary html files.

Default

./cache_plot

-H, --host <host>

Hostname to listen on.

Default

127.0.0.1

-P, --port <port>

Port of the webserver.

Default

5000

-OT, --output-template <output_template>

Template output.

-MC, --model-conf <model_conf>

Model-configuration file path .yaml.

-OS, --only-summary

Do not save vehicle outputs, just the summary.

-AS, --augmented-summary

More outputs to the summary.

-HV, --hard-validation

Add extra data validations.

-DM, --declaration-mode

Use only the declaration data.

-ES, --enable-selector

Enable the selection of the best model to predict both H/L cycles.

-TA, --type-approval-mode

Is launched for TA?

-PL, --plot-workflow

Open workflow-plot in browser, after run finished.

-KP, --encryption-keys-passwords <encryption_keys_passwords>

Encryption keys passwords file for reading TA files.

Default

./DICE_KEYS/secret.passwords

-v, --verbosity <LVL>

Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

INPUT_FILES

Optional argument(s)

syncing

SYNCING command line tool.

co2mpas syncing [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

sync

Synchronise and re-sample data-sets defined in INPUT_FILE and writes shifts and synchronized data into the OUTPUT_FILE.

INPUT_FILE: Data-sets input file (format: .xlsx, .json).

OUTPUT_FILE: output file (format: .xlsx, .json).

DATA_NAMES: to filter out the data sets to synchronize.

co2mpas syncing sync [OPTIONS] INPUT_FILE OUTPUT_FILE [DATA_NAMES]...

Options

-R, --reference-name <reference_name>

Reference data-set name.

Default

theoretical

-x, --x-label <x_label>

Default var-name of the common x-axis to synchronise and re-sampled the data-sets.

Default

times

-y, --y-label <y_label>

Default var-name of the common y-axis to synchronise the data-sets.

Default

velocities

-I, --interpolation-method <interpolation_method>

Interpolation method used to re-sample all data-sets.

Default

linear

Options

linear | nearest | zero | slinear | quadratic | cubic | pchip | akima | integral | polynomial0 | polynomial1 | polynomial2 | polynomial3 | polynomial4 | spline5 | spline7 | spline9

-S, --sets-mapping-fpath <sets_mapping_fpath>

File path (.json) of data-sets mapping definition. It is like`{“<set-name>”: {“<new-name>”: “<old-name>”, …}, …}`.

-L, --labels-fpath <labels_fpath>

File path (.json) of reference-labels (i.e., “x”, “y”). It is like {“<set-name>”: {“x”: “<x-label>”, “y”: “<y-label>”}, …}.

-M, --methods-fpath <methods_fpath>

File path (.json) of interpolation methods. It is like {“<set-name>”: {“<var-name>”: “<interp>”, …}, …}.

-NS, --no-sync

Executes only the re-sampling without data synchronization.

-H, --header <header>

Row (0-indexed) to use for the column labels.

-v, --verbosity <LVL>

Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

INPUT_FILE

Required argument

OUTPUT_FILE

Required argument

DATA_NAMES

Optional argument(s)

template

Writes a sample template OUTPUT_FILE.

OUTPUT_FILE: SYNCING input template file (.xlsx). [default: ./datasync.xlsx]

co2mpas syncing template [OPTIONS] [OUTPUT_FILE]

Options

-CT, --cycle-type <cycle_type>

Cycle type.

Default

wltp

Options

nedc | wltp

-WC, --wltp-class <wltp_class>

WLTP vehicle class.

Default

class3b

Options

class1 | class2 | class3a | class3b

-GB, --gear-box-type <gear_box_type>

Gear box type.

Default

automatic

Options

manual | automatic

-v, --verbosity <LVL>

Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

OUTPUT_FILE

Optional argument

template

Writes a CO2MPAS input/output template into OUTPUT_FILE.

OUTPUT_FILE: File path .xlsx. [default: ./template.xlsx]

co2mpas template [OPTIONS] [OUTPUT_FILE]

Options

-TT, --template-type <template_type>

Template file type.

Default

input

Options

input | output

-v, --verbosity <LVL>

Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

OUTPUT_FILE

Optional argument