Command Line Interface (ixmp4.cli)

Module contents

Check the CLI help command on how to use it:

ixmp4 --help
ixmp4 platforms --help
ixmp4 test --help
ixmp4 server --help

ixmp4.cli.login(username: str = <typer.models.ArgumentInfo object>, password: str = <typer.models.OptionInfo object>) → None

ixmp4.cli.logout() → None

Submodules

ixmp4.cli.platforms module

ixmp4.cli.platforms.add(name: str = <typer.models.ArgumentInfo object>, dsn: str | None = <typer.models.OptionInfo object>) → None

ixmp4.cli.platforms.create_cycle(generator: Generator[T, Any, None], name: str, total: int) → Iterator[T]

ixmp4.cli.platforms.generate(platform_name: str, num_models: int = <typer.models.OptionInfo object>, num_runs: int = <typer.models.OptionInfo object>, num_regions: int = <typer.models.OptionInfo object>, num_variables: int = <typer.models.OptionInfo object>, num_units: int = <typer.models.OptionInfo object>, num_datapoints: int = <typer.models.OptionInfo object>) → None

ixmp4.cli.platforms.generate_data(generator: MockDataGenerator) → None

ixmp4.cli.platforms.list_() → None

ixmp4.cli.platforms.prompt_sqlite_dsn(name: str) → str

ixmp4.cli.platforms.prompt_sqlite_removal(dsn: str) → None

ixmp4.cli.platforms.remove(name: str = <typer.models.ArgumentInfo object>) → None

ixmp4.cli.platforms.stamp(revision: str) → None

ixmp4.cli.platforms.tabulate_manager_platforms(platforms: list[ManagerPlatformInfo]) → None

ixmp4.cli.platforms.tabulate_toml_platforms(platforms: list[TomlPlatformInfo]) → None

ixmp4.cli.platforms.upgrade() → None

ixmp4.cli.platforms.validate_dsn(dsn: str | None) → str | None

ixmp4.cli.platforms.validate_name(name: str) → str

ixmp4.cli.server module

ixmp4.cli.server.dump_schema(output_file: ~typer.models.FileTextWrite | None = <typer.models.OptionInfo object>) → None

ixmp4.cli.server.start(host: str = <typer.models.OptionInfo object>, port: int = <typer.models.OptionInfo object>, workers: int = <typer.models.OptionInfo object>, reload: bool = <typer.models.OptionInfo object>) → None: Starts the ixmp4 web api.

ixmp4.cli.utils module