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.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 antares-legacy-gems-converter 0.5.1
File Size Uploaded Provenance Actions
antares_legacy_gems_converter-0.5.1.tar.gz 41.3 kB Without provenance Details for antares_legacy_gems_converter-0.5.1.tar.gz

Built distribution (wheel)

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

Total release size: 105.3 kB

Release files / antares_legacy_gems_converter-0.5.1.tar.gz

Download URL antares_legacy_gems_converter-0.5.1.tar.gz
Size 41.3 kB
Tags Source
SHA-256 checksum
How to use checksums
7244cf0a0df5ae8e0719b6735b044b8c91a6d4bf2cd7f634c9735c3487d758a6
BLAKE2b-256 checksum
How to use checksums
1f2bb87d851b8cc93a13475574ede078dc6d67eb8dbe8bef1214de708083df1f
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.1-py3-none-any.whl

Download URL antares_legacy_gems_converter-0.5.1-py3-none-any.whl
Size 64.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
143db3c89913672bc9f09729e18ef842449c20597292ed7ea7f7e8ae2d8310c5
BLAKE2b-256 checksum
How to use checksums
ebfcf665096a4a6d6b03ec4bcaf01f4a2b21440801e16de274ce453a6054cde0
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.1

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