Skip to main content

ESFEX Logo

ESFEX — Energy System Flexibility Studio

A framework for power system capacity expansion and operational dispatch under high renewable penetration

CI codecov (python) Documentation DOI Python versions Julia License REUSE status OpenSSF Best Practices Ruff PyPI Downloads Status

Overview • Features • Installation • Quick Start • Studio • Documentation • Citation


Overview

ESFEX (Energy System Flexibility) is an open-source power system planning framework that co-optimizes generation, storage, and transmission investment over multi-decade horizons while explicitly capturing the operational flexibility constraints that arise in systems with high shares of variable renewable energy.

It couples a strategic capacity expansion planner (Master Problem) with a detailed operational dispatch engine through a two-stage decomposition — bridging the gap between long-term investment planning tools and short-term production cost models. Investment decisions are validated operationally (ramp rates, minimum stable generation, storage cycling, demand response, sector coupling) before being accepted, so the plan that ESFEX produces is one the system can actually operate.

ESFEX is implemented as a hybrid system: Python handles configuration, data management, orchestration, the GIS Studio, and post-processing; Julia (via JuMP) handles the mathematical optimization, leveraging its compiled performance for large-scale LP and MIP problems. The two communicate through juliacall. The architecture is modular: seven interlinked optimization models can be selectively enabled depending on the study scope.

Target Applications

  • Island power systems and isolated grids transitioning from diesel dependence to high RE penetration
  • Regional transmission planning with DC and AC power flows, N-1 security, and transmission investment
  • Sector coupling studies combining electricity, hydrogen (electrolyzer), fuel logistics (primary energy), and electric vehicles (V2G)
  • Policy analysis evaluating RE targets, CO₂ budgets, storage mandates, and technology cost trajectories
  • Near-optimal space exploration via MGA (Hop-Skip-Jump) or SPORES (per-objective sweep) for robust investment strategies under uncertainty
  • Academic research in energy systems optimization, flexibility quantification, and capacity expansion methodology

Key Features

Optimization Architecture

  • Two-stage decomposition — Master Problem (all years simultaneously, representative days/periods) + Operational Dispatch (year-by-year, full chronological year). Investments are operationally validated before acceptance.
  • Rolling horizon dispatch — Configurable overlapping time windows with boundary-condition propagation (battery SOC, generator status) and automatic result stitching.
  • Three simulation modes — development (LP, continuous commitment + investment), economic_dispatch (LP, fixed fleet), unit_commitment (MIP, binary startup/shutdown with min up/down times).
  • Unit decommissioning planning — Age-based retirement plus NPV-based retirement for flexible phase-out / retention of the unit inventory.

Power System Modeling

  • DC power flow — KCL/KVL constraints with a cycle-based formulation for meshed networks, voltage angle variables, piecewise-linear losses, and transmission investment.
  • AC optimal power flow — Four selectable ACOPF formulations: SOC relaxation (convex W-space), QC relaxation (McCormick envelopes), Polar NLP (exact V-θ), and Rectangular NLP (exact e-f), solved with Ipopt. Models voltage magnitudes, reactive balance, apparent-power limits (P² + Q² ≤ S²).
  • AC power flow verification — Post-DC Newton-Raphson AC power flow (native Julia solver + pandapower bridge for IEC 60909 short-circuit analysis) to validate voltage profiles and detect violations the DC approximation misses.
  • N-1 security — Automatic critical-contingency identification with post-contingency flow redistribution for generation and transmission, in both DC and AC.
  • Frequency stability — Post-contingency ROCOF, frequency nadir, and steady-state frequency via a center-of-inertia (COI) model, with N-1 screening of online generators.
  • Battery storage — Cyclic SOC, charge/discharge efficiency, calendar + throughput degradation, power/energy co-optimization with duration bounds.
  • Flexible demand — Multi-sector decomposition with criticality-weighted load shedding and intra-day shifting of deferrable loads.

Sector Coupling

ESFEX treats sector coupling as a first-class architectural principle. Any energy end-use — electrical, thermal, chemical, or kinetic — can be represented as a demand with its own temporal profile, criticality, and coupling constraints, so arbitrary power-to-X / X-to-power pathways can be modeled without touching the core formulation.

  • Electrolyzer (P2H₂) — Power-to-hydrogen with capacity investment, load-dependent efficiency, ramp constraints, and coupling to both the electrical balance and hydrogen demand.
  • Primary energy supply chain — Multi-fuel import nodes, storage tanks, and transport links (pipelines/tankers) coupled to generator fuel consumption.
  • Electric vehicles — Multi-method fleet adoption, multi-category vehicles (passenger, bus, truck…), time-of-day charging, and bidirectional V2G optimization, via evrex.
  • Rooftop solar — Stochastic adoption with behind-the-meter generation modeled as negative demand, via rooftex.
  • Flexible sectoral demand — Sector-specific criticality and temporal flexibility for demand-side participation in system balancing.

Planning and Analysis

  • MGA and SPORES — Near-optimal alternatives under a shared cost-slack envelope: classical Hop-Skip-Jump diversity (MGA) and per-objective sweeps (SPORES: minimum build, technology equity, regional equity, evolutionary distance).
  • Stochastic programming — Scenario-based expansion with probability-weighted costs and shared investment variables (EVPI/VSS analysis).
  • Sobol sensitivity analysis — Global sensitivity indices quantifying how input uncertainty (costs, demand growth, availability) propagates to investment decisions and system cost.
  • Progressive RE targets — Linear interpolation from initial to target RE penetration with annual increment bounds and constraint-based curtailment limits.

Tools and Interface

  • GIS-based Studio — A PySide6 + Leaflet.js map for visually building power systems: place nodes, generators, batteries, and transmission lines with polyline routing. Includes resource-assessment wizards for rooftop solar, utility-scale PV (solarex), wind (windrex), and OTEC (OTEX) availability profiles.
  • Plugin system — Directory-based plugins with simulation lifecycle hooks, GUI integration, and Julia overlay modules for custom constraints.
  • CLI — run, validate, export, studio, precompile, info and plugin commands (plus train-demand-model / build-demand-dataset demand-data utilities) with Rich formatting and progress tracking.
  • HDF5 output — Structured results with derived metrics (LCOE, VALCOE, capacity factor) exportable to CSV, Excel, and JSON.

Feature Comparison

Feature ESFEX PyPSA GenX Calliope TIMES OSeMOSYS
Capacity expansion ● ● ● ● ● ●
Operational dispatch (hourly) ● ● ● ● Time slices Time slices
Two-stage decomposition ● ○ ○ ○ ○ ○
Rolling horizon dispatch ● ● ○ ● ○ ○
DC power flow (KCL/KVL) ● ● ○ ○ ○ ○
AC optimal power flow ● ◐* ○ ○ ○ ○
Battery cyclic SOC ● ● ● ● Simplified Simplified
EV fleet modeling (V2G) ● Limited ○ ○ ● ○
Primary energy supply chain ● Limited ○ Limited ● Partial
Electrolyzer / P2H₂ ● ● ● ● ● Limited
Stochastic programming ● ● ○ ○ ● ○
N-1 security constraints ● ● ○ ○ ○ ○
MGA / near-optimal MGA + SPORES MGA MGA SPORES ○ ○
Sobol sensitivity ● ○ ○ ○ ○ ○
GIS-based Studio ● ○ ○ ○ ○ ○
Plugin / extension system ● ○ ○ ○ ○ ○
Solver backend JuMP Linopy JuMP Pyomo GAMS GLPK/CBC

● full support · ◐ partial · ○ not supported. *PyPSA performs an AC power flow via Newton-Raphson, not a full ACOPF. See docs/index.md for the extended comparison and citations.


Installation

ESFEX is a hybrid Python/Julia package. Python ≥ 3.10 and a working Julia ≥ 1.9 installation are required; the Julia dependencies are managed automatically through juliacall on first run.

Windows note: install Python from python.org or Anaconda/Miniconda — not from the Microsoft Store. The Store build runs in a sandbox with a redirected filesystem that breaks native DLL loading (PySide6/Qt) and per-user pip paths.

From PyPI

pip install esfex

Conda / Mamba

Create an environment where conda-forge supplies the native dependencies (Qt, the Julia bridge, HDF5, BLAS) and ESFEX is installed from PyPI on top:

conda env create -f environment.yml   # or: mamba env create -f environment.yml
conda activate esfex
esfex info

From source (development mode)

git clone https://github.com/Net-Zero-Horizon/ESFEX.git
cd ESFEX
pip install -e .

The GIS Studio (PySide6) is included in the core install — no extra is required.

Windows: if esfex is "not recognized"

esfex is a console script that pip installs into your environment's Scripts\ folder. pip does not modify PATH — if that folder is not already on PATH, the esfex command will not be found (pip prints a yellow "installed in '…\Scripts' which is not on PATH" warning). This is common on Windows when Python was installed without "Add Python to PATH", when the install fell back to a per-user location (%AppData%\Roaming\Python\…\Scripts), or with the Microsoft Store build of Python.

The robust, PATH-independent way to launch ESFEX is to run it as a module — this only needs python itself on PATH:

python -m esfex studio          # equivalent to: esfex studio
python -m esfex run -c my_system.yaml

Alternatively, install into a virtual environment and activate it (then Scripts\ is on PATH for that shell), and remember that PATH changes are only picked up by newly opened terminals:

python -m venv .venv
.\.venv\Scripts\activate
pip install esfex
esfex studio

Optional dependency groups

All runtime features — visualization, sensitivity analysis, resource workflows, benchmarking, and the ML/DL demand models — ship as core dependencies, so a plain pip install esfex already includes them. The only optional group is the developer tooling:

pip install -e ".[dev]"          # pytest, pytest-cov, ruff, black, mypy

Julia backend

The Julia optimization models live in src/esfex/julia/ with their own Project.toml. On the first esfex run, juliacall instantiates the Julia environment automatically. To build a sysimage for faster startup:

esfex precompile

Solvers

ESFEX supports ten solver backends, selectable per run (--solver) or in the config: HiGHS (default), CBC, GLPK, Gurobi, CPLEX, SCIP, and Xpress for LP/MIP problems; Clarabel and SCS for conic relaxations; and Ipopt for the nonlinear ACOPF formulations.

Only the open-source solvers are bundled (HiGHS, GLPK, Clarabel, SCS, Ipopt). The commercial / optional solvers (Gurobi, CPLEX, Xpress, CBC, SCIP) are not installed by default — they require a license and/or a large build that are the user's responsibility. This keeps the default install smaller and free of license-locked binaries.

They remain fully selectable — install one on demand:

# with a valid license already configured (e.g. GUROBI_HOME / GRB_LICENSE_FILE)
esfex add-solver gurobi        # cbc and scip are free / no license
esfex list-solvers             # show what's available
esfex remove-solver gurobi

add-solver installs the backing Julia package into a dedicated ESFEX solver environment that is stacked on Julia's load path — so it loads automatically on the next run, survives ESFEX upgrades, and always targets the Julia that ESFEX actually uses (no "installed into the wrong Julia" pitfalls). The install verifies the solver loads, so any license/build problem is reported immediately rather than mid-solve. Once installed, the solver appears in the Studio solver list and is usable via --solver <name>.


Quick Start

# Validate a configuration file
esfex validate -c my_system.yaml

# Run a 25-year capacity expansion + dispatch simulation
esfex run -c my_system.yaml --years 25 --verbose

# Run in unit-commitment (MIP) mode with a specific solver
esfex run -c my_system.yaml --mode unit_commitment --solver gurobi

# Export results to CSV
esfex export -r results/output.h5 -f csv

# Show version and system information
esfex info

Python API

from esfex import load_config
from esfex.runner import Orchestrator

config = load_config("my_system.yaml")
orchestrator = Orchestrator(config, output_dir="./results")
results = orchestrator.run(years=25)

for year in results:
    print(f"Year {year.year}: RE={year.re_penetration:.1%}, "
          f"Cost=${year.objective:,.0f}")

The Studio

ESFEX Studio — GIS-based power system designer

ESFEX ships with an interactive, map-based Studio for building and editing power-system configurations visually instead of hand-writing YAML.

esfex studio                     # start from a blank canvas
esfex studio -c my_system.yaml   # open an existing configuration

On Windows, if esfex is "not recognized", launch it as a module instead: python -m esfex studio. See Installation → Windows.

Place nodes, generators, batteries, and transmission lines directly on a Leaflet map with geographic routing, edit element parameters through validated forms, and run resource-assessment wizards (rooftop solar, utility PV via solarex, wind via windrex, OTEC via OTEX) to generate availability profiles. The Studio writes standard ESFEX YAML that the CLI and Python API consume unchanged.


Configuration

ESFEX is driven by a single YAML configuration describing the system topology, technologies, temporal settings, and solver options. Key sections:

Section Purpose
simulation_mode development, economic_dispatch, or unit_commitment
temporal Resolution, rolling-horizon window/overlap, investment resolution
solver Solver name, threads, gap, time limit, numerical options
nodes / buses Network topology and demand assignment
generators Thermal, renewable, and conversion technologies
batteries Storage with degradation and duration bounds
transmission Lines, transformers, converters; DC/AC power flow settings
development_zones Candidate sites for new generation investment

See the Configuration Reference and the User Guide for the full schema.


Project Structure

ESFEX/
├── src/esfex/
│   ├── cli.py                  # Typer CLI entry point
│   ├── runner.py               # Orchestrator (two-stage run loop)
│   ├── config/                 # Pydantic schema + YAML loader
│   ├── bridge/                 # Python↔Julia bridge (juliacall adapters)
│   ├── julia/                  # Julia optimization models (JuMP)
│   │   └── src/ESFEX.jl        # Power system, master problem, AC/DC flow, …
│   ├── models/                 # EV, rooftop solar, demand estimation
│   ├── io/                     # Demand loading, HDF5/CSV/Excel export
│   ├── topology/               # Network construction and reduction
│   ├── sensitivity/            # Sobol / sensitivity analysis
│   ├── analysis/               # Post-processing and derived metrics
│   ├── visualization/          # PySide6 GIS Studio + result charts
│   ├── plugins/                # Plugin framework and discovery
│   └── paths.py                # Central data-path registry
├── tests/                      # Test suite (pytest)
├── docs/                       # MkDocs documentation
├── mkdocs.yml                  # Documentation site config
└── pyproject.toml              # Package + dependency configuration

Documentation

Full documentation is built with MkDocs and lives under docs/.

Section Description
Getting Started Installation, quickstart, architecture, core concepts
Tutorials Single-system, multi-node, EV, stochastic, sensitivity
User Guide CLI, configuration, master problem, data formats
GUI Editor Interactive map-based grid editor (Studio)
Mathematical Formulation Master problem, dispatch, DC/AC flow, primary energy, electrolyzer
API Reference Python and Julia public API
Reference Config fields, HDF5 schema, constraint catalog, glossary

To serve the docs locally:

pip install mkdocs-material
mkdocs serve

Requirements

  • Python ≥ 3.10 (3.10, 3.11, 3.12 supported)
  • Julia ≥ 1.9 (managed via juliacall)
  • Core Python: NumPy, Pandas, SciPy, h5py, Pydantic, NetworkX, Typer, Rich, PySide6
  • A supported solver: HiGHS (default, open-source), or Gurobi / CPLEX / CBC / GLPK / SCIP / Xpress / Clarabel / SCS / Ipopt

Citation

If you use ESFEX in academic work, please cite:

@software{esfex2026,
  title   = {ESFEX: Energy System Flexibility — Power System Optimization},
  author  = {Soto Calvo, Manuel and Lee, Han Soo},
  year    = {2026},
  url     = {https://github.com/Net-Zero-Horizon/ESFEX},
  version = {0.1.3},
  license = {Apache-2.0}
}

Contributing

Contributions are welcome. Please read CONTRIBUTING.md for the requirements for acceptable contributions (coding standard, tests, and the pull-request process), with Development Setup for the development environment and Testing for the test workflow. Bug reports and feature requests go to the GitHub issue tracker.


License

ESFEX is released under the Apache License 2.0 — see LICENSE for the full text.

Metadata

Release files for esfex 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for esfex 0.3.0
File Size Uploaded Provenance Actions
esfex-0.3.0.tar.gz 7.1 MB With provenance Details for esfex-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for esfex 0.3.0
File Interpreter ABI Platform Actions
esfex-0.3.0-py3-none-any.whl Python 3 none any Details for esfex-0.3.0-py3-none-any.whl

Total release size: 14.1 MB

Release files / esfex-0.3.0.tar.gz

Download URL esfex-0.3.0.tar.gz
Size 7.1 MB
Tags Source
SHA-256 checksum
How to use checksums
e49c3e9693ddd99d280ce5634f67e0125f0b67a21fd29155634dc9e52cb51aa1
BLAKE2b-256 checksum
How to use checksums
3a4b891cb3eaf4496ae132c8337d069482e9f29af08a246e386dc57f1281700c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.

Transparency log

Release files / esfex-0.3.0-py3-none-any.whl

Download URL esfex-0.3.0-py3-none-any.whl
Size 7.0 MB
Tags Python 3
SHA-256 checksum
How to use checksums
90beefa3dfa9ff7f5bae034c42102019a75cb47a30255bbeab1772fd525e1e07
BLAKE2b-256 checksum
How to use checksums
658b39feed4546c7e2a06e45894d6c77efb4a84d0c0bafac85d07b21d75443d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.

Transparency log

Security for esfex 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for esfex-0.3.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page