Command-line interface

IXMP4 provides a command line interface for some of its functionality. Use the --help option to find out more about any command:

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

Platforms

Create a local sqlite platform:

ixmp4 platforms add test [--dsn sqlite://my/database/file.db]

If --dsn is not supplied you will be prompted to create an sqlite database at a standardized location.

Register a postgresql database:

ixmp4 platforms add postgres --dsn postgresql+psycopg://user:pw@host/db

List all available platforms from the local toml file and the configured manager API:

ixmp4 platforms list

Remove platforms from your local toml file:

ixmp4 platforms delete test
ixmp4 platforms delete postgres

IIASA Infrastructure

By default only public IIASA platforms will be available to all users. If you want to log in using your ECE Management Service account, use the ixmp4 login <username> command.

To delete locally saved credentials and return to anonymous use:

Alembic CLI

IXMP4 Server