zen_garden.cli.zen_example_cli

Functions

create_zen_example_cli()

Entry point for the zen-example command-line interface.

zen_garden.cli.zen_example_cli.create_zen_example_cli()

Entry point for the zen-example command-line interface.

Creates a command line interface for downloading the dataset examples. The function parses a single required argument --dataset that specifies the name of the dataset to be downloaded. It then invokes the function function download_example_dataset with that argument.

The [project.scripts] section of the pyproject.toml declares that this function will be called whenever a user enters zen-example into the command prompt. This function is therefore creates the zen-example command line entry point.

Examples

Basic usage in a command line prompt:

>>> zen-example --dataset="1_base_case"