Attributes

Functions

List all collections.

(collection_uid=None, simulation_name=None, sync_fs=typer.Option(False, '--sync', '-s', help='Sync the collection with the filesystem.'))

List all collections, or all simulations in a specified collection. (alias: "ls")

collection_uid:typing_extensions.Annotated[typing.Optional[str], typer.typer.Argument(autocompletion=bamboost.cli._completion._get_uids_from_db, help='UID of the collection to list simulations for.')]=None
simulation_name:typing_extensions.Annotated[typing.Optional[str], typer.typer.Argument(help='Name of the simulation to display. If not provided, the collection is listed.', autocompletion=bamboost.cli._completion._get_simulation_names)]=None
sync_fs:bool=typer.Option(False, '--sync', '-s', help='Sync the collection with the filesystem.')

show_config(dir=typer.Option(None, '--dir', '-d', help='Directory to show the config for.'))

Show the active configuration.

dir:typing.Optional[str]=typer.Option(None, '--dir', '-d', help='Directory to show the config for.')

new(path) -> None

Create a new collection.

path:typing_extensions.Annotated[str, typer.typer.Argument(..., help='Path of the collection to create.')]

Command line interface for bamboost.

You can use this to list collections or simulations, create collections/simulations, and run simulations.

Check if the database exists.