Skip to content

Commit

Permalink
Acknowledge PUDL Sustainers (#4025)
Browse files Browse the repository at this point in the history
* Update FUNDING.yml with OC PUDL & remove PayPal.

* Add PUDL Sustainer logos to docs directory.

* Attempt addding PUDL Sustainer logos to README with relative paths.

* Update Sustainer logo formatting

* Add sustainers section to docs; replace PayPal w/ OC in Datasette.

* Add YouTube badge to README

* Bump required coverage back up to 93%.

* Switch to horizontal RMI logo

* Make GW logos wider

* Add grant funders alongside sustainers.

* README formatting.

* README formatting.

* README formatting.

* README formatting.

* README formatting.

* Add Slack links to README

* Add Slack links to README but really

* Add Slack links to README, c'mon man.

* Fix YouTube link corrupted by Fancy Autocomplete.

* Comment out dagster intersphinx inventory reference.
zaneselvans authored Jan 23, 2025
1 parent c3688a6 commit 19264e6
Showing 17 changed files with 966 additions and 816 deletions.
3 changes: 1 addition & 2 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
open_collective: catalyst-cooperative
open_collective: pudl
github: catalyst-cooperative
custom: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -49,3 +49,9 @@ devtools/datasette/fly/Dockerfile
devtools/datasette/fly/inspect-data.json
devtools/datasette/fly/metadata.yml
devtools/datasette/fly/all_dbs.tar.zst

# dbt specific ignores
dbt/dbt_packages/
dbt/target/
dbt/logs/
dbt/.user.yml
92 changes: 85 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
@@ -30,6 +30,8 @@ The Public Utility Data Liberation Project (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
.. |slack| image:: https://img.shields.io/badge/Slack-4A154B?logo=slack&logoColor=fff
:target: https://join.slack.com/t/catalystcooperative/shared_invite/zt-2yg1v2sb7-GsoGlA9Ojc_LCJ00vPWKbQ
.. |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
@@ -39,12 +41,19 @@ The Public Utility Data Liberation Project (PUDL)
.. |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
.. |twitter| image:: https://img.shields.io/badge/X-%23000000.svg?logo=X&logoColor=white
:target: https://x.com/CatalystCoop
:alt: Catalyst Cooperative on Twitter
.. |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|
|office-hours| |mastodon| |linkedin| |bluesky| |kaggle| |slack| |youtube| |twitter|
|aws|

What is PUDL?
-------------
@@ -197,16 +206,17 @@ If your organization uses PUDL we'd love to list you here! Please open a
pull request or email us at `hello@catalyst.coop <mailto:hello@catalyst.coop>`__!

* `RMI <https://rmi.org>`__ via both their `Utility Transition Hub <https://utilitytransitionhub.rmi.org/>`__ and `Optimus financial modeling tool <https://utilitytransitionhub.rmi.org/optimus/>`__
* The `PowerGenome Project <https://github.com/PowerGenome/PowerGenome>`__ out of `Jesse Jenkins' <https://mae.princeton.edu/people/faculty/jenkins>`__ ZERO Lab at Princeton University
* `The ZERO Lab at Princeton University <https://zero.lab.princeton.edu>`__
* `PyPSA-USA <https://github.com/PyPSA/pypsa-usa>`__ an open source power systems model.
* `Energy Innovation <https://energyinnovation.org>`__
* `Singularity Energy <https://singularity.energy>`__ via the `Open Grid Emissions Initiative <https://singularity.energy/open-grid-emissions>`__
* The open source `PyPSA-USA <https://github.com/PyPSA/pypsa-usa>`__ capacity expansion model.
* `The PowerGenome Project <https://github.com/PowerGenome/PowerGenome>`__
* `Singularity Energy <https://singularity.energy>`__
* `The Open Grid Emissions Initiative <https://singularity.energy/open-grid-emissions>`__
* `Win Climate <https://climate.win>`__
* `The Deployment Gap Model Education Fund <https://www.deploymentgap.fund/>`__

.. _pudl_orgs_end:


Contributing to PUDL
--------------------

@@ -218,11 +228,77 @@ Find PUDL useful? Want to help make it better? There are lots of ways to help!
`Github issue tracker <https://github.com/catalyst-cooperative/pudl/issues>`__.
* Feel free to fork the project and make a pull request with new code, better
documentation, or example notebooks.
* `Make a recurring financial contribution <https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url>`__
to support our work liberating public energy data.
* `Hire us to do some custom analysis <https://catalyst.coop/hire-catalyst/>`__ and
allow us to integrate the resulting code into PUDL.

PUDL Sustainers
---------------

The PUDL Sustainers provide ongoing financial support to ensure the open data keeps
flowing, and the project is sustainable long term. They're also involved in our
quarterly planning process. To learn more see `the PUDL Project page on Open Collective
<https://opencollective.com/pudl>`__.

Gigawatt Tier (≥$25,000/year)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: docs/images/logos/RMI.png
:width: 600
:target: https://rmi.org
:alt: RMI
:align: center

.. image:: docs/images/logos/GridLab.png
:width: 600
:target: https://gridlab.org
:alt: GridLab
:align: center

Megawatt Tier (≥$16,000/year)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: docs/images/logos/ZEROLab.png
:width: 400
:target: https://zero.lab.princeton.edu/
:alt: ZERO Lab at Princeton University
:align: center

Kilowatt Tier (≥$8,000/year)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Become our first `kilowatt tier sustainer <https://opencollective.com/pudl>`__!

Major Grant Funders
-------------------

Alfred P. Sloan Foundation
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: docs/images/logos/Sloan.png
:width: 400
:target: https://sloan.org/programs/research/energy-and-environment/
:alt: Alfred P. Sloan Foundation Energy and Environment Program
:align: center

The PUDL Project has been supported by three grants from the `Alfred P. Sloan
Foundation's Energy and Environment Program
<https://sloan.org/programs/research/energy-and-environment>`__, in 2019, 2021, and
2024.

National Science Foundation
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: docs/images/logos/NSF.png
:width: 400
:target: https://new.nsf.gov/funding/opportunities/pathways-enable-open-source-ecosystems-pose
:alt: National Science Foundation Pathways to Enable Open Source Ecosystems (POSE)
:align: center

The PUDL Project was awarded a grant from the National Science Foundation's `Pathways to
Enable Open Source Ecosystems (POSE) program
<https://new.nsf.gov/funding/opportunities/pathways-enable-open-source-ecosystems-pose>`__
(`award 2346139 <https://www.nsf.gov/awardsearch/showAward?AWD_ID=2346139>`__) in 2024.

Licensing
---------

@@ -255,6 +331,8 @@ Contact Us
* `Follow us on HuggingFace <https://huggingface.co/catalystcooperative>`__
* Follow us on Twitter: `@CatalystCoop <https://twitter.com/CatalystCoop>`__
* `Follow us on Kaggle <https://www.kaggle.com/catalystcooperative/>`__
* `Follow us on YouTube <https://youtube.com/@CatalystCooperative>`__
* `Join our Slack <https://join.slack.com/t/catalystcooperative/shared_invite/zt-2yg1v2sb7-GsoGlA9Ojc_LCJ00vPWKbQ>`__
* More info on our website: https://catalyst.coop
* Email us if you'd like to hire us to provide customized data extraction and analysis:
`hello@catalyst.coop <mailto:hello@catalyst.coop>`__
19 changes: 14 additions & 5 deletions docs/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -2,16 +2,25 @@
Contributing to PUDL
===============================================================================


Welcome! We're excited that you're interested in contributing to the Public Utility
Data Liberation effort!

We need lots of help with :ref:`user-feedback`, we welcome :ref:`code-contribs`, and
it would be great to :ref:`connect-orgs` that we can work with.
it would be great to :ref:`connect-orgs` that we can work with. Financial support via
our :ref:`pudl-sustainers` program is always welcome.

.. _pudl-sustainers:

---------------
PUDL Sustainers
---------------

Finally, `financial donations
<https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url>`__
are welcome too!
If you use or appreciate PUDL data and want to help ensure that it continues to be
openly and freely available to the public (and yourself) please consider becoming a PUDL
Sustainer. See the `PUDL project profile on Open Collective
<https://opencollective.com/pudl>`__ for more information. Contributions of any size are
appreciated. Sustainers at higher tiers are invited to help guide the project's
priorities in our quarterly planning process.

---------------
Code of Conduct
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
@@ -94,7 +94,7 @@
# we need to define these package to URL mappings:
intersphinx_mapping = {
"arrow": ("https://arrow.apache.org/docs/", None),
"dagster": ("https://docs.dagster.io/", None),
# "dagster": ("https://docs.dagster.io/", None), # See: https://github.com/dagster-io/dagster/issues/27328
"dask": ("https://docs.dask.org/en/latest/", None),
"datasette": ("https://docs.datasette.io/en/stable/", None),
"geopandas": ("https://geopandas.org/en/stable/", None),
Binary file added docs/images/logos/GridLab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/logos/NSF.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/logos/RMI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/logos/Sloan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/logos/ZEROLab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 70 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -221,6 +221,76 @@ Organizations using PUDL
:end-before: .. _pudl_orgs_end:


---------------------------------------------------------------------------------------
PUDL Sustainers
---------------------------------------------------------------------------------------

The PUDL Sustainers provide ongoing financial support to ensure the open data keeps
flowing, and the project is sustainable long term. They're also involved in our
quarterly planning process. To learn more see `the PUDL Project page on Open Collective
<https://opencollective.com/pudl>`__.

Gigawatt Tier (≥$25,000/year)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: images/logos/RMI.png
:width: 600
:target: https://rmi.org
:alt: RMI
:align: center

.. image:: images/logos/GridLab.png
:width: 600
:target: https://gridlab.org
:alt: GridLab
:align: center

Megawatt Tier (≥$16,000/year)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: images/logos/ZEROLab.png
:width: 400
:target: https://zero.lab.princeton.edu/
:alt: ZERO Lab at Princeton University
:align: center

Kilowatt Tier (≥$8,000/year)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Become our first `kilowatt tier sustainer <https://opencollective.com/pudl>`__!

---------------------------------------------------------------------------------------
Major Grant Funders
---------------------------------------------------------------------------------------

Alfred P. Sloan Foundation
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: images/logos/Sloan.png
:width: 400
:target: https://sloan.org/programs/research/energy-and-environment/
:alt: Alfred P. Sloan Foundation Energy and Environment Program
:align: center

The PUDL Project has been supported by three grants from the `Alfred P. Sloan
Foundation's Energy and Environment Program
<https://sloan.org/programs/research/energy-and-environment>`__, in 2019, 2021, and
2024.

National Science Foundation
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: images/logos/NSF.png
:width: 400
:target: https://new.nsf.gov/funding/opportunities/pathways-enable-open-source-ecosystems-pose
:alt: National Science Foundation Pathways to Enable Open Source Ecosystems (POSE)
:align: center

The PUDL Project was awarded a grant from the National Science Foundation's `Pathways to
Enable Open Source Ecosystems (POSE) program
<https://new.nsf.gov/funding/opportunities/pathways-enable-open-source-ecosystems-pose>`__
(`award 2346139 <https://www.nsf.gov/awardsearch/showAward?AWD_ID=2346139>`__) in 2024.

.. toctree::
:hidden:
:maxdepth: 2
98 changes: 49 additions & 49 deletions environments/conda-linux-64.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1,224 changes: 606 additions & 618 deletions environments/conda-lock.yml

Large diffs are not rendered by default.

98 changes: 49 additions & 49 deletions environments/conda-osx-64.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

98 changes: 49 additions & 49 deletions environments/conda-osx-arm64.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -24,8 +24,8 @@ dependencies = [
"coverage>=7.6",
"dagster>=1.9.9",
"dagster-postgres>=0.25.9,<1", # Update when dagster-postgres graduates to 1.x
"dask>=2024",
"dask-expr>=1.1", # Required for dask[dataframe]
"dask>=2025",
"dask-expr>=2", # Required for dask[dataframe]
"datasette>=0.65",
"doc8>=1.1",
"duckdb>=1.1.3",
@@ -358,7 +358,7 @@ omit = [
precision = 2
sort = "miss"
skip_empty = true
fail_under = 92.25
fail_under = 93
exclude_lines = [
# Have to re-enable the standard pragma
"pragma: no cover",
66 changes: 33 additions & 33 deletions src/pudl/metadata/templates/datasette-metadata.yml.jinja
Original file line number Diff line number Diff line change
@@ -15,9 +15,9 @@ description_html: |
on GitHub</a> to let us know.</li>
<li>If you have a question about the data, you can
<a href="https://github.com/orgs/catalyst-cooperative/discussions/new?category=help-me">start a discussion on GitHub</a>.</li>
<li>If you find our work useful, please consider
<a href="https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url">making
a recurring contribution</a> to support it.</li>
<li>If you find the PUDL Project useful, please consider becoming a
<a href="https://opencollective.com/pudl">PUDL Sustainer</a> to help keep the open
data freely flowing.</li>
</ul></p>
license: {{ license.name }}
license_url: {{ license['path'] }}
@@ -56,9 +56,9 @@ databases:
on GitHub</a> to let us know.</li>
<li>You can reach the PUDL team at
<a href="mailto:{{ pudl_ds.email }}">{{ pudl_ds.email }}</a>.</li>
<li>If you find our work useful, please consider
<a href="https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url">making
a recurring contribution</a> to support it.</li>
<li>If you find the PUDL Project useful, please consider becoming a
<a href="https://opencollective.com/pudl">PUDL Sustainer</a> to help keep the open
data freely flowing.</li>
</ul></p>
{%- endfor %}
tables:
@@ -114,9 +114,9 @@ databases:
on GitHub</a> to let us know.</li>
<li>If you have a question about the data, you can
<a href="https://github.com/orgs/catalyst-cooperative/discussions/new?category=help-me">start a discussion on GitHub</a>.</li>
<li>If you find our work useful, please consider
<a href="https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url">making
a recurring contribution</a> to support it.</li>
<li>If you find the PUDL Project useful, please consider becoming a
<a href="https://opencollective.com/pudl">PUDL Sustainer</a> to help keep the open
data freely flowing.</li>
</ul></p>
{%- endfor %}
tables:
@@ -152,9 +152,9 @@ databases:
on GitHub</a> to let us know.</li>
<li>If you have a question about the data, you can
<a href="https://github.com/orgs/catalyst-cooperative/discussions/new?category=help-me">start a discussion on GitHub</a>.</li>
<li>If you find our work useful, please consider
<a href="https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url">making
a recurring contribution</a> to support it.</li>
<li>If you find the PUDL Project useful, please consider becoming a
<a href="https://opencollective.com/pudl">PUDL Sustainer</a> to help keep the open
data freely flowing.</li>
</ul></p>
{%- endfor %}
tables:
@@ -205,9 +205,9 @@ databases:
on GitHub</a> to let us know.</li>
<li>If you have a question about the data, you can
<a href="https://github.com/orgs/catalyst-cooperative/discussions/new?category=help-me">start a discussion on GitHub</a>.</li>
<li>If you find our work useful, please consider
<a href="https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url">making
a recurring contribution</a> to support it.</li>
<li>If you find the PUDL Project useful, please consider becoming a
<a href="https://opencollective.com/pudl">PUDL Sustainer</a> to help keep the open
data freely flowing.</li>
</ul></p>
{%- endfor %}
tables:
@@ -243,9 +243,9 @@ databases:
on GitHub</a> to let us know.</li>
<li>If you have a question about the data, you can
<a href="https://github.com/orgs/catalyst-cooperative/discussions/new?category=help-me">start a discussion on GitHub</a>.</li>
<li>If you find our work useful, please consider
<a href="https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url">making
a recurring contribution</a> to support it.</li>
<li>If you find the PUDL Project useful, please consider becoming a
<a href="https://opencollective.com/pudl">PUDL Sustainer</a> to help keep the open
data freely flowing.</li>
</ul></p>
{%- endfor %}
tables:
@@ -296,9 +296,9 @@ databases:
on GitHub</a> to let us know.</li>
<li>If you have a question about the data, you can
<a href="https://github.com/orgs/catalyst-cooperative/discussions/new?category=help-me">start a discussion on GitHub</a>.</li>
<li>If you find our work useful, please consider
<a href="https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url">making
a recurring contribution</a> to support it.</li>
<li>If you find the PUDL Project useful, please consider becoming a
<a href="https://opencollective.com/pudl">PUDL Sustainer</a> to help keep the open
data freely flowing.</li>
</ul></p>
{%- endfor %}
tables:
@@ -334,9 +334,9 @@ databases:
on GitHub</a> to let us know.</li>
<li>If you have a question about the data, you can
<a href="https://github.com/orgs/catalyst-cooperative/discussions/new?category=help-me">start a discussion on GitHub</a>.</li>
<li>If you find our work useful, please consider
<a href="https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url">making
a recurring contribution</a> to support it.</li>
<li>If you find the PUDL Project useful, please consider becoming a
<a href="https://opencollective.com/pudl">PUDL Sustainer</a> to help keep the open
data freely flowing.</li>
</ul></p>
{%- endfor %}
tables:
@@ -387,9 +387,9 @@ databases:
on GitHub</a> to let us know.</li>
<li>If you have a question about the data, you can
<a href="https://github.com/orgs/catalyst-cooperative/discussions/new?category=help-me">start a discussion on GitHub</a>.</li>
<li>If you find our work useful, please consider
<a href="https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url">making
a recurring contribution</a> to support it.</li>
<li>If you find the PUDL Project useful, please consider becoming a
<a href="https://opencollective.com/pudl">PUDL Sustainer</a> to help keep the open
data freely flowing.</li>
</ul></p>
{%- endfor %}
tables:
@@ -425,9 +425,9 @@ databases:
on GitHub</a> to let us know.</li>
<li>If you have a question about the data, you can
<a href="https://github.com/orgs/catalyst-cooperative/discussions/new?category=help-me">start a discussion on GitHub</a>.</li>
<li>If you find our work useful, please consider
<a href="https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url">making
a recurring contribution</a> to support it.</li>
<li>If you find the PUDL Project useful, please consider becoming a
<a href="https://opencollective.com/pudl">PUDL Sustainer</a> to help keep the open
data freely flowing.</li>
</ul></p>
{%- endfor %}
tables:
@@ -478,9 +478,9 @@ databases:
on GitHub</a> to let us know.</li>
<li>If you have a question about the data, you can
<a href="https://github.com/orgs/catalyst-cooperative/discussions/new?category=help-me">start a discussion on GitHub</a>.</li>
<li>If you find our work useful, please consider
<a href="https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url">making
a recurring contribution</a> to support it.</li>
<li>If you find the PUDL Project useful, please consider becoming a
<a href="https://opencollective.com/pudl">PUDL Sustainer</a> to help keep the open
data freely flowing.</li>
</ul></p>
{%- endfor %}
tables:

0 comments on commit 19264e6

Please sign in to comment.