pyetm Documentation

Welcome to the official documentation for pyetm, the Python client library for the Energy Transition Model (ETM) API.

What is pyetm?

pyetm is a powerful, modular Python package designed for users who want to programmatically interact with the Energy Transition Model. It provides a comprehensive set of tools for:

• Creating and managing ETM scenarios
• Modifying scenario inputs programmatically
• Querying results and exporting data
• Batch processing multiple scenarios
• Integrating ETM into automated workflows

Quick Links

• Installation Guide - Get started with pyetm
• Quick Start Tutorial - Your first scenario in 5 minutes
• User Guide - In-depth guides for common workflows
• API Reference - Complete API documentation
• Contributing - Help improve pyetm

About the Energy Transition Model

The Energy Transition Model (ETM) is an interactive online simulation tool for energy systems. It allows you to explore and quantify potential future energy systems in detail. The ETM is free to use, open source, and is available for (EU) countries, municipalities, and many other regions.

Learn more at energytransitionmodel.com.

Requirements

• Python: 3.12 or later
• ETM Account: Optional, but required for saving scenarios and accessing certain features

Getting Help

• Issues: Report bugs or request features on GitHub Issues
• ETM Documentation: General ETM documentation at docs.energytransitionmodel.com

License

pyetm is open-source software licensed under the MIT License.