Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply new naming convention to ferc714 and eia861 output assets #2882

Merged
merged 6 commits into from
Sep 26, 2023

Conversation

bendnorman
Copy link
Member

@bendnorman bendnorman commented Sep 21, 2023

PR Overview

This PR applies new naming conventions to eia861 service territory, ferc714 state demand and respondent output assets.

PR Checklist

  • Merge the most recent version of the branch you are merging into (probably dev).
  • All CI checks are passing. Run tests locally to debug failures
  • Make sure you've included good docstrings.
  • For major data coverage & analysis changes, run data validation tests
  • Include unit tests for new functions and classes.
  • Defensive data quality/sanity checks in analyses & data processing functions.
  • Update the release notes and reference reference the PR and related issues.
  • Do your own explanatory review of the PR to help the reviewer understand what's going on and identify issues preemptively.

Base automatically changed from rename-allocate-gen-fuel-assets to rename-core-assets September 21, 2023 13:58
@bendnorman bendnorman changed the title Apply new naming convention to ferc714 respondents, hourly demand and… Apply new naming convention to ferc714 and eia861 output assets Sep 21, 2023
@codecov
Copy link

codecov bot commented Sep 21, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (09a876d) 88.5% compared to head (6a5411a) 88.5%.

Additional details and impacted files
@@                Coverage Diff                 @@
##           rename-core-assets   #2882   +/-   ##
==================================================
  Coverage                88.5%   88.5%           
==================================================
  Files                      90      90           
  Lines                   10139   10139           
==================================================
  Hits                     8982    8982           
  Misses                   1157    1157           
Files Coverage Δ
src/pudl/analysis/service_territory.py 52.1% <100.0%> (ø)
src/pudl/analysis/state_demand.py 60.1% <100.0%> (ø)
src/pudl/metadata/resources/eia.py 100.0% <ø> (ø)
src/pudl/metadata/resources/eia860.py 100.0% <ø> (ø)
src/pudl/metadata/resources/eia861.py 100.0% <ø> (ø)
src/pudl/metadata/resources/ferc714.py 100.0% <ø> (ø)
src/pudl/metadata/resources/pudl.py 100.0% <ø> (ø)
src/pudl/output/ferc714.py 96.2% <100.0%> (ø)
src/pudl/output/pudltabl.py 90.1% <ø> (ø)

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@e-belfer e-belfer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another migration issue here - oddly I had to run a new migration for to drop a foreign key constraint for fk_core_eia861__assn_balancing_authority_utility_id_eia_core_eia__entity_utilities, is this different than what you were seeing?

Otherwise a few non-blocking suggestions. With the migration tweak the fast ETL runs on local as expected.

@@ -173,8 +173,8 @@ Data Coverage

* :ref:`core_ferc714__respondent_id` (linking FERC-714 respondents to EIA utilities)
* :ref:`core_ferc714__hourly_demand_pa` (hourly electricity demand by planning area)
* :ref:`fipsified_respondents_ferc714` (annual respondents with county FIPS IDs)
* :ref:`summarized_demand_ferc714` (annual demand for FERC-714 respondents)
* :ref:`out_ferc714__fipsified_respondents` (annual respondents with county FIPS IDs)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

non-blocking: respondents_with_fips might be clearer

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, but I want to preserve the PudlTabl API for now.

Copy link
Member

@e-belfer e-belfer Sep 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% following. It should be possible to change the underlying table asset name and keep the PudlTabl method name as it was without altering access (the same as for all the other assets). In which case we'd still want to update the release notes to refer to the actual table, as you have here.

Copy link
Member Author

@bendnorman bendnorman Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I'm sorry I thought you were referring to the PudlTabl method. I just renamed the table to out_ferc714__respondents_with_fips .

src/pudl/analysis/service_territory.py Show resolved Hide resolved
src/pudl/analysis/state_demand.py Show resolved Hide resolved
),
*load_assets_from_modules(
[pudl.analysis.state_demand], group_name="state_demand_ferc714"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was some chatter last round about whether this should be ferc714 or nod to the inclusion of EIA 861 data in these outputs as well, but I think leaving it this way is ok.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah that's right. I'm down to keep it 714 for now given the majority of the data is from ferc714.

@bendnorman bendnorman requested a review from e-belfer September 25, 2023 13:56
Copy link
Member

@e-belfer e-belfer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fast ETL runs without issue. One remaining question about the fipsified_respondents asset name but it's just my preference, and I'm fine to merge without addressing it if you disagree.

@bendnorman bendnorman merged commit 9d30977 into rename-core-assets Sep 26, 2023
9 checks passed
@bendnorman bendnorman deleted the rename-annualized-respondents-ferc714 branch September 26, 2023 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants