ETA MISTRAL

This repository implements the MISTRAL method for pinch-based optimization of decentral energy converter placement. It provides a CLI to configure backend optimization and a web interface for plotting and graph-based visualization of the modelled system.

Key Features

• Pinch-based placement optimization for decentral energy converters
• CLI-driven experiment configuration
• Dash web interface for interactive plotting
• Graph representation of the modelled energy system

Overview

Following the CLI workflow:

Module overview for development:

Installation

Python >=3.11,<3.14 is required.

To install the project along with its development dependencies:

poetry install

Followed by:

poetry run pre-commit install

Quick Start

See examples/experiment/ for a runnable experiment entry point and configuration.

Examples

poetry run python -m examples.experiment.main

Plotting-only workflow:

poetry run python -m examples.experiment.main_plot

Documentation

Sphinx sources are in docs/. Browse on GitLab: docs/

Build locally:

poetry install --with dev
cd docs && make html

Development

See CONTRIBUTING.md for setup, tests, and merge request workflow.

Pre-commit ensures that the repository accepts your commit, automatically fixes some code styling problems and provides hints for better coding.

Before submitting a merge request:

poetry run pytest
poetry run pre-commit run --all-files

Adding dependencies

poetry add <package-name>@latest

Important Note for the CLI Application

Do not forget to close (Ctrl+C) the Dash server when exiting the application.

Related software

• eta-fabrik public group — related ETA optimization and modeling repositories

Solver and third-party requirements

Backend optimization may require third-party solvers depending on configuration. This package is licensed under BSD-2-Clause. Any solver or runtime dependencies (commercial or open-source) are separate products with their own licenses and terms.

Citation

For academic use, cite this repository using CITATION.cff. See AUTHORS.rst for further contributors.

License

BSD-2-Clause — see LICENSE. See also CHANGELOG.md and SECURITY.md.