The ixmp4 package for scenario data management

Copyright (c) 2023-2024 IIASA - Energy, Climate, and Environment Program (ECE)

license: MIT python Code style: ruff Checked with mypy

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.

Project links

Data verified by PyPI on Aug 7, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.16.8)

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for danielhuppmann from gravatar.com danielhuppmann Avatar for iiasa-ece from gravatar.com iiasa-ece Avatar for phackstock from gravatar.com phackstock

Credits

Author: Max Wolschlager

GitHub Statistics

Data verified by PyPI on Aug 7, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python <3.15, >=3.10

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ixmp4-0.16.7.tar.gz (142.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ixmp4-0.16.7-py3-none-any.whl (259.1 kB view details)

Uploaded Python 3

File details

Details for the file ixmp4-0.16.7.tar.gz.

File metadata

  • Download URL: ixmp4-0.16.7.tar.gz
  • Upload date:
  • Size: 142.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ixmp4-0.16.7.tar.gz
Algorithm Hash digest
SHA256 176791a11ae657d1f4f1919f39027975b53f35d72747fbe80f91ba01ca4837c0
MD5 8fbc3fb2697376cad7e3f997aab27631
BLAKE2b-256 523ebabb98924c9921c6ba15ae33daf9fbc4deb3661f90cc74491dfa3965f62b

See more details on using hashes here.

Provenance

The following attestation bundles were made for ixmp4-0.16.7.tar.gz:

Publisher: publish.yaml on iiasa/ixmp4

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ixmp4-0.16.7-py3-none-any.whl.

File metadata

  • Download URL: ixmp4-0.16.7-py3-none-any.whl
  • Upload date:
  • Size: 259.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ixmp4-0.16.7-py3-none-any.whl
Algorithm Hash digest
SHA256 fa5579e4e36e52fd4b0f049af37c816008f43b66c2eb9c0c04da0d36cbe3d1f3
MD5 c98fc8f98d7b2ec67229a7f29e0b223f
BLAKE2b-256 a8783ec21c1ede3926ea12efefc38d632c17af66c4e57029aabc12b0edac469b

See more details on using hashes here.

Provenance

The following attestation bundles were made for ixmp4-0.16.7-py3-none-any.whl:

Publisher: publish.yaml on iiasa/ixmp4

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page