antares-legacy-gems-converter 0.2.0

Convert Antares Legacy studies to GEMS format

AntaresLegacyModels-to-GEMS-Converter

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.

Related projects

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