main

lbt-recipes

lbt-recipes [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

run

Run a recipe that is installed within the lbt-recipes package.

Args:

recipe_name: The name of a recipe within the package to be

executed (eg. pmv-comfort-map).

inputs: Path to the JSON file that specifies inputs for the recipe.

lbt-recipes run [OPTIONS] RECIPE_NAME INPUTS

Options

-p, --project-folder <project_folder>

Path to a project folder in which the recipe will be executed. If None, the default project folder for the Recipe will be used.

-w, --workers <workers>

An integer to set the number of CPUs used in the execution of the recipe. This number should not exceed the number of CPUs on the machine running the simulation and should be lower if other tasks are running while the simulation is running.

Default

2

-d, --debug <debug>

Optional path to a debug folder. If debug folder is provided all the steps of the simulation will be executed inside the debug folder which can be used for furthur inspection.

Arguments

RECIPE_NAME

Required argument

INPUTS

Required argument

viz

Check if lbt-recipes is flying!

lbt-recipes viz [OPTIONS]