Skip to content

A cli is provided.

globi#

The GloBI CLI.

Use this to create, manage, and submit GloBI experiments.

Usage:

globi [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

  • get: Get a GloBI experiment from different sources.
  • simulate: Simulate a GloBI building.
  • submit: Submit a GloBI experiment from different sources.

get#

Get a GloBI experiment from different sources.

Usage:

globi get [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

  • experiment: Get a GloBI experiment from a manifest file.

experiment#

Get a GloBI experiment from a manifest file.

Usage:

globi get experiment [OPTIONS]

Options:

  --run-name TEXT         The name of the run to get.  [required]
  --version TEXT          The version of the run to get.
  --dataframe-key TEXT    The dataframe to get.
  --output-dir DIRECTORY  The path to the directory to use for the simulation.
  --help                  Show this message and exit.

simulate#

Simulate a GloBI building.

Usage:

globi simulate [OPTIONS]

Options:

  --config FILE           The path to the manifest file which will be used to
                          configure the building.  [required]
  --output-dir DIRECTORY  The path to the directory to use for the simulation.
  --help                  Show this message and exit.

submit#

Submit a GloBI experiment from different sources.

Usage:

globi submit [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

  • artifacts: Submit a GloBI experiment from a set of artifacts.
  • manifest: Submit a GloBI experiment from a manifest file.

artifacts#

Submit a GloBI experiment from a set of artifacts.

Usage:

globi submit artifacts [OPTIONS]

Options:

  --help  Show this message and exit.

manifest#

Submit a GloBI experiment from a manifest file.

Usage:

globi submit manifest [OPTIONS]

Options:

  --path PATH                     The path to the manifest file which will be
                                  used to configure the experiment.
  --scenario TEXT                 The scenario to use for the experiment.
  --skip-model-constructability-check
                                  Skip the model constructability check.
  --grid-run                      Dry run the experiment allocation by only
                                  testing semantic field combinations.
  --epwzip-file PATH              The path to the EPWZip file to use for the
                                  experiment.
  --help                          Show this message and exit.