https://github.com/catalyst-cooperative/pudl-examples
Example Jupyter notebooks hosted on Kaggle that demonstrate how to work with US energy data from PUDL.
Science Score: 36.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
-
✓Committers with academic emails
1 of 9 committers (11.1%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.5%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Example Jupyter notebooks hosted on Kaggle that demonstrate how to work with US energy data from PUDL.
Basic Info
- Host: GitHub
- Owner: catalyst-cooperative
- License: mit
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://www.kaggle.com/datasets/catalystcooperative/pudl-project
- Size: 181 MB
Statistics
- Stars: 19
- Watchers: 8
- Forks: 5
- Open Issues: 3
- Releases: 0
Topics
Metadata Files
README.md
PUDL Example Notebooks
This repository contains a collection of Jupyter notebooks with examples of how to use the data and software distributed by Catalyst Cooperative's Public Utility Data Liberation (PUDL) project.
Run PUDL Notebooks on Kaggle
The easiest way to get up and running with these examples and a fresh copy of all the PUDL data is on Kaggle.
Kaggle offers substantial free computing resources and convenient data storage, so you can start playing with the PUDL data without needing to set up any software or download any data.
- PUDL Data on Kaggle
- 01 PUDL Data Access
- 02 State Hourly Electricity Demand
- 03 EIA-930 Sanity Checks
- 04 Renewable Generation Profiles
- 05 FERC-714 Electricity Demand Forecast Biases
You'll find the PUDL data dictionary helpful for interpreting the data.
Running Jupyter locally
If you're already familiar with git, Python environments, filesystem paths, and running Jupyter notebooks locally, you can also work with these notebooks and the PUDL data locally:
- Create a Python environment that includes common data science packages. We like to use the mamba package manager and the conda-forge channel.
- Clone this repository.
- Start your JupyterLab or Jupyter Notebook server and navigate to the notebooks in the cloned repo.
- If all the necessary packages are installed, you should be able to run the notebooks without worrying about where the data is, since it is read directly from our public AWS S3 bucket.
- If you would rather work with the data locally, you can Download the PUDL dataset from Kaggle (it's ~20GB!) and unzip it somewhere conveniently accessible from the notebooks in the cloned repo.
- In this case you'll need to adjust the file paths in the notebooks to point at the directory where you put the PUDL data.
Other Data Access Methods
See the PUDL documentation for other data access methods.
If you're familiar with cloud services, you can check out:
- PUDL in the AWS Open Data Registry: s3://pudl.catalyst.coop (free access)
- Google Cloud Storage: gs://pudl.catalyst.coop (requester pays)
Stalk us on the Internet
- https://catalyst.coop
- Email: pudl@catalyst.coop
- Mastodon: @CatalystCoop@mastodon.energy
- BlueSky: @catalyst.coop
- GitHub
- Kaggle
- HuggingFace
- YouTube
- Slack
- Twitter: @CatalystCoop
Supporting PUDL
These example notebooks are part of the Public Utility Data Liberation Project (PUDL), a project of Catalyst Cooperative. PUDL has been made possible by the generous support of our sustainers, grant funders, and volunteer open source contributors.
If you would like to support the ongoing development of PUDL, please consider becoming a sustainer.
Owner
- Name: Catalyst Cooperative
- Login: catalyst-cooperative
- Kind: organization
- Email: hello@catalyst.coop
- Location: United States of America
- Website: https://catalyst.coop
- Twitter: CatalystCoop
- Repositories: 82
- Profile: https://github.com/catalyst-cooperative
Catalyst is a small data engineering cooperative working on electricity regulation and climate change.
GitHub Events
Total
- Issues event: 1
- Watch event: 6
- Delete event: 2
- Member event: 1
- Issue comment event: 11
- Push event: 35
- Pull request event: 1
- Pull request review event: 1
- Create event: 2
Last Year
- Issues event: 1
- Watch event: 6
- Delete event: 2
- Member event: 1
- Issue comment event: 11
- Push event: 35
- Pull request event: 1
- Pull request review event: 1
- Create event: 2
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Zane Selvans | z****s@c****p | 100 |
| Austen Sharpe | a****e@c****p | 60 |
| Austen Sharpe | a****e@A****l | 50 |
| Christina Gosnell | c****l@c****p | 15 |
| PUDL Bot | 7****t | 10 |
| Austen Sharpe | a****e@A****1 | 1 |
| bendnorman | b****9@c****u | 1 |
| MichaelTiemann | 7****C | 1 |
| Yuvi Panda | y****a@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 4
- Total pull requests: 6
- Average time to close issues: 10 months
- Average time to close pull requests: 2 months
- Total issue authors: 3
- Total pull request authors: 4
- Average comments per issue: 2.25
- Average comments per pull request: 1.0
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 1
- Average time to close issues: about 23 hours
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 4.0
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- zaneselvans (2)
- mfripp (1)
- cisaacstern (1)
- eldobbins (1)
Pull Request Authors
- zaneselvans (3)
- MichaelTiemannOSC (1)
- Wheelspawn (1)
- yuvipanda (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- ridedott/merge-me-action v2 composite
- tibdex/github-app-token v1 composite
- actions/checkout main composite
- jupyterhub/repo2docker-action master composite
- catalystcoop/pudl-jupyter latest