Metadata-Version: 2.4
Name: GridPath
Version: 2026.2.0
Summary: A versatile simulation and optimization platform for power-system planning and operations.
Home-page: https://www.gridpath.io
Maintainer: Blue Marble Analytics LLC
Maintainer-email: info@gridpath.io
License: Apache v2
Project-URL: Discussions, https://github.com/blue-marble/gridpath/discussions
Project-URL: Documentation, https://gridpath.readthedocs.io/en/latest/
Project-URL: Issues, https://github.com/blue-marble/gridpath/issues
Project-URL: Source Code, https://github.com/blue-marble/gridpath
Keywords: energy,electricity,power,renewables,planning,operations
Platform: MacOS
Platform: Windows
Platform: Linux
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: Pyomo==6.9.4
Requires-Dist: pandas==2.3.2
Requires-Dist: bokeh==3.8.0
Requires-Dist: pscript==0.8.0
Requires-Dist: networkx==3.4.2; python_version < "3.11"
Requires-Dist: networkx==3.5.0; python_version >= "3.11"
Requires-Dist: PyUtilib==6.0.0
Requires-Dist: dill==0.3.8
Requires-Dist: duckdb==1.4.0
Requires-Dist: sphinx-rtd-theme
Provides-Extra: doc
Requires-Dist: Sphinx==7.2.6; extra == "doc"
Requires-Dist: sphinx-argparse==0.4.0; extra == "doc"
Requires-Dist: df2img; extra == "doc"
Provides-Extra: all
Requires-Dist: Sphinx==7.2.6; extra == "all"
Requires-Dist: sphinx-argparse==0.4.0; extra == "all"
Requires-Dist: df2img; extra == "all"
Requires-Dist: black; extra == "all"
Requires-Dist: coverage; extra == "all"
Requires-Dist: coveralls; extra == "all"
Requires-Dist: gurobipy; extra == "all"
Requires-Dist: highspy; extra == "all"
Provides-Extra: coverage
Requires-Dist: coverage; extra == "coverage"
Requires-Dist: coveralls; extra == "coverage"
Provides-Extra: gurobi
Requires-Dist: gurobipy; extra == "gurobi"
Provides-Extra: highs
Requires-Dist: highspy; extra == "highs"
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: platform
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

[![GridPath Test Suite Status](https://github.com/blue-marble/gridpath/actions/workflows/test_gridpath.yml/badge.svg?branch=main)](https://github.com/blue-marble/gridpath/actions/workflows/test_gridpath.yml)
[![Documentation Status](https://readthedocs.org/projects/gridpath/badge/?version=latest)](https://gridpath.readthedocs.io/en/latest/?badge=latest)
[![Coverage Status](https://coveralls.io/repos/github/blue-marble/gridpath/badge.svg?branch=main)](https://coveralls.io/github/blue-marble/gridpath?branch=main)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Lint Black](https://github.com/blue-marble/gridpath/actions/workflows/black.yml/badge.svg?branch=main)](https://github.com/blue-marble/gridpath/actions/workflows/black.yml)
[![DOI](https://zenodo.org/badge/65574330.svg)](https://zenodo.org/badge/latestdoi/65574330)

# Welcome to GridPath

<p align="center" width="100%">
    <img src="https://github.com/blue-marble/gridpath/blob/main/doc/graphics/gridpath_logo.png?raw=true" width="20%"/>
</p>

![Approaches](https://github.com/blue-marble/gridpath/blob/main/doc/graphics/approaches.png?raw=true)


GridPath is a versatile power-system planning platform capable of a range of
planning approaches including production-cost, capacity-expansion, 
asset-valuation, and reliability modeling.

# Documentation
GridPath's documentation is hosted on [Read the Docs](https://gridpath.readthedocs.io/en/latest/).

# Installation

## Python
GridPath is tested on Python 3.9, 3.10, and 3.11. Get one of those Python versions [here](https://www.python.org/downloads/ "Python download").

## GridPath Python environment
You should create a Python environment for your GridPath installation, e.g. via 
`venv`, [a lightweight environment manager](https://docs.python.org/3/library/venv.html "venv") 
that is part of the standard Python distribution. Make sure to [create](https://docs.python.org/3/library/venv.html#creating-virtual-environments "create") [activate](https://docs.python.org/3/library/venv.html#how-venvs-work "activate") the environment before installing GridPath.

## Install GridPath from PyPi

Once you have _created and activated_ the GridPath Python environment, you 
can install the latest version of GridPath from PyPi with:

```bash
pip install GridPath
```

## Install GridPath from source

You can alternatively download the GridPath source code and install from 
source.

```bash
pip install .[all]
```

**NOTE:** If you plan to edit the GridPath code, you should install with the `-e` flag.
