The ixmp4 package for scenario data management
Copyright (c) 2023-2024 IIASA - Energy, Climate, and Environment Program (ECE)
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.11 (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.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
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).
3 maintainers
Metadata
3 maintainers
Release files for ixmp4 0.17.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ixmp4-0.17.0.tar.gz | 150.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ixmp4-0.17.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 418.5 kB
Release files / ixmp4-0.17.0.tar.gz
| Download URL | ixmp4-0.17.0.tar.gz |
|---|---|
| Size | 150.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
58f04eebfb9bb5462b643115d5c5337243eef3c69743e483828d6ab01f6e314d
|
|
BLAKE2b-256 checksum How to use checksums |
32c2bb41de304346511dd165d43a5d4fc7726baf0b874667689713dabc534328
|
| Upload date | |
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2026.
Transparency logRelease files / ixmp4-0.17.0-py3-none-any.whl
| Download URL | ixmp4-0.17.0-py3-none-any.whl |
|---|---|
| Size | 268.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
438ebfa9751828b58a5137db3c8bfa237786fa1ce5511d4b1068bfa8103af65c
|
|
BLAKE2b-256 checksum How to use checksums |
1195956d38b1beb9cfa4116e989c2d11f65f35c419cfd1a8bcc9ce086cfc3e04
|
| Upload date | |
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2026.
Transparency log
