View isodata on Snyk Open Source Advisor

Package Health Score

51 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Active

Explore Similar Packages

utc
39

Popularity

Limited

GitHub Stars: 282
Forks: 51
Contributors: 30

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package isodata, we found that it has been starred 282 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Oct 24, 2022
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

BSD-3-Clause

Security Policy

We found a way for you to contribute to the project! Looks like isodata is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 48
Open PR: 10
Last Release: 2 years ago
Last Commit: 22 days ago

Further analysis of the maintenance status of isodata based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for isodata is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the isodata repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like isodata is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: <4,>=3.7

Age: 2 years
Latest Release: 2 years ago
Dependencies: 5 Direct / 14 Total
Versions: 10
Maintainers: 1
Wheels: OS Independent

Readme

isodata logo

Install — Getting Started — Example Notebooks — Method Availability — LMP Data — Supported LMP Markets

isodata provides a uniform API to access energy data from the major Independent System Operators (ISOs) in the United States.

Currently supports fuel mix, load, supply, load forecast, and LMP pricing data for CAISO, SPP, ISONE, MISO, Ercot, NYISO, and PJM. See full availability below.

We'd love to answer any usage or data access questions! Please let us know by posting a GitHub issue.

Installation

isodata supports python 3.7+. Install with pip

python -m pip install isodata

Upgrade using the following command

python -m pip install --upgrade isodata

Check current version like this

&gt;&gt;&gt; import isodata
&gt;&gt;&gt; print(isodata.__version__)
0.6.0

Getting Started

First, we can see all of the ISOs that are supported

&gt;&gt;&gt; import isodata
&gt;&gt;&gt; isodata.list_isos()

                                    Name     Id
0                         California ISO  caiso
1  Electric Reliability Council of Texas  ercot
2                           New York ISO  nyiso
3                   Southwest Power Pool    spp
4                                    PJM    pjm
5                       Midcontinent ISO   miso
6                        ISO New England  isone

Next, we can select an ISO we want to use

&gt;&gt;&gt; iso = isodata.get_iso('caiso')
&gt;&gt;&gt; caiso = iso()

All ISOs have the same API. Here is how we can get the fuel mix

&gt;&gt;&gt; caiso.get_latest_fuel_mix()

ISO: California ISO
Total Production: 43104 MW
Time: 2022-08-03 18:25:00-07:00
+-------------+-------+-----------+
| Fuel        |    MW |   Percent |
|-------------+-------+-----------|
| Natural Gas | 19868 |      46.1 |
| Solar       |  5388 |      12.5 |
| Imports     |  4997 |      11.6 |
| Wind        |  3887 |       9   |
| Large Hydro |  3312 |       7.7 |
| Nuclear     |  2255 |       5.2 |
| Batteries   |  1709 |       4   |
| Geothermal  |   886 |       2.1 |
| Biomass     |   344 |       0.8 |
| Small hydro |   234 |       0.5 |
| Biogas      |   208 |       0.5 |
| Coal        |    16 |       0   |
| Other       |     0 |       0   |
+-------------+-------+-----------+

or the energy demand throughout the current day as a Pandas DataFrame

&gt;&gt;&gt; caiso.get_demand_today()

                         Time   Demand
0   2022-08-03 00:00:00-07:00  30076.0
1   2022-08-03 00:05:00-07:00  29966.0
2   2022-08-03 00:10:00-07:00  29893.0
3   2022-08-03 00:15:00-07:00  29730.0
4   2022-08-03 00:20:00-07:00  29600.0
..                        ...      ...
219 2022-08-03 18:15:00-07:00  41733.0
220 2022-08-03 18:20:00-07:00  41690.0
221 2022-08-03 18:25:00-07:00  41718.0
222 2022-08-03 18:30:00-07:00  41657.0
223 2022-08-03 18:35:00-07:00  41605.0

[224 rows x 2 columns]

we can get today's supply in the same way

&gt;&gt;&gt; caiso.get_supply_today()

                         Time  Supply
0   2022-08-03 00:00:00-07:00   31454
1   2022-08-03 00:05:00-07:00   31366
2   2022-08-03 00:10:00-07:00   30985
3   2022-08-03 00:15:00-07:00   30821
4   2022-08-03 00:20:00-07:00   30667
..                        ...     ...
220 2022-08-03 18:20:00-07:00   43096
221 2022-08-03 18:25:00-07:00   43104
222 2022-08-03 18:30:00-07:00   43013
223 2022-08-03 18:35:00-07:00   42885
224 2022-08-03 18:40:00-07:00   42875

[225 rows x 2 columns]

Another dataset we can query is the load forecast

&gt;&gt;&gt; nyiso = isodata.NYISO()
&gt;&gt;&gt; nyiso.get_forecast_today()

                Forecast Time                      Time  Load Forecast
0   2022-08-19 00:00:00-04:00 2022-08-19 00:00:00-04:00          17078
1   2022-08-19 00:00:00-04:00 2022-08-19 01:00:00-04:00          16260
2   2022-08-19 00:00:00-04:00 2022-08-19 02:00:00-04:00          15631
3   2022-08-19 00:00:00-04:00 2022-08-19 03:00:00-04:00          15252
4   2022-08-19 00:00:00-04:00 2022-08-19 04:00:00-04:00          15195
..                        ...                       ...            ...
139 2022-08-19 00:00:00-04:00 2022-08-24 19:00:00-04:00          24340
140 2022-08-19 00:00:00-04:00 2022-08-24 20:00:00-04:00          23624
141 2022-08-19 00:00:00-04:00 2022-08-24 21:00:00-04:00          22585
142 2022-08-19 00:00:00-04:00 2022-08-24 22:00:00-04:00          21137
143 2022-08-19 00:00:00-04:00 2022-08-24 23:00:00-04:00          19717

[144 rows x 3 columns]

When supported, you can use the historical method calls to get data for a specific day in the past. For example,

&gt;&gt;&gt; caiso.get_historical_demand("Jan 1, 2020")

                         Time  Demand
0   2020-01-01 00:00:00-08:00   21533
1   2020-01-01 00:05:00-08:00   21429
2   2020-01-01 00:10:00-08:00   21320
3   2020-01-01 00:15:00-08:00   21272
4   2020-01-01 00:20:00-08:00   21193
..                        ...     ...
284 2020-01-01 23:40:00-08:00   20383
285 2020-01-01 23:45:00-08:00   20297
286 2020-01-01 23:50:00-08:00   20242
287 2020-01-01 23:55:00-08:00   20128
288 2020-01-01 00:00:00-08:00   20025

[289 rows x 2 columns]

Frequently, we want to get data across multiple days. We can do that by providing a start and end parameter to any iso.get_historical_* method

&gt;&gt;&gt; caiso.get_historical_demand(start="Jan 1, 2020", end="Feb 1, 2020")

                          Time  Demand
0    2020-01-01 00:00:00-08:00   21533
1    2020-01-01 00:05:00-08:00   21429
2    2020-01-01 00:10:00-08:00   21320
3    2020-01-01 00:15:00-08:00   21272
4    2020-01-01 00:20:00-08:00   21193
...                        ...     ...
8923 2020-01-31 23:35:00-08:00   21905
8924 2020-01-31 23:40:00-08:00   21773
8925 2020-01-31 23:45:00-08:00   21674
8926 2020-01-31 23:50:00-08:00   21540
8927 2020-01-31 23:55:00-08:00   21425

[8928 rows x 2 columns]

The best part is these APIs work in the same way across all the supported ISOs!

Examples

Here is a list of our current example notebooks. If you have any requests, please post an issue and we'd be happy to publish more!

Method Availability

Here is the current status of availability of each method for each ISO

	New York ISO	California ISO	Electric Reliability Council of Texas	ISO New England	Midcontinent ISO	Southwest Power Pool	PJM
`get_latest_status`	✅	✅	✅	✅	❌	✅	❌
`get_latest_fuel_mix`	✅	✅	✅	✅	✅	✅	✅
`get_latest_demand`	✅	✅	✅	✅	✅	✅	✅
`get_latest_supply`	✅	✅	✅	✅	✅	✅	✅
`get_fuel_mix_today`	✅	✅	✅	✅	❌	❌	✅
`get_demand_today`	✅	✅	✅	✅	✅	✅	✅
`get_forecast_today`	✅	✅	✅	✅	✅	✅	✅
`get_supply_today`	✅	✅	✅	✅	❌	❌	✅
`get_storage_today`	❌	✅	❌	❌	❌	❌	❌
`get_historical_fuel_mix`	✅	✅	❌	✅	❌	❌	✅
`get_historical_demand`	✅	✅	❌	✅	❌	❌	✅
`get_historical_forecast`	✅	✅	❌	✅	❌	❌	❌
`get_historical_supply`	✅	✅	❌	✅	❌	❌	✅
`get_historical_storage`	❌	✅	❌	❌	❌	❌	❌

LMP Pricing Data

We are currently adding Locational Marginal Price (LMP). Even though each BA offers different markets, but you can query them with a standardized API

&gt;&gt;&gt; import isodata
&gt;&gt;&gt; nyiso = isodata.NYISO()
&gt;&gt;&gt; nyiso.get_lmp_today("REAL_TIME_5_MIN", locations="ALL")

                          Time           Market Location Location Type    LMP  Energy  Congestion  Loss
0    2022-08-16 00:05:00-04:00  REAL_TIME_5_MIN   CAPITL          Zone  70.88   66.65        1.10  5.33
1    2022-08-16 00:05:00-04:00  REAL_TIME_5_MIN   CENTRL          Zone  68.91   66.64        0.00  2.27
2    2022-08-16 00:05:00-04:00  REAL_TIME_5_MIN   DUNWOD          Zone  75.44   66.65       -1.26  7.53
3    2022-08-16 00:05:00-04:00  REAL_TIME_5_MIN   GENESE          Zone  68.64   66.64        0.00  2.00
4    2022-08-16 00:05:00-04:00  REAL_TIME_5_MIN      H Q          Zone  64.58   66.65        0.00 -2.07
...                        ...              ...      ...           ...    ...     ...         ...   ...
3370 2022-08-16 20:15:00-04:00  REAL_TIME_5_MIN    NORTH          Zone  85.57   87.85        0.00 -2.28
3371 2022-08-16 20:15:00-04:00  REAL_TIME_5_MIN      NPX          Zone  78.73   87.85       15.36  6.24
3372 2022-08-16 20:15:00-04:00  REAL_TIME_5_MIN      O H          Zone  85.48   87.85        0.00 -2.37
3373 2022-08-16 20:15:00-04:00  REAL_TIME_5_MIN      PJM          Zone  94.45   87.85       -1.86  4.74
3374 2022-08-16 20:15:00-04:00  REAL_TIME_5_MIN     WEST          Zone  87.85   87.85        0.00  0.00

[3375 rows x 8 columns]

And here is querying CAISO

&gt;&gt;&gt; import isodata
&gt;&gt;&gt; caiso = isodata.CAISO()
&gt;&gt;&gt; caiso.get_lmp_today('DAY_AHEAD_HOURLY', locations=["TH_NP15_GEN-APND", "TH_SP15_GEN-APND", "TH_ZP26_GEN-APND"])

LMP_TYPE                      Time            Market          Location Location Type        LMP     Energy  Congestion     Loss
0        2022-08-16 00:00:00-07:00  DAY_AHEAD_HOURLY  TH_NP15_GEN-APND          None   89.48766   95.51493     -0.1531 -5.87417
1        2022-08-16 00:00:00-07:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND          None   94.02489   95.51493      0.0000 -1.49003
2        2022-08-16 00:00:00-07:00  DAY_AHEAD_HOURLY  TH_ZP26_GEN-APND          None   90.57680   95.51493      0.0000 -4.93812
3        2022-08-16 01:00:00-07:00  DAY_AHEAD_HOURLY  TH_NP15_GEN-APND          None   86.38892   92.12283     -0.0223 -5.71162
4        2022-08-16 01:00:00-07:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND          None   90.94366   92.12283      0.0000 -1.17917
..                             ...               ...               ...           ...        ...        ...         ...      ...
67       2022-08-16 22:00:00-07:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND          None  131.45525  135.43710      0.0000 -3.98185
68       2022-08-16 22:00:00-07:00  DAY_AHEAD_HOURLY  TH_ZP26_GEN-APND          None  127.04000  135.43710      0.0000 -8.39710
69       2022-08-16 23:00:00-07:00  DAY_AHEAD_HOURLY  TH_NP15_GEN-APND          None  107.36120  113.91108      0.0000 -6.54989
70       2022-08-16 23:00:00-07:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND          None  111.22278  113.91108      0.0000 -2.68830
71       2022-08-16 23:00:00-07:00  DAY_AHEAD_HOURLY  TH_ZP26_GEN-APND          None  108.01049  113.91108      0.0000 -5.90059

[72 rows x 8 columns]

You can see what markets are available by accessing the markets property of an iso. For, example

&gt;&gt;&gt; caiso.markets

[, , ]

The possible lmp query methods are ISO.get_latest_lmp, ISO.get_lmp_today, and ISO.get_historical_lmp.

Supported LMP Markets

	Markets
Midcontinent ISO	`REAL_TIME_5_MIN`, `DAY_AHEAD_HOURLY`
California ISO	`REAL_TIME_15_MIN`, `REAL_TIME_HOURLY`, `DAY_AHEAD_HOURLY`
PJM	`REAL_TIME_5_MIN`, `REAL_TIME_HOURLY`, `DAY_AHEAD_HOURLY`
Electric Reliability Council of Texas
Southwest Power Pool
New York ISO	`REAL_TIME_5_MIN`, `DAY_AHEAD_5_MIN`
ISO New England	`REAL_TIME_5_MIN`, `REAL_TIME_HOURLY`, `DAY_AHEAD_HOURLY`

Related projects

pyiso

isodata dependencies

beautifulsoup4 pandas requests tabulate tqdm

FAQs

What is isodata?

API to access energy data. Visit Snyk Advisor to see a full health score report for isodata, including popularity, security, maintenance & community analysis.

Is isodata popular?

The python package isodata receives a total of 187 weekly downloads. As such, isodata popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is isodata well maintained?

We found indications that isodata is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is isodata safe to use?

While scanning the latest version of isodata, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 22 November-2024, at 22:37 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

isodata

API to access energy data For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Installation

Getting Started

Examples

Method Availability

LMP Pricing Data

Supported LMP Markets

Related projects

isodata dependencies

FAQs

What is isodata?

Is isodata popular?

Is isodata well maintained?

Is isodata safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Installation

Getting Started

Examples

Method Availability

LMP Pricing Data

Supported LMP Markets

Related projects

isodata dependencies

FAQs

What is isodata?

Is isodata popular?

Is isodata well maintained?

Is isodata safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues