Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/catalyst-cooperative/pudl

The Public Utility Data Liberation Project provides analysis-ready energy system data to climate advocates, researchers, policymakers, and journalists.
https://github.com/catalyst-cooperative/pudl

cems climate coal ddj eia eia860 eia923 electricity emissions energy epa etl ferc ghg natural-gas open-data pudl python sqlite utility

Last synced: 6 days ago
JSON representation

The Public Utility Data Liberation Project provides analysis-ready energy system data to climate advocates, researchers, policymakers, and journalists.

Awesome Lists containing this project

README 

        
===============================================================================

The Public Utility Data Liberation Project (PUDL)

===============================================================================



.. readme-intro



.. |repo-status| image:: https://www.repostatus.org/badges/latest/active.svg

   :target: https://www.repostatus.org/#active

   :alt: Project Status: Active

.. |pytest| image:: https://github.com/catalyst-cooperative/pudl/workflows/pytest/badge.svg

   :target: https://github.com/catalyst-cooperative/pudl/actions?query=workflow%3Apytest

   :alt: PyTest Status

.. |codecov| image:: https://img.shields.io/codecov/c/github/catalyst-cooperative/pudl?style=flat&logo=codecov

   :target: https://codecov.io/gh/catalyst-cooperative/pudl

   :alt: Codecov Test Coverage

.. |rtd| image:: https://img.shields.io/readthedocs/catalystcoop-pudl?style=flat&logo=readthedocs

   :target: https://catalystcoop-pudl.readthedocs.io/en/nightly/

   :alt: Read the Docs Build Status

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json

   :target: https://github.com/astral-sh/ruff

.. |pre-commit-ci| image:: https://results.pre-commit.ci/badge/github/catalyst-cooperative/pudl/main.svg

   :target: https://results.pre-commit.ci/latest/github/catalyst-cooperative/pudl/main

   :alt: pre-commit CI

.. |zenodo-doi| image:: https://zenodo.org/badge/80646423.svg

   :target: https://zenodo.org/badge/latestdoi/80646423

   :alt: Zenodo DOI

.. |office-hours| image:: https://img.shields.io/badge/calend.ly-officehours-darkgreen

   :target: https://calend.ly/catalyst-cooperative/pudl-office-hours

   :alt: Schedule a 1-on-1 chat with us about PUDL.

.. |mastodon| image:: https://img.shields.io/mastodon/follow/110855618428885893?domain=https%3A%2F%2Fmastodon.energy&style=social&color=%23000000&link=https%3A%2F%2Fmastodon.energy%2F%40catalystcoop

   :target: https://mastodon.energy/@catalystcoop

   :alt: Follow Catalyst Cooperative on Mastodon

.. |linkedin| image:: https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white

   :target: https://linkedin.com/company/catalyst-cooperative/

   :alt: Follow Catalyst Cooperative on LinkedIn

.. |bluesky| image:: https://img.shields.io/badge/Bluesky-0285FF?logo=bluesky&logoColor=fff&style=flat

   :target: https://bsky.app/profile/catalyst.coop

   :alt: Follow @catalyst.coop on BlueSky

.. |kaggle| image:: https://img.shields.io/badge/Kaggle-20BEFF?style=flat&logo=Kaggle&logoColor=white

   :target: https://www.kaggle.com/datasets/catalystcooperative/pudl-project

   :alt: The PUDL Dataset on Kaggle

.. |aws| image:: https://img.shields.io/badge/Amazon_AWS-FF9900?style=flat&logo=amazonaws&logoColor=white

   :target: https://registry.opendata.aws/catalyst-cooperative-pudl/

   :alt: PUDL in the AWS Open Data Registry



|repo-status| |pytest| |codecov| |rtd| |ruff| |pre-commit-ci| |zenodo-doi|

|office-hours| |mastodon| |linkedin| |bluesky| |kaggle| |aws|



What is PUDL?

-------------



The `PUDL `__ Project (pronounced puddle) is an open source

data processing pipeline that makes US energy data easier to access and use

programmatically.



Hundreds of gigabytes of valuable data are published by US government agencies, but it's

often difficult to work with. PUDL takes the original spreadsheets, CSV files, and

databases and turns them into a unified resource. This allows users to spend more time

on novel analysis and less time on data preparation.



The project is focused on serving researchers, activists, journalists, policy makers,

and small businesses that might not otherwise be able to afford access to this data from

commercial sources and who may not have the time or expertise to do all the data

processing themselves from scratch.



We want to make this data accessible and easy to work with for as wide an audience as

possible: anyone from a grassroots youth climate organizers working with Google sheets

to university researchers with access to scalable cloud computing resources and everyone

in between!



PUDL is comprised of three core components:



Raw Data Archives

^^^^^^^^^^^^^^^^^

PUDL `archives `__ all our raw

inputs on `Zenodo

`__ to ensure

permanent, versioned access to the data. In the event that an agency changes how it

publishes data or deletes old files, the data processing pipeline will still have access

to the original inputs. Each of the data inputs may have several different versions

archived, and all are assigned a unique DOI (digital object identifier) and made

available through Zenodo's REST API.  You can read more about the Raw Data Archives in

the `docs `__.



Data Pipeline

^^^^^^^^^^^^^

The data pipeline (this repo) ingests raw data from the archives, cleans and integrates

it, and writes the resulting tables to `SQLite `__ and `Apache

Parquet `__ files, with some accompanying metadata stored as

JSON.  Each release of the PUDL software contains a set of DOIs indicating which

versions of the raw inputs it processes. This helps ensure that the outputs are

replicable. You can read more about our ETL (extract, transform, load) process in the

`PUDL documentation `__.



Data Warehouse

^^^^^^^^^^^^^^

The SQLite, Parquet, and JSON outputs from the data pipeline, sometimes called "PUDL

outputs", are updated each night by an automated build process, and periodically

archived so that users can access the data without having to install and run our data

processing system. These outputs contain hundreds of tables and comprise a small

file-based data warehouse that can be used for a variety of energy system analyses.

Learn more about `how to access the PUDL data

`__.



What data is available?

-----------------------



PUDL currently integrates data from:



* **EIA Form 860**:

  - `Source Docs `__

  - `PUDL Docs `__

* **EIA Form 860m**:

  - `Source Docs `__

* **EIA Form 861**:

  - `Source Docs `__

  - `PUDL Docs `__

* **EIA Form 923**:

  - `Source Docs `__

  - `PUDL Docs `__

* **EIA Form 930**:

  - `Source Docs `__

  - `PUDL Docs `__

* **EIA Annual Energy Outlook (AEO)** (a few tables):

  - `Source Docs `__

* **EPA Continuous Emissions Monitoring System (CEMS)**:

  - `Source Docs `__

  - `PUDL Docs `__

* **FERC Form 1** (dozens of fully processed tables, plus raw data converted to SQLite):

  - `Source Docs `__

  - `PUDL Docs `__

* **FERC Form 714** (a few fully processed tables):

  - `Source Docs `__

  - `PUDL Docs `__

* **FERC Form 2** (raw data converted to SQLite):

  - `Source Docs `__

* **FERC Form 6** (raw data converted to SQLite):

  - `Source Docs `__

* **FERC Form 60** (raw data converted to SQLite):

  - `Source Docs `__

* **NREL Annual Technology Baseline (ATB) for Electricity**:

  - `Source Docs `__

* **GridPath Resource Adequacy Toolkit** (partial):

  - `Source Docs `__

  - `PUDL Docs `__

* **US Census Demographic Profile 1 Geodatabase**:

  - `Source Docs `__



High Priority Target Datasets

-----------------------------



If you're interested in any of these datasets, we'd love to integrate them into PUDL.

Get in touch!



* Additional fully processed FERC Form 1 tables, e.g. Transmission & Distribution assets

* Additional high value EIA AEO tables

* `PHMSA Natural Gas Annual Report `__

* `EIA Form 176 `__

  (The Annual Report of Natural Gas Supply and Disposition)

* `FERC Electric Quarterly Reports (EQR) `__

* `EIA Thermoelectric Water Usage `__

* `FERC Form 2 `__

  (Annual Report of Major Natural Gas Companies)

* `MHSA Mines `__



How do I access the data?

-------------------------



For details on how to access PUDL data, see the `data access documentation

`__. A quick

summary:



* `Datasette `__

  provides browsable and queryable data from our nightly builds on the web:

  https://data.catalyst.coop

* `Kaggle `__

  provides easy Jupyter notebook access to the PUDL data, updated weekly:

  https://www.kaggle.com/datasets/catalystcooperative/pudl-project

* `Zenodo `__

  provides stable long-term access to our versioned data releases with a citeable DOI:

  https://doi.org/10.5281/zenodo.3653158

* `Nightly Data Builds `__

  push their outputs to the AWS Open Data Registry:

  https://registry.opendata.aws/catalyst-cooperative-pudl/

  See `the nightly build docs `__

  for direct download links.

* `The PUDL Development Environment `__

  lets you run the PUDL data processing pipeline locally.



Organizations using PUDL

------------------------



.. _pudl_orgs_start:



This is a partial list of organizations that have used PUDL in their work.

If your organization uses PUDL we'd love to list you here! Please open a

pull request or email us at `[email protected] `__!



* `RMI `__ via both their `Utility Transition Hub `__ and `Optimus financial modeling tool `__

* The `PowerGenome Project `__ out of `Jesse Jenkins' `__ ZERO Lab at Princeton University

* `Energy Innovation `__

* `Singularity Energy `__ via the `Open Grid Emissions Initiative `__

* The open source `PyPSA-USA `__ capacity expansion model.

* `Win Climate `__

* `The Deployment Gap Model Education Fund `__



.. _pudl_orgs_end:



Contributing to PUDL

--------------------



Find PUDL useful? Want to help make it better? There are lots of ways to help!



* Check out our `contribution guide `__

  including our `Code of Conduct `__.

* You can file a bug report, make a feature request, or ask questions in the

  `Github issue tracker `__.

* Feel free to fork the project and make a pull request with new code, better

  documentation, or example notebooks.

* `Make a recurring financial contribution `__

  to support our work liberating public energy data.

* `Hire us to do some custom analysis `__ and

  allow us to integrate the resulting code into PUDL.



Licensing

---------



In general, our code, data, and other work are permissively licensed for use by anybody,

for any purpose, so long as you give us credit for the work we've done.



* The PUDL software is released under

  `the MIT License `__.

* The PUDL data and documentation are published under the

  `Creative Commons Attribution License v4.0 `__

  (CC-BY-4.0).



Contact Us

----------



* For bug reports, feature requests, and other software or data issues please make a

  `GitHub Issue `__.

* For more general support, questions, or other conversations around the project

  that might be of interest to others, check out the

  `GitHub Discussions `__

* If you'd like to get occasional updates about the project

  `sign up for our email list `__.

* Want to schedule a time to chat with us one-on-one about your PUDL use case, ideas

  for improvement, or get some personalized support? Join us for

  `Office Hours `__

* `Follow us here on GitHub `__

* Follow us on Mastodon: `@[email protected] `__

* Follow us on BlueSky:  `@catalyst.coop `__

* `Follow us on LinkedIn `__

* `Follow us on HuggingFace `__

* Follow us on Twitter: `@CatalystCoop `__

* `Follow us on Kaggle `__

* More info on our website: https://catalyst.coop

* Email us if you'd like to hire us to provide customized data extraction and analysis:

  `[email protected] `__



About Catalyst Cooperative

--------------------------



`Catalyst Cooperative `__ is a small group of data wranglers

and policy wonks organized as a worker-owned cooperative consultancy. Our goal is a

more just, livable, and sustainable world. We integrate public data and perform

custom analyses to inform public policy

(`Hire us! `__). Our focus is primarily on

mitigating climate change and improving electric utility regulation in the United

States.