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.
  • output-viz: Generate a d3 based dashboard from globi outputs.
  • simulate: Simulate a GloBI building.
  • submit: Submit a GloBI experiment from different sources.
  • ui: Launch the GloBI Streamlit UI for interactive configuration and simulation.

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.

output-viz#

Generate a d3 based dashboard from globi outputs.

Usage:

globi output-viz [OPTIONS]

Options:

  --run-name TEXT         the name of the run (e.g.
                          TestRegion/dryrun/Baseline)  [required]
  --version TEXT          the version of the run (e.g. 1.0.0). if not
                          provided, uses latest version
  --output-dir DIRECTORY  directory containing output files (default: outputs)
                          [default: outputs]
  --html-path FILE        path for the generated html dashboard (default:
                          <output-dir>/<run-name>/<version>/output_viz.html)
  --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-tests INTEGER             Override the maximum number of tests in a
                                  grid run.
  --help                          Show this message and exit.

ui#

Launch the GloBI Streamlit UI for interactive configuration and simulation.

Usage:

globi ui [OPTIONS]

Options:

  --port INTEGER  Port to run the Streamlit UI on.
  --host TEXT     Host to run the Streamlit UI on.
  --help          Show this message and exit.