Merge pull request #2995 from catalyst-cooperative/rename-ferc1-assets

Rename FERC Form 1 core and output assets
catalyst-cooperative · Nov 6, 2023 · 0c3b9ae · 0c3b9ae
2 parents c2af359 + fc7de0e
commit 0c3b9ae
Show file tree

Hide file tree

Showing 36 changed files with 27,682 additions and 5,049 deletions.
diff --git a/devtools/debug-ferc1-etl.ipynb b/devtools/debug-ferc1-etl.ipynb
@@ -99,7 +99,7 @@
    },
    "outputs": [],
    "source": [
-    "ferc1_xbrl_raw_dfs[\"core_ferc1__yearly_fuel\"][\"duration\"].report_year"
+    "ferc1_xbrl_raw_dfs[\"core_ferc1__yearly_steam_plants_fuel_sched402\"][\"duration\"].report_year"
    ]
   },
   {
@@ -206,7 +206,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "table_name = \"core_ferc1__yearly_other_regulatory_liabilities\"\n",
+    "table_name = \"core_ferc1__yearly_other_regulatory_liabilities_sched278\"\n",
     "TRANSFORMER = transformers[table_name]  # add a table here"
    ]
   },
@@ -326,8 +326,8 @@
    "source": [
     "transformed_tables = {}\n",
     "for table_name, transformer in transformers.items():\n",
-    "    if table_name == \"core_ferc1__yearly_plants_steam\":\n",
-    "        # core_ferc1__yearly_plants_steam is a special case. It depends on the transformed core_ferc1__yearly_fuel table.\n",
+    "    if table_name == \"core_ferc1__yearly_steam_plants_sched402\":\n",
+    "        # core_ferc1__yearly_steam_plants_sched402 is a special case. It depends on the transformed core_ferc1__yearly_steam_plants_fuel_sched402 table.\n",
     "        continue\n",
     "    transformed_tables[transformer.table_id.value] = transformer.transform(\n",
     "        raw_dbf=ferc1_dbf_raw_dfs[transformer.table_id.value],\n",
@@ -345,13 +345,13 @@
    },
    "outputs": [],
    "source": [
-    "# Handle special case for \"core_ferc1__yearly_plants_steam\"\n",
-    "transformer = transformers[\"core_ferc1__yearly_plants_steam\"]\n",
+    "# Handle special case for \"core_ferc1__yearly_steam_plants_sched402\"\n",
+    "transformer = transformers[\"core_ferc1__yearly_steam_plants_sched402\"]\n",
     "transformed_tables[transformer.table_id.value] = transformer.transform(\n",
     "    raw_dbf=ferc1_dbf_raw_dfs[transformer.table_id.value],\n",
     "    raw_xbrl_instant=ferc1_xbrl_raw_dfs[transformer.table_id.value][\"instant\"],\n",
     "    raw_xbrl_duration=ferc1_xbrl_raw_dfs[transformer.table_id.value][\"duration\"],\n",
-    "    transformed_fuel=transformed_tables[\"core_ferc1__yearly_fuel\"],\n",
+    "    transformed_fuel=transformed_tables[\"core_ferc1__yearly_steam_plants_fuel_sched402\"],\n",
     ")"
    ]
   }

diff --git a/devtools/ferc1-eia-glue/training_data/create_FERC1-EIA_manual_mapping_spreadsheets.ipynb b/devtools/ferc1-eia-glue/training_data/create_FERC1-EIA_manual_mapping_spreadsheets.ipynb
@@ -43,7 +43,7 @@
     "# Local libraries\n",
     "import pudl\n",
     "from pudl.workspace.setup import PudlPaths\n",
-    "from pudl.analysis.ferc1_eia_train import *"
+    "from pudl.analysis.eia_ferc1_train import *"
    ]
   },
   {

diff --git a/...rc1-eia-glue/training_data/validate_and_integrate_FERC1-EIA_manually_mapped_records.ipynb b/...rc1-eia-glue/training_data/validate_and_integrate_FERC1-EIA_manually_mapped_records.ipynb
@@ -44,7 +44,7 @@
     "# Local libraries\n",
     "import pudl\n",
     "from pudl.workspace.setup import PudlPaths\n",
-    "from pudl.analysis.ferc1_eia_train import *"
+    "from pudl.analysis.eia_ferc1_train import *"
    ]
   },
   {
@@ -188,7 +188,7 @@
    "outputs": [],
    "source": [
     "current_training_df = pd.read_csv(\n",
-    "    importlib.resources.files(\"pudl.package_data.glue\").joinpath(\"ferc1_eia_train.csv\")\n",
+    "    importlib.resources.files(\"pudl.package_data.glue\").joinpath(\"eia_ferc1_train.csv\")\n",
     ")\n",
     "path_to_overrides = \"./add_to_training/\"\n",
     "override_files = [\n",
@@ -326,10 +326,10 @@
     "# Get paths to CSVs.\n",
     "from importlib import resources\n",
     "one_to_many = path_to_one_to_many=resources.files(\"pudl.package_data.glue\").joinpath(\n",
-    "                \"ferc1_eia_one_to_many.csv\",\n",
+    "                \"eia_ferc1_one_to_many.csv\",\n",
     "            )\n",
     "nulls = path_to_one_to_many=resources.files(\"pudl.package_data.glue\").joinpath(\n",
-    "                \"ferc1_eia_null.csv\",\n",
+    "                \"eia_ferc1_null.csv\",\n",
     "            )"
    ]
   },

diff --git a/docs/release_notes.rst b/docs/release_notes.rst
@@ -85,31 +85,33 @@ Data Coverage
   To see which DBF and XBRL tables the following PUDL tables are derived from, refer to
   :py:const:`pudl.extract.ferc1.TABLE_NAME_MAP`
 
-  * :ref:`core_ferc1__yearly_electric_energy_sources`, see issue :issue:`1819` & PR
+  * :ref:`core_ferc1__yearly_energy_sources_sched401`, see issue :issue:`1819` & PR
     :pr:`2094`.
-  * :ref:`core_ferc1__yearly_electric_energy_dispositions`, see issue :issue:`1819` &
+  * :ref:`core_ferc1__yearly_energy_dispositions_sched401`, see issue :issue:`1819` &
     PR :pr:`2100`.
-  * :ref:`core_ferc1__yearly_transmission_statistics`, see issue :issue:`1822` & PR
+  * :ref:`core_ferc1__yearly_transmission_lines_sched422`, see issue :issue:`1822` & PR
     :pr:`2103`
-  * :ref:`core_ferc1__yearly_utility_plant_summary`, see issue :issue:`1806` & PR
-    :pr:`2105`.
-  * :ref:`core_ferc1__yearly_balance_sheet_assets`, see issue :issue:`1805` & PRs
-    :pr:`2112,2127`.
-  * :ref:`core_ferc1__yearly_balance_sheet_liabilities`, see issue :issue:`1810` & PR
-    :pr:`2134`.
-  * :ref:`core_ferc1__yearly_depreciation_amortization_summary`, see issue :issue:`1816`
+  * :ref:`core_ferc1__yearly_utility_plant_summary_sched200`, see issue
+    :issue:`1806` & PR :pr:`2105`.
+  * :ref:`core_ferc1__yearly_balance_sheet_assets_sched110`, see issue :issue:`1805` &
+    PRs :pr:`2112,2127`.
+  * :ref:`core_ferc1__yearly_balance_sheet_liabilities_sched110`, see issue
+    :issue:`1810` & PR :pr:`2134`.
+  * :ref:`core_ferc1__yearly_depreciation_summary_sched336`, see issue :issue:`1816`
     & PR :pr:`2143`.
-  * :ref:`core_ferc1__yearly_income_statement`, see issue :issue:`1813` & PR :pr:`2147`.
-  * :ref:`core_ferc1__yearly_electric_plant_depreciation_changes` see issue
+  * :ref:`core_ferc1__yearly_income_statements_sched114`, see issue :issue:`1813` & PR
+    :pr:`2147`.
+  * :ref:`core_ferc1__yearly_depreciation_changes_sched219` see issue
     :issue:`1808` & :pr:`2119`.
-  * :ref:`core_ferc1__yearly_electric_plant_depreciation_functional` see issue
+  * :ref:`core_ferc1__yearly_depreciation_by_function_sched219` see issue
     :issue:`1808` & PR :pr:`2183`.
-  * :ref:`core_ferc1__yearly_electric_operating_expenses`, see issue :issue:`1817` & PR
+  * :ref:`core_ferc1__yearly_operating_expenses_sched320`, see issue :issue:`1817` & PR
     :pr:`2162`.
-  * :ref:`core_ferc1__yearly_retained_earnings`, see issue :issue:`1811` & PR
+  * :ref:`core_ferc1__yearly_retained_earnings_sched118`, see issue :issue:`1811` & PR
     :pr:`2155`.
-  * :ref:`core_ferc1__yearly_cash_flow`, see issue :issue:`1821` & PR :pr:`2184`
-  * :ref:`core_ferc1__yearly_electricity_sales_by_rate_schedule`, see issue
+  * :ref:`core_ferc1__yearly_cash_flows_sched120`, see issue :issue:`1821` & PR
+    :pr:`2184`.
+  * :ref:`core_ferc1__yearly_sales_by_rate_schedules_sched304`, see issue
     :issue:`1823` & PR :pr:`2205`.
 
 * Harvested owner utilities from the EIA 860 ownership table which are now included in
@@ -191,7 +193,7 @@ Data Coverage
   granularly connects EPA CAMD with EIA. Thanks to :user:`grgmiller` for his
   contribution to this process. See :issue:`2456` & :pr:`2491`.
 
-* Added new table :ref:`out__yearly_plants_all_ferc1_plant_parts_eia` which links FERC1
+* Added new table :ref:`out_pudl__yearly_assn_eia_ferc1_plant_parts` which links FERC1
   records from :ref:`out_ferc1__yearly_all_plants` and
   :ref:`out_eia__yearly_plant_parts`.
 
@@ -229,27 +231,27 @@ Data Cleaning
   with boilers in the :ref:`core_eia__entity_boilers` table. See issue :issue:`2349` &
   PR :pr:`2362`.
 * Fixed column naming issues in the
-  :ref:`core_ferc1__yearly_electric_operating_revenues` table.
+  :ref:`core_ferc1__yearly_operating_revenues_sched300` table.
 * Made minor calculation fixes in the metadata for
-  :ref:`core_ferc1__yearly_income_statement`,
-  :ref:`core_ferc1__yearly_utility_plant_summary`,
-  :ref:`core_ferc1__yearly_electric_operating_revenues`,
-  :ref:`core_ferc1__yearly_balance_sheet_assets`,
-  :ref:`core_ferc1__yearly_balance_sheet_liabilities`, and
-  :ref:`core_ferc1__yearly_electric_operating_expenses`,
-  :ref:`core_ferc1__yearly_electric_plant_depreciation_changes` and
-  :ref:`core_ferc1__yearly_electric_plant_depreciation_functional`. See :issue:`2016`,
+  :ref:`core_ferc1__yearly_income_statements_sched114`,
+  :ref:`core_ferc1__yearly_utility_plant_summary_sched200`,
+  :ref:`core_ferc1__yearly_operating_revenues_sched300`,
+  :ref:`core_ferc1__yearly_balance_sheet_assets_sched110`,
+  :ref:`core_ferc1__yearly_balance_sheet_liabilities_sched110`, and
+  :ref:`core_ferc1__yearly_operating_expenses_sched320`,
+  :ref:`core_ferc1__yearly_depreciation_changes_sched219` and
+  :ref:`core_ferc1__yearly_depreciation_by_function_sched219`. See :issue:`2016`,
   :pr:`2563`, :pr:`2662` and :pr:`2687`.
-* Changed the :ref:`core_ferc1__yearly_retained_earnings` table transform to restore
-  factoids for previous year balances, and added calculation metadata. See
+* Changed the :ref:`core_ferc1__yearly_retained_earnings_sched118` table transform to
+  restore factoids for previous year balances, and added calculation metadata. See
   :issue:`1811`, :issue:`2016`, and :pr:`2645`.
 * Added "correction" records to many FERC Form 1 tables where the reported totals do not
   match the outcomes of calculations specified in XBRL metadata (even after cleaning up
   the often incorrect calculation specifications!). See :issue:`2957` and :pr:`2620`.
 * Flip the sign of some erroneous negative values in the
-  :ref:`core_ferc1__yearly_plant_in_service` and
-  :ref:`core_ferc1__yearly_utility_plant_summary` tables. See :issue:`2599`, and
-  :pr:`2647`.
+  :ref:`core_ferc1__yearly_plant_in_service_sched204` and
+  :ref:`core_ferc1__yearly_utility_plant_summary_sched200` tables. See
+  :issue:`2599`, and :pr:`2647`.
 
 Analysis
 ^^^^^^^^