Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gridstatus/gridstatus
Extract data from ISOs and other energy grid sources
https://github.com/gridstatus/gridstatus
co2-emissions decarbonization electrical-grid energy python
Last synced: about 1 month ago
JSON representation
Extract data from ISOs and other energy grid sources
- Host: GitHub
- URL: https://github.com/gridstatus/gridstatus
- Owner: gridstatus
- License: bsd-3-clause
- Created: 2022-07-28T19:24:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T17:14:31.000Z (about 2 months ago)
- Last Synced: 2024-10-30T01:38:29.588Z (about 2 months ago)
- Topics: co2-emissions, decarbonization, electrical-grid, energy, python
- Language: Python
- Homepage: https://docs.gridstatus.io
- Size: 11.1 MB
- Stars: 282
- Watchers: 10
- Forks: 49
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- open-sustainable-technology - gridstatus - Provides standardized API to access energy data from the major Independent System Operators in the United States. (Energy Systems / Energy Data Accessibility and Integration)
README
`gridstatus` is a Python library that provides a uniform API for accessing electricity supply, demand, and pricing data for the major Independent System Operators (ISOs) in the United States. It currently supports data from CAISO, SPP, ISONE, MISO, ERCOT, NYISO, PJM, IESO, and the EIA.
## GridStatus.io and Hosted API
To preview some of the data this library provides access to, visit [GridStatus.io](https://www.gridstatus.io/).
If you are trying to use our hosted API, you might want to check out the gridstatusio library [here](https://github.com/gridstatus/gridstatusio).
To learn more about our hosted API visit: https://www.gridstatus.io/api.
## Community
- Need Help? Post a [GitHub issue](https://github.com/kmax12/gridstatus/issues)
- Want to chat? Join our [Slack](https://join.slack.com/t/gridstatus/shared_invite/zt-1jk6vlzt2-Lzz4pdpjkJYVUJkynOiIvQ)
- Want to stay updated? Follow us on Twitter [@grid_status](https://twitter.com/grid_status)
- Want to contribute? Read our [Contributing Guide](CONTRIBUTING.md)
## Installation
`gridstatus` supports python 3.9+. Install with pip
```
python -m pip install gridstatus
```
Upgrade using the following command
```
python -m pip install --upgrade gridstatus
```
## Environment Variables
- Some parsers require the use of environment variables
- The `EIA` class
- The `ErcotAPI` class
- Environment variables can be set in the following ways
- In a `.env` file in the root of the project
- In the environment where the code is run
- See [.env.template](.env.template) for the required environment variables and how to register for them
## Documentation and Examples
To learn more, visit the [documentation](https://docs.gridstatus.io/) and view [example notebooks](https://docs.gridstatus.io/en/latest/Examples/caiso/index.html).
## Get Help
We'd love to answer any usage or data access questions! Please let us know by posting a GitHub issue.