Skip to content

Commit

Permalink
Prepare for 0.28.0 Release (#447)
Browse files Browse the repository at this point in the history 
* Prepare for 0.28.0 Release

* Fix docs/update_docs.py

* Use URL for logo in README
  • Loading branch information
@WillKoehrsen
WillKoehrsen authored Oct 4, 2024
1 parent 090e3f6 commit 20c9b59
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 28 deletions.
16 changes: 8 additions & 8 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Changelog

## v0.29.0 - Upcoming
## v0.28.0 - October 3, 2024

### Breaking Changes

- PJM requires an `api_key` on initialization (can be set as `PJM_API_KEY` environment variable)

### Non-Breaking Changes

- Added more methods to the `ErcotAPI` class which uses the new [Ercot API](https://data.ercot.com/) for fetching data
- Eventually, the `ErcotAPI` will be the primary way to fetch data from ERCOT, but for now, we still need the `Ercot` class because the new API doesn't support all datasets.
- Add `pjm.get_gen_outages_by_type` to get generation outage data
- Flips the congestion sign on NYISO to be consistent with other ISOs. In the NYISO raw data, a negative congestion value means a higher LMP, which is the opposite of other ISOs. We flip the sign so that a negative congestion value means a lower LMP as it does in other ISOs.
- Adds ERCOT unplanned system outages (`ERCOT().get_unplanned_system_outages`)

## v0.28.0 - Mar 20, 2024

### Breaking Changes

* PJM requires an `api_key` on initialization (can be set as `PJM_API_KEY` environment variable)

## v0.27.0 - Mar 4, 2024

### Breaking Changes

* Dropped support for pandas < 2
- Dropped support for pandas < 2

## v0.26.0 - Feb 27, 2024

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img width=75% src="/gridstatus-header.png" alt="gridstatus logo" />
<img width=75% src="https://github.com/gridstatus/gridstatus/blob/main/gridstatus-header.png" alt="gridstatus logo" />
</p>

<p align="center">
Expand All @@ -8,7 +8,7 @@
<img src="https://github.com/kmax12/gridstatus/workflows/Tests/badge.svg?branch=main" alt="Tests" />
</a> -->
<a href="https://codecov.io/gh/kmax12/gridstatus" target="_blank">
<img src="https://codecov.io/gh/kmax12/gridstatus/branch/main/graph/badge.svg" alt="Code Coverage"//>
<img src="https://codecov.io/gh/kmax12/gridstatus/branch/main/graph/badge.svg" alt="Code Coverage"/>
</a>
<a href="https://badge.fury.io/py/gridstatus" target="_blank">
<img src="https://badge.fury.io/py/gridstatus.svg?maxAge=2592000" alt="PyPI version">
Expand Down
14 changes: 10 additions & 4 deletions docs/availability.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,13 @@ Here is the current status of availability of each method for each ISO
|:-----------|:-------------|:---------------|:-----------|:--------------------|:--------------|
| latest | &#x2705; | &#x2705; | &#x2705; | &#10060; | &#10060; |
| today | &#10060; | &#x2705; | &#x2705; | &#x2705; | &#10060; |
| historical | &#10060; | &#10060; | &#x2705; | &#10060; | &#10060; |
| historical | &#10060; | &#10060; | &#x2705; | &#x2705; | &#10060; |
## IESO
| | get_status | get_fuel_mix | get_load | get_load_forecast | get_storage |
|:-----------|:-------------|:---------------|:-----------|:--------------------|:--------------|
| latest | &#10060; | &#x2705; | &#x2705; | &#10060; | &#10060; |
| today | &#10060; | &#x2705; | &#x2705; | &#x2705; | &#10060; |
| historical | &#10060; | &#x2705; | &#x2705; | &#10060; | &#10060; |
## ISONE
| | get_status | get_fuel_mix | get_load | get_load_forecast | get_storage |
|:-----------|:-------------|:---------------|:-----------|:--------------------|:--------------|
Expand All @@ -26,7 +32,7 @@ Here is the current status of availability of each method for each ISO
|:-----------|:-------------|:---------------|:-----------|:--------------------|:--------------|
| latest | &#10060; | &#x2705; | &#x2705; | &#10060; | &#10060; |
| today | &#10060; | &#10060; | &#x2705; | &#x2705; | &#10060; |
| historical | &#10060; | &#10060; | &#10060; | &#10060; | &#10060; |
| historical | &#10060; | &#10060; | &#10060; | &#x2705; | &#10060; |
## NYISO
| | get_status | get_fuel_mix | get_load | get_load_forecast | get_storage |
|:-----------|:-------------|:---------------|:-----------|:--------------------|:--------------|
Expand All @@ -42,8 +48,8 @@ Here is the current status of availability of each method for each ISO
## SPP
| | get_status | get_fuel_mix | get_load | get_load_forecast | get_storage |
|:-----------|:-------------|:---------------|:-----------|:--------------------|:--------------|
| latest | &#x2705; | &#x2705; | &#x2705; | &#10060; | &#10060; |
| today | &#10060; | &#10060; | &#x2705; | &#x2705; | &#10060; |
| latest | &#10060; | &#x2705; | &#x2705; | &#10060; | &#10060; |
| today | &#10060; | &#x2705; | &#x2705; | &#x2705; | &#10060; |
| historical | &#10060; | &#10060; | &#10060; | &#x2705; | &#10060; |

<!-- METHOD AVAILABILITY TABLE END -->
19 changes: 10 additions & 9 deletions docs/lmp.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,16 @@ kernelspec:
Below are the currently supported LMP markets

<!-- LMP AVAILABILITY TABLE START -->
| | Method | REAL_TIME_5_MIN | DAY_AHEAD_HOURLY | REAL_TIME_15_MIN | REAL_TIME_HOURLY |
|:------|:----------|:--------------------------|:--------------------------|:--------------------------|:--------------------------|
| CAISO | `get_lmp` | latest, today, historical | latest, today, historical | latest, today, historical | - |
| Ercot | `get_spp` | - | latest, today, historical | latest, today, historical | - |
| ISONE | `get_lmp` | latest, today, historical | today, historical | - | latest, today, historical |
| MISO | `get_lmp` | latest | latest | - | - |
| NYISO | `get_lmp` | latest, today, historical | latest, today, historical | - | - |
| PJM | `get_lmp` | today, historical | latest, today, historical | - | today, historical |
| SPP | `get_lmp` | latest, today, historical | latest, today, historical | - | - |
| | Method | REAL_TIME_5_MIN | REAL_TIME_15_MIN | DAY_AHEAD_HOURLY | REAL_TIME_HOURLY | REAL_TIME_HOURLY_FINAL | REAL_TIME_HOURLY_PRELIM |
|:------|:----------|:--------------------------|:--------------------------|:--------------------------|:--------------------------|:-------------------------|:--------------------------|
| CAISO | `get_lmp` | latest, today, historical | latest, today, historical | latest, today, historical | - | - | - |
| Ercot | `get_lmp` | - | - | - | - | - | - |
| IESO | - | - | - | - | - | - | - |
| ISONE | `get_lmp` | latest, today, historical | - | today, historical | latest, today, historical | - | - |
| MISO | `get_lmp` | latest, today | - | today, historical | - | historical | historical |
| NYISO | `get_lmp` | latest, today, historical | latest, today | latest, today, historical | - | - | - |
| PJM | `get_lmp` | latest, today, historical | - | today, historical | today, historical | - | - |
| SPP | - | - | - | - | - | - | - |

<!-- LMP AVAILABILITY TABLE END -->

Expand Down
4 changes: 2 additions & 2 deletions docs/update_docs.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def insert_readme(files, start_str, end_str, to_insert):
f.truncate()


files = ["availability.md"]
files = ["./docs/availability.md"]
insert_readme(
files,
"<!-- METHOD AVAILABILITY TABLE START -->",
Expand All @@ -24,7 +24,7 @@ def insert_readme(files, start_str, end_str, to_insert):
)

insert_readme(
["lmp.md"],
["./docs/lmp.md"],
"<!-- LMP AVAILABILITY TABLE START -->",
"<!-- LMP AVAILABILITY TABLE END -->",
make_lmp_availability_table(),
Expand Down
2 changes: 1 addition & 1 deletion gridstatus/tests/test_version.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@


def test_version():
assert __version__ == "0.27.0"
assert __version__ == "0.28.0"
2 changes: 1 addition & 1 deletion gridstatus/version.py
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.27.0"
__version__ = "0.28.0"
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "gridstatus"
version = "0.27.0"
version = "0.28.0"
readme = "README.md"
description = "API to access energy data"
classifiers = [
Expand Down

0 comments on commit 20c9b59

Please sign in to comment.