Skip to content

User Guide

Welcome to the pyetm User Guide! This guide provides comprehensive documentation for using pyetm to work with the Energy Transition Model API.

What You'll Learn

This guide covers all major features of pyetm, from basic scenario creation to advanced workflows.

Guide Contents

Working with Excel

Import and export scenarios using Excel files with full control over what data is included.

Topics covered:

  • Excel file structure
  • Importing scenarios with the update parameter
  • Setting export configuration
  • Exporting scenarios, inputs, curves, and outputs

Scenarios

Learn how to create, load, copy, and manage ETM scenarios programmatically.

Topics covered:

  • Creating new scenarios
    • Session vs Scenario
  • Loading existing scenarios
  • Properties and metadata
  • Copying scenarios (with and without preset links)
  • Collection classes (Scenarios, Sessions)
  • Bulk operations

Management

Advanced features for power users and automation workflows.

Topics covered:

  • Sessions and authentication
  • Manage metadata of scenarios
  • Manage scenario users

Inputs

Topics covered:*

  • Fetching
  • Viewing
  • Setting
  • Types and quirks

Gqueries

Topics covered:*

  • Adding
  • Executing
  • Viewing
  • Removing
  • Quirks

Custom Curves

Topics covered:*

  • Fetching
  • Viewing
  • Setting
  • Types and quirks

Sortables

Topics covered:*

  • Fetching
  • Viewing
  • Setting
  • Types and quirks

Submodel overview

Topics covered:

  • Validation and warnings
  • DataFrame import/export
  • Batch updates
  • Lazy loading

Getting Help

  • API Reference: See the API Reference for detailed documentation of all classes and methods
  • Issues: Report problems or ask questions on GitHub Issues