Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
ZEN-garden
Logo
ZEN-garden

Welcome

  • Overview
  • Features
  • Example use cases
  • Acknowledgements
  • Citing
  • License

Quick Start

  • Installation
  • Building a model
  • Running a model
  • Summary

Tutorials

  • Tutorials: Overview and Setup
  • Tutorial 1: Analyze Outputs
  • Tutorial 2: Change Configurations
  • Tutorial 3: Add Technologies and Carriers
  • Tutorial 4: Create Scenarios
  • Tutorial 5: Time Series Aggregation
  • Tutorial 6: Unit consistency
  • Tutorial 7: Scaling
  • Tutorial 8: Operation Scenarios
  • Tutorial 9: Infeasibilities
  • Tutorial 10: Troubleshooting

ZEN-garden in detail

  • Input data structure
  • Configurations
  • Notation: Sets, parameters, variables, and constraints
  • Mathematical formulation
  • Additional Features
  • Dataset Examples

Plugins

  • Overview
  • Available Plugins

References

  • API Reference
    • General
      • zen_garden.cli
        • zen_garden.cli.zen_example_cli
        • zen_garden.cli.zen_garden_cli
        • zen_garden.cli.zen_operation_cli
        • zen_garden.cli.zen_visualization_cli
      • zen_garden.runner
      • zen_garden.utils
    • Model
      • zen_garden.optimization_setup
      • zen_garden.default_config
      • zen_garden.model.component
      • zen_garden.model.element
      • zen_garden.model.energy_system
      • zen_garden.model.time_steps
      • zen_garden.model.carrier.carrier
      • zen_garden.model.technology.technology
      • zen_garden.model.technology.conversion_technology
      • zen_garden.model.technology.storage_technology
      • zen_garden.model.technology.transport_technology
      • zen_garden.model.technology.retrofitting_technology
    • Postprocess
      • zen_garden.postprocess.comparisons
      • zen_garden.postprocess.postprocess
      • zen_garden.postprocess.results.results
      • zen_garden.postprocess.results.solution_loader
    • Preprocess
      • zen_garden.preprocess.extract_input_data
      • zen_garden.preprocess.time_series_aggregation
      • zen_garden.preprocess.unit_handling
    • Plugin system
      • zen_garden.plugin_system.events
      • zen_garden.plugin_system.loader
  • Class Structure
  • Changelog

Developer Guide

  • Installation for Developers
  • Running and Debugging
  • Contribution Guide
  • Documentation Guide
  • Testing
  • Adding Sets, Parameters, Variables, and Constraints
  • Writing constraints in Linopy
  • Implementing plugins
  • GitHub Actions
  • Tips and Tricks

Support

  • Where to get help?
Back to top
View this page

API Reference¶

Release:

Date:

Jun 03, 2026

Overview¶

Alternative text

ZEN-garden¶

  • General
  • Model
  • Postprocess
  • Preprocess
  • Plugin system
Next
General
Previous
Available Plugins
Copyright © 2025, Reliability and Risk Engineering lab, ETH Zurich
Made with Sphinx and @pradyunsg's Furo
On this page
  • API Reference
    • Overview
    • ZEN-garden