Database setup and configuration

The ixmp4 package provides an interface to local and server-based database instances.

After installing ixmp4, you have to configure access to any non-public database instances.

Connections to a server-based database

To connect to a non-public ixmp4 database hosted by IIASA, you have to provide your username and password for the ECE Management Service.

In a console, run the following and enter your password once prompted:

ixmp4 login <username>

Warning

Your username and password will be saved locally in plain-text for future use!

From a Python environment, you can then access any ixmp4 database hosted by IIASA using the Platform class:

import ixmp4
mp = ixmp4.Platform("<database-name>")

For more information on authenticating with ixmp4 server infrastructure see the Authentication & Authorization section.

To initialize a new database locally, run the following in a console:

ixmp4 platforms add <database-name>

By default, an SQLite database will be created. If you want to add an existing database or a database of a different type, use the –dsn argument:

ixmp4 platforms add <database-name> --dsn postgresql+psycopg://user:pw@host/db

From a Python environment, you can then access this ixmp4 database using the Platform class:

import ixmp4
mp = ixmp4.Platform("<database-name>")

For a list of accessible ixmp4 database instances, run the following in a console:

ixmp4 platforms list

For more information on managing platforms with the console see the Command-line interface section.