Add organization using PUDL section to readme

[bendnorman]

Overview

Someone as CSV conf recommended we add a section to our README/docs where orgs using PUDL data can add themselves. I think this is an easy way to find more of our users and build trust with prospective users.

I once added PUDL to pydantic's readme but the section as removed with v2.

Should we structure this information so that it can live in our docs and README?

Testing

How did you make sure this worked? How can a reviewer verify this?

To-do list

Edit tasklist title

Beta Give feedback Tasklist To-do list, more options

• Rename
• Copy markdown
• Delete tasklist

Delete tasklist

Delete tasklist block?

Are you sure? All relationships in this tasklist will be removed.

Cancel Delete

1. If updating analyses or data processing functions: make sure to update or write data validation tests (e.g., `test_minmax_rows()`)

   If updating analyses or data processing functions: make sure to update or write data validation tests (e.g., test_minmax_rows())
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
2. Update the [release notes](../docs/release_notes.rst): reference the PR and related issues.

   Update the release notes: reference the PR and related issues.
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
3. Ensure docs build, unit & integration tests, and test coverage pass locally with `make pytest-coverage` (otherwise the merge queue may reject your PR)

   Ensure docs build, unit & integration tests, and test coverage pass locally with make pytest-coverage (otherwise the merge queue may reject your PR)
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
4. Review the PR yourself and call out any questions or issues you have

   Review the PR yourself and call out any questions or issues you have
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
5. For minor ETL changes or data additions, once `make pytest-coverage` passes, make sure you have a fresh full PUDL DB downloaded locally, materialize new/changed assets and all their downstream assets and [run relevant data validation tests](https://catalystcoop-pudl.readthedocs.io/en/latest/dev/testing.html#data-validation) using `pytest` and `--live-dbs`.

   For minor ETL changes or data additions, once make pytest-coverage passes, make sure you have a fresh full PUDL DB downloaded locally, materialize new/changed assets and all their downstream assets and run relevant data validation tests using pytest and --live-dbs.
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
6. For significant ETL, data coverage or analysis changes, once `make pytest-coverage` passes, ensure the full ETL runs locally and [run data validation tests](https://catalystcoop-pudl.readthedocs.io/en/latest/dev/testing.html#data-validation) using `make pytest-validate` (a ~10 hour run). If you can't run this locally, run the `build-deploy-pudl` GitHub Action (or ask someone with permissions to). Then, check the logs on the `#pudl-deployments` Slack channel or `gs://builds.catalyst.coop`.

   For significant ETL, data coverage or analysis changes, once make pytest-coverage passes, ensure the full ETL runs locally and run data validation tests using make pytest-validate (a ~10 hour run). If you can't run this locally, run the build-deploy-pudl GitHub Action (or ask someone with permissions to). Then, check the logs on the #pudl-deployments Slack channel or gs://builds.catalyst.coop.
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove

Add item to To-do list Loading

[bendnorman]

It'd also be nice to add a couple of orgs to the list before we merge this in.

[e-belfer]

@bendnorman Do you want to add organizations we already know are using PUDL data to this PR? Possibly we can tag some of our known downstream users on Github and just get a confirmation that they accept being added, so we don't start with an empty list?

(editing to add: same idea!)

[e-belfer]

Tiny typo - Incomplete?

[e-belfer]

At least to start, that would be:

• The Utility Transition Hub and Optimus financial modelling tool at RMI (@arengel)
• PowerGenome at ZEROLab at Princeton University (@gschivley)
• Open Grid Emissions at Singularity Energy (@grgmiller)
• PyPSA - USA (@ktehranchi)

If I've just tagged you: we're taking the long overdue step of adding organizations that use our data to our README. Just wanted to confirm that you all are OK with being listed here?

[bendnorman]

@e-belfer do you think the list should include a description of how the project is using PUDL or just a link to the org?

[e-belfer]

@e-belfer do you think the list should include a description of how the project is using PUDL or just a link to the org?

I think the project and organization name with links should be enough here, personally.

[bendnorman]

Ok I added a few orgs to the list. There are more orgs we could reach out to, but I think this is good enough for now. Once we merge this in we can share on our socials to recruit more folks to add their orgs.

[e-belfer]

Thanks for taking initiative here!

Non-blocking: Think it'd be great to also add this same list on the home page (index.rst) of our readthedocs, but this is a good start.