The ixmp4 package for scenario data management

Overview

The ixmp4 package is a data warehouse for high-powered scenario analysis in the domain of integrated assessment of climate change and energy systems modeling.

License

The ixmp4 package is released under the MIT license.

Install from pypi

You can install ixmp4 using pip:

pip install ixmp4

Install from GitHub

For installing the latest version directly from GitHub do the following.

Requirements

This project requires Python 3.10 (or higher) and poetry (>= 1.2).

Setup

# Install Poetry, minimum version >=1.2 required
curl -sSL https://install.python-poetry.org | python -

# You may have to reinitialize your shell at this point.
source ~/.bashrc

# Activate in-project virtualenvs
poetry config virtualenvs.in-project true

# Add dynamic versioning plugin
poetry self add "poetry-dynamic-versioning[plugin]"

# Install dependencies
# (using "--with dev,docs,server" if dev and docs dependencies should be installed as well)
poetry install --with dev,docs,server

# Activate virtual environment, e.g. using Bash/Zsh/Csh
# See https://python-poetry.org/docs/managing-environments/#activating-the-environment
eval $(poetry env activate)

# Copy the template environment configuration
cp template.env .env

# Add a test platform
ixmp4 platforms add test

# Start the asgi server
ixmp4 server start

CLI

ixmp4 --help

Docs

Read doc/README.md to build and serve the documentation locally.

Docker Image

Check docker/README.md to build and publish docker images.

Developing

See DEVELOPING.md for guidance. When contributing to this project via a Pull Request, add your name to the "authors" section in the pyproject.toml file.

Compatibility

This project mainly targets postgres version 16 but we test version 15 continously also. Tests with pyarrow installed alongside are also run due to its effect on pandas etc.

python	postgres	with pyarrow
3.10	16	true
3.10	16	false
3.11	16	true
3.11	16	false
3.12	16	true
3.12	16	false
3.13	16	true
3.13	16	false
3.13	15	false

Funding ackownledgement

ECEMF logo openENTRANCE logo Kopernikus project ARIADNE logo

The development of the ixmp4 package was funded from the EU Horizon 2020 projects openENTRANCE and ECEMF as well as the BMBF Kopernikus project ARIADNE (FKZ 03SFK5A by the German Federal Ministry of Education and Research).

EU logo This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No. 835896 and 101022622.

Metadata

Release files for ixmp4 0.16.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ixmp4 0.16.11
File	Size	Uploaded
ixmp4-0.16.11.tar.gz	145.5 kB	Sep 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for ixmp4 0.16.11
File	Interpreter	ABI	Platform	Reset
ixmp4-0.16.11-py3-none-any.whl 262.5 kB Sep 30, 2026	Python 3	none	any	Details

Total release size: 408.0 kB

Release files / ixmp4-0.16.11.tar.gz

Download URL	ixmp4-0.16.11.tar.gz
Size	145.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`9c8e55243476466cadc410e27d66ee98a4ca7d133ccacd0b2561c9d041aedb58`
BLAKE2b-256 checksum How to use checksums	`52cf746b0b4cb3e9ab3e9dbc64ce23097fe42543e383a7471d3031b52f2363c0`
Upload date	Sep 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/iiasa/ixmp4
Publishing commit: github.com/iiasa/ixmp4/tree/bfa89ba23d87906ac82acd5bfab24defd49cc2bd

Workflow

Publishing configuration: github.com/iiasa/ixmp4/blob/bfa89ba23d87906ac82acd5bfab24defd49cc2bd/.github/workflows/publish.yaml
Publishing logs: github.com/iiasa/ixmp4/actions/runs/36696117610/attempts/1

Artifact

Subject: ixmp4-0.16.11.tar.gz
SHA-256 checksum: 9c8e55243476466cadc410e27d66ee98a4ca7d133ccacd0b2561c9d041aedb58 Verifying attestations

Release files / ixmp4-0.16.11-py3-none-any.whl

Download URL	ixmp4-0.16.11-py3-none-any.whl
Size	262.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`29b53b464d765cab708caca852cf52cea4b4abef5ed73c4b4d36f838805d2b12`
BLAKE2b-256 checksum How to use checksums	`e1992da569b3de8d279ccb74fe848a7b8c0b0d11fe898f4197e6b3ef200e1034`
Upload date	Sep 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/iiasa/ixmp4
Publishing commit: github.com/iiasa/ixmp4/tree/bfa89ba23d87906ac82acd5bfab24defd49cc2bd

Workflow

Publishing configuration: github.com/iiasa/ixmp4/blob/bfa89ba23d87906ac82acd5bfab24defd49cc2bd/.github/workflows/publish.yaml
Publishing logs: github.com/iiasa/ixmp4/actions/runs/36696117610/attempts/1

Artifact

Subject: ixmp4-0.16.11-py3-none-any.whl
SHA-256 checksum: 29b53b464d765cab708caca852cf52cea4b4abef5ed73c4b4d36f838805d2b12 Verifying attestations