Skip to main content
https://raw.githubusercontent.com/SESAM-Polimi/MARIO/767d2c0e9e42ae0b6acf7c3a1cc379d7bcd367fa/doc/source/_static/images/polimi.svg

Hypatia

An Operation and Planning Energy System Modelling Framework

What is it

Hypatia is an open source modelling framework written in Python that provides a technology-rich basis for optimizing both the operation and planning mode of the energy systems in short-term and long-term time horizons. Hypatia is able to analyze various energy transition scnerios based on different policies such as coal phase out, carbon taxes, renewable incetives and other national and international pledges for the possible future energy systems.

Quickstart

There are different ways to install hypatia software on your machine. The fastest one is through pip:

In case that you are using pip, it is suggested to create a new environment to avoid conflicts of the other packages. To create a new environment, you should use Anaconda Prompt:

conda create -n hypatia python=3.8

If you create a new environment for hypatia, you need to activate the environment each time you want to use it, by writing the following line in Anaconda Prompt:

conda activate hypatia

After activating the environment, you can use pip to install hypatia as follow:

pip install hypatia

Most of the open source solvers that are supported by CVXPY (the optimization library used in Hypatia), will be installed automatically with the software. For the commercial solvers, you should follow the specific installation methods. When Hypatia is installed, you can strat to use the embedded examples as a quick start:

from hypatia import load_example

# Loading the planning example
planning = load_example('Planning')

# Loading the Operation example
operation = load_example('Operation')

# See the configuration of systems
print(planning)
print(operation)

# see the description of systems
print(planning.description)
print(operation.description)

# Running models
planning.run(solver='glpk')

# Save the results
planning.to_csv(path= '../save/directory')

If you want to see the structure of inputs and how the examples are built, you can download the data files to a specific place in your machine:

from hypatia import download_example

# Downloading the Planning example
download_example(example='Planning', destination_path='Where/To/Save')

Python module requirements

Some of the key packages that Hypatia relies on are:

  1. Pandas

  2. Numpy

  3. Plotly

  4. Cvxpy (domain-specific language)

Hypatia supports different Open Source and Commercial solvers like:

License

https://img.shields.io/badge/License-Apache_2.0-blue.svg

This work is licensed under Apache 2.0

Release files for hypatia-test 0.1.1

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

Source distribution (sdist)

Source distribution for hypatia-test 0.1.1
File Size Uploaded
hypatia_test-0.1.1.tar.gz 70.6 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for hypatia-test 0.1.1
File Interpreter ABI Platform
hypatia_test-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 72.5 MB

Release files / hypatia_test-0.1.1.tar.gz

Download URL hypatia_test-0.1.1.tar.gz
Size 70.6 MB
Tags Source
SHA-256 checksum
How to use checksums
2a762c155b659e310a90be23ac005c2cbbdb19bbde66ede2c5593deef48facda
BLAKE2b-256 checksum
How to use checksums
88d42f8c228343f915d2e52b1788a49b4ea7c818e573d106bbfd8f167b62f871
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/3.10.0 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

Release files / hypatia_test-0.1.1-py3-none-any.whl

Download URL hypatia_test-0.1.1-py3-none-any.whl
Size 1.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
f0ae0e23883c7f877d738c66570b6f0b5705a19f38e74140bd27da85e16f6249
BLAKE2b-256 checksum
How to use checksums
8dff04c3a3f498e5f4ff81fcb12b2b908236f9b38f2742abcad686a76e32002a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/3.10.0 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page