Skip to main content

a data warehouse for scenario analysis

Project description

The ixmp4 package for scenario data management

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

license: MIT python Code style: ruff

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
poetry shell

# 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 false
3.11 16 false
3.12 16 false
3.12 16 true
3.12 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 details


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.9.7.tar.gz (95.6 kB view details)

Uploaded Source

Built Distribution

ixmp4-0.9.7-py3-none-any.whl (197.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ixmp4-0.9.7.tar.gz
  • Upload date:
  • Size: 95.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ixmp4-0.9.7.tar.gz
Algorithm Hash digest
SHA256 8769134acfd226e651354c6da4d2c9a59a0a678ddeb2f69c3bbb5592b861a4b2
MD5 5d181e32fd5cc904264bd4cbcf4d02bb
BLAKE2b-256 87d458fd066938bc9dd496a40e06e756a8c8854ee6cfa080fb39b5399a7e06b7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ixmp4-0.9.7-py3-none-any.whl
  • Upload date:
  • Size: 197.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ixmp4-0.9.7-py3-none-any.whl
Algorithm Hash digest
SHA256 33763980ea184eb1d05c82f5ed5c9e442b4b5c032521f9ff8157ace20c087992
MD5 accb6ceca5406d3eb5047f2aa6606df7
BLAKE2b-256 15d2c8a939901a9b6cee81142b4d92d00a5bbf505d34b769c98a8bc7d54019ea

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page