KPI Calculator Documentation

The KPI Calculator computes cost, energy, and emission key performance indicators from ESDL energy system models. Given an ESDL file and optional time series data, it returns standardized metrics — CAPEX, OPEX, NPV, LCOE, consumption, production, efficiency, CO2 emissions — that support design decisions in the OMOTES energy system design toolkit.

Everyone should start with the Getting Started guide — installation, usage examples, and results format.

Then, depending on your role:

  • Energy system designers and analysts interpreting results: continue with the KPI Guide.

  • Software developers integrating the calculator into a pipeline or contributing to the codebase: see Architecture and Development.

  • API users looking up function signatures and return types: see the API Reference.

Links:

  • PyPI — install with pip install kpi-calculator

  • GitHub — source code, issues, and pull requests

  • Releases — changelog and version history