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.
  • tests: Test commands for CI and development.

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.
  --include-csv           Include the csv file in the output.
  --help                  Show this message and exit.

simulate#

Simulate a GloBI building.

Usage:

globi simulate [OPTIONS]

Options:

  --config FILE           The path to the minimal building spec file which
                          will be used to configure the building.
  --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

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

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                 Override the scenario listed in the manifest
                                  file with the provided scenario.
  --skip-model-constructability-check
                                  Skip the model constructability check.
  --grid-run                      Dry run the experiment allocation by only
                                  simulating semantic field combinations.
  --epwzip-file PATH              Override the EPWZip file listed in the
                                  manifest file with the provided EPWZip file.
  --max-sims INTEGER              Override the maximum number of simulations
                                  to run.
  --help                          Show this message and exit.

tests#

Test commands for CI and development.

Usage:

globi tests [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

  • e2e: Run E2E experiment: allocate and poll for completion.
  • single-building: Run single building simulation test.

e2e#

Run E2E experiment: allocate and poll for completion.

Intended for CI; run with: make cli-native test e2e

Usage:

globi tests e2e [OPTIONS]

Options:

  --manifest PATH          Path to the manifest YAML file.
  --max-sims INTEGER       Maximum number of simulations to run.
  --poll-interval INTEGER  Seconds between status polls.
  --poll-timeout INTEGER   Maximum seconds to wait for completion.
  --help                   Show this message and exit.

single-building#

Run single building simulation test.

Intended for CI; run with: make cli-native tests single-building

Usage:

globi tests single-building [OPTIONS]

Options:

  --config PATH           Path to the single building config YAML file.
  --output-dir DIRECTORY  Output directory for simulation results.
  --help                  Show this message and exit.