esfex 0.1.0__tar.gz

esfex-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may accept and charge a
+      fee for acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may act only on Your own behalf and on
+      Your sole responsibility, not on behalf of any other Contributor, and
+      only if You agree to indemnify, defend, and hold each Contributor
+      harmless for any liability incurred by, or claims asserted against,
+      such Contributor by reason of your accepting any such warranty or
+      additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025-2026 Manuel Soto Calvo
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.

esfex-0.1.0/PKG-INFO

@@ -0,0 +1,421 @@
+Metadata-Version: 2.4
+Name: esfex
+Version: 0.1.0
+Summary: ESFEX: Energy System FlEXibility — Power System Optimization
+Author-email: Manuel <manuel@example.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/msotocalvo/ESFEX
+Project-URL: Documentation, https://github.com/msotocalvo/ESFEX#readme
+Project-URL: Repository, https://github.com/msotocalvo/ESFEX
+Keywords: power systems,optimization,renewable energy,flexibility,JuMP
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: h5py>=3.8.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: typer>=0.9.0
+Requires-Dist: juliacall>=0.9.14
+Requires-Dist: networkx>=3.0
+Requires-Dist: openpyxl>=3.1.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: psutil>=5.9.0
+Requires-Dist: scipy>=1.10.0
+Requires-Dist: windrex>=0.1.0
+Requires-Dist: solarex>=0.1.0
+Requires-Dist: rooftex>=0.1.0
+Requires-Dist: evrex>=0.1.0
+Requires-Dist: PySide6>=6.5.0
+Requires-Dist: superqt>=0.6.0
+Requires-Dist: markdown>=3.4
+Requires-Dist: ptyprocess>=0.7.0; sys_platform != "win32"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Provides-Extra: viz
+Requires-Dist: matplotlib>=3.7.0; extra == "viz"
+Requires-Dist: plotly>=5.14.0; extra == "viz"
+Requires-Dist: kaleido>=0.2.1; extra == "viz"
+Provides-Extra: sensitivity
+Requires-Dist: SALib>=1.4.7; extra == "sensitivity"
+Requires-Dist: matplotlib>=3.7.0; extra == "sensitivity"
+Provides-Extra: benchmark
+Requires-Dist: pypsa>=0.28.0; extra == "benchmark"
+Requires-Dist: pandapower>=2.14.0; extra == "benchmark"
+Requires-Dist: pypower>=5.1.0; extra == "benchmark"
+Requires-Dist: matpower>=7.1.0; extra == "benchmark"
+Provides-Extra: workflows
+Requires-Dist: pvlib>=0.11.0; extra == "workflows"
+Requires-Dist: geopandas>=0.14.0; extra == "workflows"
+Requires-Dist: duckdb>=1.0.0; extra == "workflows"
+Requires-Dist: shapely>=2.0.0; extra == "workflows"
+Requires-Dist: requests>=2.28.0; extra == "workflows"
+Requires-Dist: overpy>=0.7; extra == "workflows"
+Requires-Dist: otex>=0.1.0; extra == "workflows"
+Requires-Dist: scikit-learn>=1.3.0; extra == "workflows"
+Requires-Dist: atlite>=0.2.11; extra == "workflows"
+Requires-Dist: rasterio>=1.3.0; extra == "workflows"
+Provides-Extra: ml
+Requires-Dist: xgboost>=2.0.0; extra == "ml"
+Provides-Extra: dl
+Requires-Dist: torch>=2.0.0; extra == "dl"
+Requires-Dist: pytorch-lightning>=2.0.0; extra == "dl"
+Requires-Dist: pytorch-forecasting>=1.0.0; extra == "dl"
+Dynamic: license-file
+
+<p align="center">
+  <img src="docs/assets/esfex.png" alt="ESFEX Logo" width="460"/>
+</p>
+
+<h1 align="center">ESFEX — Energy System Flexibility Studio</h1>
+
+<p align="center">
+  <strong>A framework for power system capacity expansion and operational dispatch under high renewable penetration</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/msotocalvo/ESFEX/actions/workflows/ci.yml">
+    <img src="https://github.com/msotocalvo/ESFEX/actions/workflows/ci.yml/badge.svg" alt="CI">
+  </a>
+  <a href="https://codecov.io/gh/msotocalvo/ESFEX">
+    <img src="https://codecov.io/gh/msotocalvo/ESFEX/branch/main/graph/badge.svg" alt="codecov">
+  </a>
+  <a href="https://esfex.readthedocs.io/">
+    <img src="https://readthedocs.org/projects/esfex/badge/?version=latest" alt="Documentation">
+  </a>
+  <a href="https://doi.org/10.5281/zenodo.20504838">
+    <img src="https://zenodo.org/badge/1256767759.svg" alt="DOI">
+  </a>
+  <a href="https://www.python.org/downloads/">
+    <img src="https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue.svg" alt="Python">
+  </a>
+  <a href="https://julialang.org/">
+    <img src="https://img.shields.io/badge/Julia-1.9%2B-9558B2.svg" alt="Julia">
+  </a>
+  <a href="https://jump.dev/">
+    <img src="https://img.shields.io/badge/optimization-JuMP-2C8C3C.svg" alt="JuMP">
+  </a>
+  <a href="LICENSE">
+    <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License">
+  </a>
+  <a href="https://api.reuse.software/info/github.com/msotocalvo/ESFEX">
+    <img src="https://api.reuse.software/badge/github.com/msotocalvo/ESFEX" alt="REUSE status">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+  <a href="https://pepy.tech/project/esfex">
+    <img src="https://static.pepy.tech/badge/esfex" alt="Downloads">
+  </a>
+  <img src="https://img.shields.io/badge/status-alpha-orange.svg" alt="Status">
+</p>
+
+<p align="center">
+  <a href="#overview">Overview</a> •
+  <a href="#key-features">Features</a> •
+  <a href="#installation">Installation</a> •
+  <a href="#quick-start">Quick Start</a> •
+  <a href="#the-studio">Studio</a> •
+  <a href="#documentation">Documentation</a> •
+  <a href="#citation">Citation</a>
+</p>
+
+---
+
+## 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](https://jump.dev/)) handles the mathematical optimization, leveraging its compiled performance for large-scale LP and MIP problems. The two communicate through [`juliacall`](https://github.com/JuliaPy/PythonCall.jl). 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.
+- **Two simulation modes** — `development` (LP, continuous commitment + investment), `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.
+- **Rooftop solar** — Stochastic adoption with behind-the-meter generation modeled as negative demand.
+- **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, wind, and OTEC 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 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 |
+
+<sub>*PyPSA performs an AC power flow via Newton-Raphson, not a full ACOPF. See [`docs/index.md`](docs/index.md) for the extended comparison and citations.</sub>
+
+---
+
+## 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.
+
+### From source (development mode)
+
+```bash
+git clone https://github.com/msotocalvo/ESFEX.git
+cd ESFEX
+pip install -e .
+```
+
+The GIS Studio (PySide6) is included in the core install — no extra is required.
+
+### Optional dependency groups
+
+```bash
+pip install -e ".[dev]"          # pytest, ruff, black, mypy
+pip install -e ".[viz]"          # matplotlib, plotly, kaleido
+pip install -e ".[sensitivity]"  # SALib (Sobol indices)
+pip install -e ".[workflows]"    # resource-assessment pipelines (pvlib, geopandas, atlite, rasterio, …)
+pip install -e ".[benchmark]"    # pypsa, pandapower, pypower (cross-model validation)
+pip install -e ".[ml]"           # xgboost (demand model)
+pip install -e ".[dl]"           # torch, pytorch-forecasting (TFT demand model)
+```
+
+### Julia backend
+
+The Julia optimization models live in [`src/esfex/julia/`](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:
+
+```bash
+esfex precompile
+```
+
+### Solvers
+
+ESFEX defaults to the open-source **HiGHS** solver. Gurobi, CPLEX, CBC, and GLPK are also supported and selectable per run (`--solver`) or in the config. Ipopt is used for the nonlinear ACOPF formulations.
+
+---
+
+## Quick Start
+
+```bash
+# 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
+
+```python
+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 ships with an interactive, map-based **Studio** for building and editing power-system configurations visually instead of hand-writing YAML.
+
+```bash
+esfex studio                     # start from a blank canvas
+esfex studio -c my_system.yaml   # open an existing configuration
+```
+
+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, wind, OTEC) 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](docs/reference/config-reference.md) and the [User Guide](docs/user-guide/configuration.md) 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/`](docs/).
+
+| Section | Description |
+|---------|-------------|
+| [Getting Started](docs/getting-started/installation.md) | Installation, quickstart, architecture, core concepts |
+| [Tutorials](docs/tutorials/single-system.md) | Single-system, multi-node, EV, stochastic, sensitivity |
+| [User Guide](docs/user-guide/cli.md) | CLI, configuration, master problem, data formats |
+| [GUI Editor](docs/gui/overview.md) | Interactive map-based grid editor (Studio) |
+| [Mathematical Formulation](docs/formulation/overview.md) | Master problem, dispatch, DC/AC flow, primary energy, electrolyzer |
+| [API Reference](docs/api/index.md) | Python and Julia public API |
+| [Reference](docs/reference/config-reference.md) | Config fields, HDF5 schema, constraint catalog, glossary |
+
+To serve the docs locally:
+
+```bash
+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
+
+---
+
+## Citation
+
+If you use ESFEX in academic work, please cite:
+
+```bibtex
+@software{esfex2026,
+  title   = {ESFEX: Energy System FlEXibility — Power System Optimization},
+  author  = {Soto Calvo, Manuel and Lee, Han Soo},
+  year    = {2026},
+  url     = {https://github.com/msotocalvo/ESFEX},
+  version = {0.1.0},
+  license = {Apache-2.0}
+}
+```
+
+---
+
+## Contributing
+
+Contributions are welcome. See [Development Setup](docs/contributing/development-setup.md) for the development environment and [Testing](docs/contributing/testing.md) 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](LICENSE) for the full text.