===============================================================================
The Public Utility Data Liberation Project (PUDL)
.. readme-intro
.. |repo-status| image:: https://img.shields.io/badge/repo%20status-active-success
:target: https://www.repostatus.org/#active
:alt: Project Status: Active
.. |pytest| image:: https://img.shields.io/github/actions/workflow/status/catalyst-cooperative/pudl/pytest.yml?event=merge_group&label=pytest
: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
.. |docs| image:: https://img.shields.io/github/actions/workflow/status/catalyst-cooperative/pudl/build-deploy-docs.yml?branch=main&event=push&label=docs
:target: https://docs.catalyst.coop/pudl/en/latest
:alt: Docs Build Status
.. |oc| image:: https://img.shields.io/badge/Open%20Collective-donate-3385FF?logo=opencollective&logoColor=white
:target: https://opencollective.com/pudl
.. |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://img.shields.io/badge/DOI-10.5281%2Fzenodo.3404014-1682D4?logo=zenodo&logoColor=white
:target: https://doi.org/10.5281/zenodo.3404014
: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
.. |youtube| image:: https://img.shields.io/badge/YouTube-%23FF0000.svg?logo=YouTube&logoColor=white
:target: https://youtube.com/@CatalystCooperative
:alt: Catalyst Cooperative on YouTube
.. |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|
|pre-commit-ci|
|docs|
|oc|
|zenodo-doi|
|office-hours|
|mastodon|
|linkedin|
|bluesky|
|kaggle|
|youtube|
|aws|
What is PUDL?
The PUDL <https://catalyst.coop/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 <https://github.com/catalyst-cooperative/pudl-archiver>__ all our raw
inputs on Zenodo <https://zenodo.org/communities/catalyst-cooperative/?page=1&size=20>__ 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 <https://docs.catalyst.coop/pudl/en/nightly/#raw-data-archives>__.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
