Conversation
For more information, see https://pre-commit.ci
| FUEL_CATEGORIES: dict[str, Path] = { | ||
| "categories": Path( | ||
| importlib.resources.files("pudl.package_data.ferc1") / "fuel_categories.yaml" | ||
| ) |
There was a problem hiding this comment.
using explicit Path() here makes all these yaml categories entries consistent, but only the SUPPORTING_STRUCTURE ones are new in this PR
| """ | ||
|
|
||
| PLANT_TYPE_CATEGORIES_HYDRO: dict[str, set[str]] = { | ||
| PLANT_TYPE_CATEGORIES_HYDRO: dict[str, dict[str, set[str]]] = { |
There was a problem hiding this comment.
unrelated opportunistic type hint correction
Normalize column descriptions
* Set up a devcontainer for PUDL. * Simplify devcontainer pixi tasks * Add devcontainer section to dev_setup docs * Update devcontainer docs and release notes * Remove unnecessary setup in postCreateCommand * Apply suggestions from code review Co-authored-by: Kathryn Mazaitis <1158666+krivard@users.noreply.github.com> * Make coding agent usage of devcontainer obvious in docs --------- Co-authored-by: Kathryn Mazaitis <1158666+krivard@users.noreply.github.com>
| .. _ferc-structure-type-material: | ||
|
|
||
| Supporting Structure Types & Materials | ||
| -------------------------------------- |
There was a problem hiding this comment.
@zaneselvans looking especially for feedback on the source docs below; does this feel like it will give data users enough information to decide whether to use our type & materials columns vs doing that handling themselves? is it too much information?
i had originally planned to put the regexes in here too but chickened out (they are perhaps unsurprisingly not super legible). what do you think?
|
Attempted to refresh this but got a bunch of suspicious unmatched structure types sooooo back to the drawing board for future self: unmatched strings are showing up with capital letters, but I expected them to have gone through at least some normalization first. what gives |
|
oh no |
3 participants
Overview
Closes #4658
(really: brings #4859 into
main)What problem does this address?
@dd921 contributed a nice PR mapping
supporting_structure_typefree-form text to enums in #4859, but the mappings themselves needed a little QA zhuzh before we could deploy them in PUDL.What did you change?
Changes from #4859, plus:
supporting_structure_*_categories.ymlfiles updated with remaps from @zaneselvans and me (catalysters can view the extensive worksheet we used for labeling & analysis)Documentation
Make sure to update relevant aspects of the documentation:
docs/data_sources/templates).Testing
How did you make sure this worked? How can a reviewer verify this?
out_ferc1__yearly_transmission_lines_sched422and ancestors and verified no* uncategorized values warning appearedpixi run docs-buildand view results* okay it appears but the only values it flags are the empty string and the literal
n/aso that seems fine actuallyTo-do list
pixi run prek-runto run linters and static code analysis checks.pixi run pytest-cilocally to ensure that the merge queue will accept your PR.build-deploy-pudlGitHub Action manually and ensure that it succeeds.