Skip to main content

AntaresLegacyModels-to-GEMS-Converter

License: MPL v2 Python

A Python tool that converts Antares Simulator legacy studies into the GEMS format.

Background

Antares Simulator is an open-source power system simulator developed by RTE to assess the adequacy and economic performance of interconnected energy systems. Historically, the mathematical models of its components — thermal clusters, hydro units, short-term storage, and so on — were defined implicitly inside the solver's code.

GEMS (Generic Energy Modelling Scheme) is a high-level modelling language that brings these model definitions out of the codebase and into plain YAML files, where variables, parameters, and constraints are expressed using natural mathematical syntax. A GEMS model library can be used directly with Antares Simulator's dynamic modeler or with the GemsPy Python interpreter.

Purpose

This tool automates the translation of Antares Simulator studies into valid GEMS system files (YAML), making it straightforward to migrate existing studies to the new modelling framework — with no manual rewriting required.

Installation

Requires Python 3.11+.

From PyPI:

pip install antares-legacy-gems-converter

From source (for development):

Requires uv. Python library versions are pinned in pyproject.toml and locked in uv.lock (see COMPATIBILITY.md).

git clone https://github.com/AntaresSimulatorTeam/AntaresLegacyModels-to-GEMS-Converter.git
cd AntaresLegacyModels-to-GEMS-Converter
uv sync --group dev

Usage

First, fill in a configuration file (INI format):

[study]
study_path    = /path/to/your/antares-study
output_folder = /path/to/output
lib_paths     = /path/to/antares_legacy_models.yml
mode          = FULL

For HYBRID mode, also add:

[hybrid]
model_list = thermal, battery

Then run the converter:

antares-to-gems --conf path/to/config.ini --logging path/to/output.log

The --conf and --logging arguments are optional — they default to data/config.ini and data/logging.log respectively.

Project Description
Antares Simulator Open-source power system simulator
GEMS Graph-based algebraic modelling language
GemsPy Python interpreter for the GEMS modelling framework
PyPSA-to-GEMS-Converter Converter from PyPSA models to GEMS format

License

Mozilla Public License v2.0

Metadata

Release files for antares-legacy-gems-converter 0.5.2

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

Source distribution (sdist)

Source distribution for antares-legacy-gems-converter 0.5.2
File Size Uploaded Provenance Actions
antares_legacy_gems_converter-0.5.2.tar.gz 43.0 kB Without provenance Details for antares_legacy_gems_converter-0.5.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for antares-legacy-gems-converter 0.5.2
File Interpreter ABI Platform Actions
antares_legacy_gems_converter-0.5.2-py3-none-any.whl Python 3 none any Details for antares_legacy_gems_converter-0.5.2-py3-none-any.whl

Total release size: 109.4 kB

Release files / antares_legacy_gems_converter-0.5.2.tar.gz

Download URL antares_legacy_gems_converter-0.5.2.tar.gz
Size 43.0 kB
Tags Source
SHA-256 checksum
How to use checksums
e5184f69921811e040ff3da9cf50e4e1208efeb44821e1bcad62c107372d58ed
BLAKE2b-256 checksum
How to use checksums
affaa563b9bbaece074900141ac2cda8aacdf9d8a5e35d553d55bd2c267a32db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / antares_legacy_gems_converter-0.5.2-py3-none-any.whl

Download URL antares_legacy_gems_converter-0.5.2-py3-none-any.whl
Size 66.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3e4d91cb7122a7bd40c9d3f0112b0b34044793ab2c58fe56a10b27b50a02f640
BLAKE2b-256 checksum
How to use checksums
efa8599b501465174efa3c8f99ac0e53f6ed19138ef639d81b21e4294756eb0a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for antares-legacy-gems-converter 0.5.2

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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