Metadata-Version: 2.5
Name: microgridspy
Version: 0.4.0
Summary: Bottom-up, open-source optimization tool for planning mini-grids in remote areas.
Project-URL: Homepage, https://github.com/MicroGridsPy/MicroGridsPy
Project-URL: Source, https://github.com/MicroGridsPy/MicroGridsPy
Project-URL: Documentation, https://microgridspy-package-docs.readthedocs.io/
Project-URL: Issues, https://github.com/MicroGridsPy/MicroGridsPy/issues
Project-URL: Changelog, https://github.com/MicroGridsPy/MicroGridsPy/blob/master/CHANGELOG.md
Author: Alessandro Onori, MicroGridsPy contributors
License:                       EUROPEAN UNION PUBLIC LICENCE v. 1.2
                              EUPL © the European Union 2007, 2016
        
        This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
        below) which is provided under the terms of this Licence. Any use of the Work,
        other than as authorised under this Licence is prohibited (to the extent such
        use is covered by a right of the copyright holder of the Work).
        
        The Work is provided under the terms of this Licence when the Licensor (as
        defined below) has placed the following notice immediately following the
        copyright notice for the Work:
        
                Licensed under the EUPL
        
        or has expressed by any other means his willingness to license under the EUPL.
        
        1. Definitions
        
        In this Licence, the following terms have the following meaning:
        
        - ‘The Licence’: this Licence.
        
        - ‘The Original Work’: the work or software distributed or communicated by the
          Licensor under this Licence, available as Source Code and also as Executable
          Code as the case may be.
        
        - ‘Derivative Works’: the works or software that could be created by the
          Licensee, based upon the Original Work or modifications thereof. This Licence
          does not define the extent of modification or dependence on the Original Work
          required in order to classify a work as a Derivative Work; this extent is
          determined by copyright law applicable in the country mentioned in Article 15.
        
        - ‘The Work’: the Original Work or its Derivative Works.
        
        - ‘The Source Code’: the human-readable form of the Work which is the most
          convenient for people to study and modify.
        
        - ‘The Executable Code’: any code which has generally been compiled and which is
          meant to be interpreted by a computer as a program.
        
        - ‘The Licensor’: the natural or legal person that distributes or communicates
          the Work under the Licence.
        
        - ‘Contributor(s)’: any natural or legal person who modifies the Work under the
          Licence, or otherwise contributes to the creation of a Derivative Work.
        
        - ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
          the Work under the terms of the Licence.
        
        - ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
          renting, distributing, communicating, transmitting, or otherwise making
          available, online or offline, copies of the Work or providing access to its
          essential functionalities at the disposal of any other natural or legal
          person.
        
        2. Scope of the rights granted by the Licence
        
        The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
        sublicensable licence to do the following, for the duration of copyright vested
        in the Original Work:
        
        - use the Work in any circumstance and for all usage,
        - reproduce the Work,
        - modify the Work, and make Derivative Works based upon the Work,
        - communicate to the public, including the right to make available or display
          the Work or copies thereof to the public and perform publicly, as the case may
          be, the Work,
        - distribute the Work or copies thereof,
        - lend and rent the Work or copies thereof,
        - sublicense rights in the Work or copies thereof.
        
        Those rights can be exercised on any media, supports and formats, whether now
        known or later invented, as far as the applicable law permits so.
        
        In the countries where moral rights apply, the Licensor waives his right to
        exercise his moral right to the extent allowed by law in order to make effective
        the licence of the economic rights here above listed.
        
        The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
        any patents held by the Licensor, to the extent necessary to make use of the
        rights granted on the Work under this Licence.
        
        3. Communication of the Source Code
        
        The Licensor may provide the Work either in its Source Code form, or as
        Executable Code. If the Work is provided as Executable Code, the Licensor
        provides in addition a machine-readable copy of the Source Code of the Work
        along with each copy of the Work that the Licensor distributes or indicates, in
        a notice following the copyright notice attached to the Work, a repository where
        the Source Code is easily and freely accessible for as long as the Licensor
        continues to distribute or communicate the Work.
        
        4. Limitations on copyright
        
        Nothing in this Licence is intended to deprive the Licensee of the benefits from
        any exception or limitation to the exclusive rights of the rights owners in the
        Work, of the exhaustion of those rights or of other applicable limitations
        thereto.
        
        5. Obligations of the Licensee
        
        The grant of the rights mentioned above is subject to some restrictions and
        obligations imposed on the Licensee. Those obligations are the following:
        
        Attribution right: The Licensee shall keep intact all copyright, patent or
        trademarks notices and all notices that refer to the Licence and to the
        disclaimer of warranties. The Licensee must include a copy of such notices and a
        copy of the Licence with every copy of the Work he/she distributes or
        communicates. The Licensee must cause any Derivative Work to carry prominent
        notices stating that the Work has been modified and the date of modification.
        
        Copyleft clause: If the Licensee distributes or communicates copies of the
        Original Works or Derivative Works, this Distribution or Communication will be
        done under the terms of this Licence or of a later version of this Licence
        unless the Original Work is expressly distributed only under this version of the
        Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
        (becoming Licensor) cannot offer or impose any additional terms or conditions on
        the Work or Derivative Work that alter or restrict the terms of the Licence.
        
        Compatibility clause: If the Licensee Distributes or Communicates Derivative
        Works or copies thereof based upon both the Work and another work licensed under
        a Compatible Licence, this Distribution or Communication can be done under the
        terms of this Compatible Licence. For the sake of this clause, ‘Compatible
        Licence’ refers to the licences listed in the appendix attached to this Licence.
        Should the Licensee's obligations under the Compatible Licence conflict with
        his/her obligations under this Licence, the obligations of the Compatible
        Licence shall prevail.
        
        Provision of Source Code: When distributing or communicating copies of the Work,
        the Licensee will provide a machine-readable copy of the Source Code or indicate
        a repository where this Source will be easily and freely available for as long
        as the Licensee continues to distribute or communicate the Work.
        
        Legal Protection: This Licence does not grant permission to use the trade names,
        trademarks, service marks, or names of the Licensor, except as required for
        reasonable and customary use in describing the origin of the Work and
        reproducing the content of the copyright notice.
        
        6. Chain of Authorship
        
        The original Licensor warrants that the copyright in the Original Work granted
        hereunder is owned by him/her or licensed to him/her and that he/she has the
        power and authority to grant the Licence.
        
        Each Contributor warrants that the copyright in the modifications he/she brings
        to the Work are owned by him/her or licensed to him/her and that he/she has the
        power and authority to grant the Licence.
        
        Each time You accept the Licence, the original Licensor and subsequent
        Contributors grant You a licence to their contributions to the Work, under the
        terms of this Licence.
        
        7. Disclaimer of Warranty
        
        The Work is a work in progress, which is continuously improved by numerous
        Contributors. It is not a finished work and may therefore contain defects or
        ‘bugs’ inherent to this type of development.
        
        For the above reason, the Work is provided under the Licence on an ‘as is’ basis
        and without warranties of any kind concerning the Work, including without
        limitation merchantability, fitness for a particular purpose, absence of defects
        or errors, accuracy, non-infringement of intellectual property rights other than
        copyright as stated in Article 6 of this Licence.
        
        This disclaimer of warranty is an essential part of the Licence and a condition
        for the grant of any rights to the Work.
        
        8. Disclaimer of Liability
        
        Except in the cases of wilful misconduct or damages directly caused to natural
        persons, the Licensor will in no event be liable for any direct or indirect,
        material or moral, damages of any kind, arising out of the Licence or of the use
        of the Work, including without limitation, damages for loss of goodwill, work
        stoppage, computer failure or malfunction, loss of data or any commercial
        damage, even if the Licensor has been advised of the possibility of such damage.
        However, the Licensor will be liable under statutory product liability laws as
        far such laws apply to the Work.
        
        9. Additional agreements
        
        While distributing the Work, You may choose to conclude an additional agreement,
        defining obligations or services consistent with this Licence. However, if
        accepting obligations, You may act only on your own behalf and on your sole
        responsibility, not on behalf of the original Licensor or 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
        the fact You have accepted any warranty or additional liability.
        
        10. Acceptance of the Licence
        
        The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
        placed under the bottom of a window displaying the text of this Licence or by
        affirming consent in any other similar way, in accordance with the rules of
        applicable law. Clicking on that icon indicates your clear and irrevocable
        acceptance of this Licence and all of its terms and conditions.
        
        Similarly, you irrevocably accept this Licence and all of its terms and
        conditions by exercising any rights granted to You by Article 2 of this Licence,
        such as the use of the Work, the creation by You of a Derivative Work or the
        Distribution or Communication by You of the Work or copies thereof.
        
        11. Information to the public
        
        In case of any Distribution or Communication of the Work by means of electronic
        communication by You (for example, by offering to download the Work from a
        remote location) the distribution channel or media (for example, a website) must
        at least provide to the public the information requested by the applicable law
        regarding the Licensor, the Licence and the way it may be accessible, concluded,
        stored and reproduced by the Licensee.
        
        12. Termination of the Licence
        
        The Licence and the rights granted hereunder will terminate automatically upon
        any breach by the Licensee of the terms of the Licence.
        
        Such a termination will not terminate the licences of any person who has
        received the Work from the Licensee under the Licence, provided such persons
        remain in full compliance with the Licence.
        
        13. Miscellaneous
        
        Without prejudice of Article 9 above, the Licence represents the complete
        agreement between the Parties as to the Work.
        
        If any provision of the Licence is invalid or unenforceable under applicable
        law, this will not affect the validity or enforceability of the Licence as a
        whole. Such provision will be construed or reformed so as necessary to make it
        valid and enforceable.
        
        The European Commission may publish other linguistic versions or new versions of
        this Licence or updated versions of the Appendix, so far this is required and
        reasonable, without reducing the scope of the rights granted by the Licence. New
        versions of the Licence will be published with a unique version number.
        
        All linguistic versions of this Licence, approved by the European Commission,
        have identical value. Parties can take advantage of the linguistic version of
        their choice.
        
        14. Jurisdiction
        
        Without prejudice to specific agreement between parties,
        
        - any litigation resulting from the interpretation of this License, arising
          between the European Union institutions, bodies, offices or agencies, as a
          Licensor, and any Licensee, will be subject to the jurisdiction of the Court
          of Justice of the European Union, as laid down in article 272 of the Treaty on
          the Functioning of the European Union,
        
        - any litigation arising between other parties and resulting from the
          interpretation of this License, will be subject to the exclusive jurisdiction
          of the competent court where the Licensor resides or conducts its primary
          business.
        
        15. Applicable Law
        
        Without prejudice to specific agreement between parties,
        
        - this Licence shall be governed by the law of the European Union Member State
          where the Licensor has his seat, resides or has his registered office,
        
        - this licence shall be governed by Belgian law if the Licensor has no seat,
          residence or registered office inside a European Union Member State.
        
        Appendix
        
        ‘Compatible Licences’ according to Article 5 EUPL are:
        
        - GNU General Public License (GPL) v. 2, v. 3
        - GNU Affero General Public License (AGPL) v. 3
        - Open Software License (OSL) v. 2.1, v. 3.0
        - Eclipse Public License (EPL) v. 1.0
        - CeCILL v. 2.0, v. 2.1
        - Mozilla Public Licence (MPL) v. 2
        - GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
        - Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
          works other than software
        - European Union Public Licence (EUPL) v. 1.1, v. 1.2
        - Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
          Reciprocity (LiLiQ-R+).
        
        The European Commission may update this Appendix to later versions of the above
        licences without producing a new version of the EUPL, as long as they provide
        the rights granted in Article 2 of this Licence and protect the covered Source
        Code from exclusive appropriation.
        
        All other changes or additions to this Appendix require the production of a new
        EUPL version.
License-File: AUTHORS
License-File: LICENSE
Keywords: energy,linopy,mini-grid,optimization,rural electrification
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
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
Requires-Dist: linopy>=0.3
Requires-Dist: matplotlib>=3.7
Requires-Dist: numpy>=1.24
Requires-Dist: openpyxl>=3.1
Requires-Dist: pandas>=2.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: xarray>=2024.1
Provides-Extra: all
Requires-Dist: build; extra == 'all'
Requires-Dist: coverage[toml]; extra == 'all'
Requires-Dist: highspy>=1.7; extra == 'all'
Requires-Dist: mkdocstrings-python; extra == 'all'
Requires-Dist: pytest>=8; extra == 'all'
Requires-Dist: ruff==0.16.7; extra == 'all'
Requires-Dist: streamlit>=1.36; extra == 'all'
Requires-Dist: zensical; extra == 'all'
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: coverage[toml]; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: ruff==0.16.7; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocstrings-python; extra == 'docs'
Requires-Dist: zensical; extra == 'docs'
Provides-Extra: gui
Requires-Dist: streamlit>=1.36; extra == 'gui'
Provides-Extra: gurobi
Requires-Dist: gurobipy>=11; extra == 'gurobi'
Provides-Extra: highs
Requires-Dist: highspy>=1.7; extra == 'highs'
Description-Content-Type: text/markdown

# MicroGridsPy - Mini-Grid Planning Optimization

MicroGridsPy is an open-source Python package for the techno-economic planning of mini-grid energy systems in remote and underserved areas. It is built on Linopy for mathematical optimization and ships with an optional Streamlit graphical interface.

You can use it two ways:
- **As a Python library** — call the optimization from your own scripts and notebooks (`import microgridspy`).
- **As a guided app** — define a project, generate input templates, audit data, solve, and explore results in a Streamlit workspace (`microgridspy-gui`).

The reference energy system can include:
- Renewable generation
- Battery storage
- Backup generators
- Optional grid connection
- Optional grid export

The app supports both simple and advanced studies, including:
- Typical-year and multi-year formulations
- Single-scenario and multi-scenario analyses
- Continuous and discrete sizing
- Optional carbon-cost internalization
- Renewable land constraints
- Capacity expansion over time

Each project is stored in its own folder with CSV, YAML, and JSON files, so studies remain reproducible, inspectable, and easy to revisit.

![MicroGridsPy Planning interface](src/microgridspy/app/assets/intro_interface.png)

---

## Installation

MicroGridsPy targets **Python 3.10+**. Install it with `pip`, adding the optional Streamlit
GUI and the open-source HiGHS solver:

```bash
pip install "microgridspy[gui,highs]"
```

To work on the code, or before the package is available on PyPI, install from a clone instead:

```bash
git clone https://github.com/MicroGridsPy/MicroGridsPy.git
cd MicroGridsPy
pip install -e ".[gui,highs]"
```

Extras let you install only what you need:

| Extra | Adds | Use it for |
| --- | --- | --- |
| _(none)_ | the core library | scripting / notebooks, no GUI |
| `gui` | Streamlit interface | the `microgridspy-gui` app |
| `highs` | HiGHS solver | open-source solving |
| `gurobi` | `gurobipy` | commercial solver (license required) |

For example, `pip install microgridspy` gives a lean library with no GUI, while `pip install "microgridspy[gui,highs]"` installs everything needed to run the app with the open-source solver.

### Launch the app

```bash
microgridspy-gui
```

The app looks for a `projects/` folder in the current directory (or in the folder set by the `MICROGRIDSPY_WORKSPACE` environment variable).

---

## Using MicroGridsPy as a Python library

The package exposes a small, stable API:

```python
import microgridspy as mgp

# create a new project and scaffold its input templates
mgp.create_project("my_site", formulation="typical_year", resources=["solar", "wind"])
# ...fill in projects/my_site/inputs (load demand, resource availability, *.yaml)...

mgp.validate_project("my_site")  # pre-flight input check
model = mgp.solve("my_site", solver="highs")  # build + solve
results = model.results()  # analysis-ready pandas tables
print(results.kpis)
mgp.export_results(results)  # write CSV/Excel to the project folder
```

Key entry points: `solve`, `create_project`, `validate_project`, `load_results`, `export_results`, `list_projects`, `set_workspace`, and the model classes `TypicalYearModel` / `MultiYearModel`. For runnable end-to-end scripts see [`examples/run_demo_typical_year.py`](examples/run_demo_typical_year.py) (seconds to solve) and [`examples/run_demo_multi_year.py`](examples/run_demo_multi_year.py) (an explicit 10-year horizon; expect ~20 minutes).

---

## What The App Does

MicroGridsPy Planning combines project setup, input-template generation, data audit, optimization, and result interpretation in a single interface.

It is intended to support a complete workflow:
1. Define the structure of the planning problem.
2. Generate the input templates required by that problem.
3. Fill and validate the CSV and YAML inputs.
4. Solve the optimization model.
5. Inspect design, dispatch, cost, and reliability results.

This makes the tool useful both for early-stage feasibility studies and for more detailed long-term planning exercises.

---

## Intended Workflow And User Experience

The application is organized as a sequence of Streamlit pages that progressively define, validate, solve, and interpret a planning problem.

### 1. Project Setup

The first page defines the global structure of the study:
- Off-grid or on-grid configuration
- Technologies included in the system
- Typical-year or multi-year formulation
- Deterministic or multi-scenario setup
- Economic and policy settings
- Optional modelling features such as carbon cost or discrete sizing

These choices determine the shape of the optimization problem and the set of input templates generated for the user.

### 2. Input Template Generation

Based on the selected configuration, the application creates structured templates tailored to the project:
- CSV files for time series
- YAML files for techno-economic parameters
- JSON settings for workflow and formulation choices

This helps keep user inputs consistent with the actual model dimensions and enabled technologies.

### 3. Data Audit And Visualization

Before optimization, the user can inspect and validate the generated inputs through:
- Dataset structure summaries
- Parameter overviews
- Optimization-constraint summaries
- Time-series visualizations
- Grid availability checks for on-grid systems

This step is useful for detecting mistakes before solving.

### 4. Optimization

The optimization page builds and solves the mathematical model using:
- HiGHS
- Gurobi

The model computes the least-cost system design and dispatch subject to the selected technical, economic, and policy constraints.

### 5. Results

The results page provides access to:
- Optimal capacities
- Dispatch plots
- Energy-balance views
- Cost breakdowns
- Emissions indicators
- Reliability metrics
- Scenario-dependent outputs

For multi-year studies, the app also supports year-by-year and investment-step interpretation.

---

## Planning Modes

MicroGridsPy Planning supports two complementary formulations.

### Typical-Year Planning

The typical-year formulation represents the system with a single representative year.

It is most appropriate when:
- Demand and resource conditions are assumed to be stationary
- Capacity expansion is not required
- A compact, computationally efficient model is preferred

The objective is based on expected equivalent annual cost, combining annualized investment costs and expected operating costs.

### Multi-Year Planning

The multi-year formulation represents the system over an explicit planning horizon.

It is most appropriate when:
- Demand evolves over time
- Capacity expansion is relevant
- Degradation, replacement, and investment timing matter
- Long-term trade-offs need to be assessed explicitly

The objective is based on expected net present cost and includes the time value of money, operating costs, and remaining asset value where applicable.

---

## Planning Modes Comparison

The two planning modes serve different purposes. The table below summarizes their main strengths and limitations.

| Aspect | Typical-Year Planning | Multi-Year Planning |
| --- | --- | --- |
| Visual cue | 🟢 Compact and fast | 🔵 Richer and more realistic |
| Main purpose | Representative-year planning and rapid screening | Long-term planning across an explicit horizon |
| Time structure | One recurring representative year | Multiple consecutive years |
| Investment logic | Single design decision with annualized costs | Time-dependent investments with discounted cash flows |
| Capacity expansion | Not represented explicitly | Supported when enabled |
| Degradation and replacement | Not modeled explicitly in time | Can be represented across the planning horizon |
| Computational effort | Lower | Higher |
| Input complexity | Lower | Higher |
| Best suited for | Early feasibility, technology comparison, sensitivity screening | Expansion planning, staged investment analysis, long-term policy studies |
| Main advantages | Simple setup, fast solve times, easier scenario exploration | More realistic timing of investments and operations, better long-term interpretation |
| Main limitations | Cannot capture timing of expansion, aging, or horizon effects | More data-intensive, heavier computationally, more complex to interpret |

### Quick Guidance

- Choose `Typical-Year` when you need a simpler and faster model for screening alternatives or understanding the basic least-cost structure of the system.
- Choose `Multi-Year` when investment timing, degradation, grid arrival, evolving demand, or staged expansion materially affect the planning outcome.

---

## Main Modeling Features

Depending on project setup, the application can represent:
- Off-grid and on-grid systems
- Optional grid export
- Renewable, battery, and generator investment
- Generator partial-load efficiency curves
- Scenario-weighted uncertainty
- Land-use limits for renewables
- Lost-load constraints and penalties
- Minimum renewable penetration targets
- Carbon-cost inclusion in the objective
- Continuous sizing or discrete unit-based sizing
- Capacity expansion over multiple investment stages

---

## Input Structure

Each project is stored under its own folder and typically contains:

### Core configuration
- `formulation.json`

### Time-series inputs
- `load_demand.csv`
- `resource_availability.csv`
- `grid_import_price.csv`
- `grid_export_price.csv`
- `grid_availability.csv`

### Technology inputs
- `renewables.yaml`
- `battery.yaml`
- `generator.yaml`
- `generator_efficiency_curve.csv`
- `grid.yaml`

The exact set of files depends on whether the project is typical-year or multi-year, off-grid or on-grid, and whether optional features such as export or partial-load modeling are enabled.

---

## Solvers

Supported optimization solvers:
- `HiGHS`: open-source and recommended as the default option
- `Gurobi`: commercial solver, useful for harder MILP cases or larger studies

If you select HiGHS in the app, make sure the `highspy` package is installed (`pip install "microgridspy[highs]"`).

---

## Contacts

For questions, feedback, or collaboration:

- Alessandro Onori - `alessandro.onori@polimi.it`
