gridpath
A versatile simulation and optimization platform for power-system planning and operations.
Science Score: 46.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 16 committers (6.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (19.2%) to scientific vocabulary
Keywords
Repository
A versatile simulation and optimization platform for power-system planning and operations.
Basic Info
- Host: GitHub
- Owner: blue-marble
- License: apache-2.0
- Language: Python
- Default Branch: develop
- Homepage: https://www.gridpath.io
- Size: 28.7 MB
Statistics
- Stars: 115
- Watchers: 11
- Forks: 60
- Open Issues: 86
- Releases: 33
Topics
Metadata Files
README.md
Welcome to GridPath
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.
Installation
Python
GridPath is tested on Python 3.9, 3.10, and 3.11. Get one of those Python versions here.
GridPath Python environment
You should create a Python environment for your GridPath installation, e.g. via
venv, a lightweight environment manager
that is part of the standard Python distribution. Make sure to create 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.
Solver
You will need a solver to use this platform. GridPath assumes you will be using Cbc (Coin-or branch and cut) by default, but you can specify a different solver.
Usage
The gridpathrun and gridpathrun_e2e commands
If you install GridPath via the setup script following the instructions above,
you can use the command gridpath_run to run a scenario from any directory
-- as long as your GridPath Python environment is enabled -- as follows:
bash
gridpath_run --scenario SCENARIO_NAME --scenario_location
/PATH/TO/SCENARIO
If you are using the database, you can use the command gridpath_run_e2e to
run GridPath end-to-end, i.e. get inputs for the scenario from the database,
solve the scenario problem, import the results into the database, and
process them. Refer to the documentation for how to build the database.
bash
gridpath_run_e2e --scenario SCENARIO_NAME --scenario_location
/PATH/TO/SCENARIO
To see usage and other optional arguments, e.g. how to specify a
solver, check the help menu, e.g.:
bash
gridpath_run --help
Owner
- Name: Blue Marble Analytics
- Login: blue-marble
- Kind: organization
- Email: info@bluemarble.run
- Location: San Francisco, CA
- Website: https://www.bluemarble.run
- Repositories: 2
- Profile: https://github.com/blue-marble
GitHub Events
Total
- Create event: 84
- Release event: 7
- Issues event: 6
- Watch event: 19
- Delete event: 14
- Issue comment event: 18
- Push event: 250
- Pull request review comment event: 3
- Pull request review event: 9
- Pull request event: 180
- Fork event: 20
Last Year
- Create event: 84
- Release event: 7
- Issues event: 6
- Watch event: 19
- Delete event: 14
- Issue comment event: 18
- Push event: 250
- Pull request review comment event: 3
- Pull request review event: 9
- Pull request event: 180
- Fork event: 20
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Ana Mileva | a****a@g****m | 644 |
| Ana Mileva | a****a@u****m | 590 |
| Gerrit | g****m@g****m | 240 |
| ranjitster | r****h@b****u | 35 |
| Janie115 | 4****5@u****m | 34 |
| Gerrit | g****9@g****m | 5 |
| alexrob18 | 1****8@u****m | 5 |
| sriharid | s****i@p****g | 3 |
| Jessica Van Os | 1****s@u****m | 2 |
| Milind R | m****h@g****m | 1 |
| Milind R | m****d@c****n | 1 |
| PascalLesage | p****e@g****m | 1 |
| elainekhart | 7****t@u****m | 1 |
| jaxstuhr | 3****r@u****m | 1 |
| nmgeek | g****e@g****m | 1 |
| souissim | 7****m@u****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 336
- Total pull requests: 1,077
- Average time to close issues: 3 months
- Average time to close pull requests: 8 days
- Total issue authors: 23
- Total pull request authors: 15
- Average comments per issue: 1.17
- Average comments per pull request: 0.46
- Merged pull requests: 858
- Bot issues: 2
- Bot pull requests: 163
Past Year
- Issues: 9
- Pull requests: 221
- Average time to close issues: 6 days
- Average time to close pull requests: 7 days
- Issue authors: 7
- Pull request authors: 6
- Average comments per issue: 0.56
- Average comments per pull request: 0.1
- Merged pull requests: 156
- Bot issues: 0
- Bot pull requests: 45
Top Authors
Issue Authors
- anamileva (153)
- gerritdm (105)
- sriharid (16)
- nmgeek (12)
- Janie115 (9)
- PascalLesage (9)
- milindsmart (7)
- ranjitster (6)
- MahavirSingh20 (2)
- dependabot[bot] (2)
- ghost (2)
- jhimelic (2)
- alamincse32 (1)
- asjaiswal (1)
- jacobophilip (1)
Pull Request Authors
- anamileva (559)
- gerritdm (271)
- dependabot[bot] (163)
- Janie115 (48)
- sriharid (10)
- alexrob18 (8)
- milindsmart (4)
- PascalLesage (3)
- jessvanos (3)
- elainekhart (2)
- nmgeek (2)
- ranjitster (1)
- jaxstuhr (1)
- souissim (1)
- misyntropy (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 197 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 13
- Total maintainers: 1
pypi.org: gridpath
A versatile simulation and optimization platform for power-system planning and operations.
- Homepage: https://www.gridpath.io
- Documentation: https://gridpath.readthedocs.io/en/latest/
- License: Apache v2
-
Latest release: 2025.6.1
published 8 months ago