Merge pull request #2856 from catalyst-cooperative/rename-ferc-output…

…-assets Rename ferc1 output assets
catalyst-cooperative · Sep 18, 2023 · 0a912e4 · 0a912e4
2 parents ce16bbd + 00ce1e9
commit 0a912e4
Show file tree

Hide file tree

Showing 8 changed files with 1,509 additions and 164 deletions.
diff --git a/docs/templates/package.rst.jinja b/docs/templates/package.rst.jinja
@@ -7,7 +7,7 @@ Please note that tables beginning with "denorm" are temporary tables whose names
 metadata will shortly change, as we migrate new tables into our database.
 
 {% for resource in package.resources %}
-.. _{{ resource.name }}:
+.. _{{ resource.name.lstrip("_") }}:
 
 {% include 'resource.rst.jinja' %}
 {% endfor %}
diff --git a/migrations/versions/1c2c961a7be5_rename_ferc_output_assets.py b/migrations/versions/1c2c961a7be5_rename_ferc_output_assets.py
diff --git a/src/pudl/etl/__init__.py b/src/pudl/etl/__init__.py
@@ -65,7 +65,7 @@
         [pudl.analysis.allocate_gen_fuel], group_name="allocate_gen_fuel"
     ),
     *load_assets_from_modules([pudl.analysis.mcoe], group_name="mcoe"),
-    *load_assets_from_modules([pudl.output.ferc1], group_name="denorm_ferc1"),
+    *load_assets_from_modules([pudl.output.ferc1], group_name="out_ferc1"),
     *load_assets_from_modules(
         [pudl.analysis.service_territory], group_name="service_territory_eia861"
     ),

diff --git a/src/pudl/metadata/resources/ferc1.py b/src/pudl/metadata/resources/ferc1.py
@@ -831,7 +831,7 @@
         "etl_group": "ferc1",
         "field_namespace": "ferc1",
     },
-    "denorm_plants_utilities_ferc1": {
+    "_out_ferc1__yearly_plants_utilities": {
         "description": "Denormalized table that contains FERC plant and utility information.",
         "schema": {
             "fields": [
@@ -847,7 +847,7 @@
         "etl_group": "outputs",
         "sources": ["ferc1"],
     },
-    "denorm_balance_sheet_assets_ferc1": {
+    "out_ferc1__yearly_balance_sheet_assets": {
         "description": "Denormalized table that contains FERC balance sheet asset information.",
         "schema": {
             "fields": [
@@ -873,7 +873,7 @@
         "etl_group": "outputs",
         "sources": ["ferc1"],
     },
-    "denorm_balance_sheet_liabilities_ferc1": {
+    "out_ferc1__yearly_balance_sheet_liabilities": {
         "description": "Denormalized table that contains FERC balance sheet liability information.",
         "schema": {
             "fields": [
@@ -899,7 +899,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_cash_flow_ferc1": {
+    "out_ferc1__yearly_cash_flow": {
         "description": "Denormalized table that contains FERC cash flow information.",
         "schema": {
             "fields": [
@@ -923,7 +923,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_depreciation_amortization_summary_ferc1": {
+    "out_ferc1__yearly_depreciation_amortization_summary": {
         "description": "Denormalized table that contains FERC depreciation amortization information.",
         "schema": {
             "fields": [
@@ -948,7 +948,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_electric_energy_dispositions_ferc1": {
+    "out_ferc1__yearly_electric_energy_dispositions": {
         "description": "Denormalized table that contains FERC electric energy dispositions information.",
         "schema": {
             "fields": [
@@ -971,7 +971,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_electric_energy_sources_ferc1": {
+    "out_ferc1__yearly_electric_energy_sources": {
         "description": "Denormalized table that contains FERC electric energy sources information.",
         "schema": {
             "fields": [
@@ -994,7 +994,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_electric_operating_expenses_ferc1": {
+    "out_ferc1__yearly_electric_operating_expenses": {
         "description": "Denormalized table that contains FERC electric operating expense information.",
         "schema": {
             "fields": [
@@ -1014,7 +1014,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_electric_operating_revenues_ferc1": {
+    "out_ferc1__yearly_electric_operating_revenues": {
         "description": "Denormalized table that contains FERC electric operating revenue information.",
         "schema": {
             "fields": [
@@ -1040,7 +1040,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_electric_plant_depreciation_changes_ferc1": {
+    "out_ferc1__yearly_electric_plant_depreciation_changes": {
         "description": "Denormalized table that contains FERC electric plant depreciation changes information.",
         "schema": {
             "fields": [
@@ -1069,7 +1069,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_electric_plant_depreciation_functional_ferc1": {
+    "out_ferc1__yearly_electric_plant_depreciation_functional": {
         "description": "Denormalized table that contains FERC electric plant depreciation functional information.",
         "schema": {
             "fields": [
@@ -1098,7 +1098,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_electricity_sales_by_rate_schedule_ferc1": {
+    "out_ferc1__yearly_electricity_sales_by_rate_schedule": {
         "description": "Denormalized table that contains FERC electricity sales by rate schedule information.",
         "schema": {
             "fields": [
@@ -1121,7 +1121,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_income_statement_ferc1": {
+    "out_ferc1__yearly_income_statement": {
         "description": "Denormalized table that contains FERC income statement information.",
         "schema": {
             "fields": [
@@ -1148,7 +1148,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_other_regulatory_liabilities_ferc1": {
+    "out_ferc1__yearly_other_regulatory_liabilities": {
         "description": "Denormalized table that contains FERC other regulatory liabilities information.",
         "schema": {
             "fields": [
@@ -1168,7 +1168,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_retained_earnings_ferc1": {
+    "out_ferc1__yearly_retained_earnings": {
         "description": "Denormalized table that contains FERC retained earnings information.",
         "schema": {
             "fields": [
@@ -1194,7 +1194,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_transmission_statistics_ferc1": {
+    "out_ferc1__yearly_transmission_statistics": {
         "description": "Denormalized table that contains FERC transmission statistics information.",
         "schema": {
             "fields": [
@@ -1225,7 +1225,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_utility_plant_summary_ferc1": {
+    "out_ferc1__yearly_utility_plant_summary": {
         "description": "Denormalized table that contains FERC utility plant summary information.",
         "schema": {
             "fields": [
@@ -1251,7 +1251,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_plants_steam_ferc1": {
+    "_out_ferc1__yearly_steam_plants": {
         "description": "Denormalized table that contains steam plant information from FERC Form 1.",
         "schema": {
             "fields": [
@@ -1319,7 +1319,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_plants_small_ferc1": {
+    "_out_ferc1__yearly_small_plants": {
         "description": "Denormalized table that contains small plant information from FERC Form 1.",
         "schema": {
             "fields": [
@@ -1354,7 +1354,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_plants_hydro_ferc1": {
+    "_out_ferc1__yearly_hydro_plants": {
         "description": "Denormalized table that contains small plant information from FERC Form 1.",
         "schema": {
             "fields": [
@@ -1409,7 +1409,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_plants_pumped_storage_ferc1": {
+    "_out_ferc1__yearly_pumped_storage_plants": {
         "description": "Denormalized table that contains pumped storage plant information from FERC Form 1.",
         "schema": {
             "fields": [
@@ -1468,7 +1468,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_fuel_ferc1": {
+    "out_ferc1__yearly_fuel": {
         "description": "Denormalized table that contains fuel information from FERC Form 1.",
         "schema": {
             "fields": [
@@ -1497,7 +1497,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_purchased_power_ferc1": {
+    "out_ferc1__yearly_purchased_power": {
         "description": "Denormalized table of FERC Form 1 Purchased Power data.",
         "schema": {
             "fields": [
@@ -1525,7 +1525,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_plant_in_service_ferc1": {
+    "out_ferc1__yearly_plant_in_service": {
         "description": "Denormalized table of FERC Form 1 Electric Plant in Service data.",
         "schema": {
             "fields": [
@@ -1550,7 +1550,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_plants_all_ferc1": {
+    "out_ferc1__yearly_all_plants": {
         "description": "Denormalized table combining the steam, small generators, hydro, and pumped storage tables from FERC Form 1.",
         "schema": {
             "fields": [
@@ -1639,7 +1639,7 @@
         "etl_group": "outputs",
         "field_namespace": "ferc1",
     },
-    "denorm_fuel_by_plant_ferc1": {
+    "out_ferc1__yearly_fuel_by_plant": {
         "description": "A table summarizing FERC fuel data by plant, using FERC Form 1 data.",
         "schema": {
             "fields": [