Source code for pudl.metadata.fields
"""Field metadata."""
from copy import deepcopy
from typing import Any
import pandas as pd
from pytz import all_timezones
from pudl.metadata.codes import CODE_METADATA
from pudl.metadata.constants import FIELD_DTYPES_PANDAS
from pudl.metadata.enums import (
COUNTRY_CODES_ISO3166,
CUSTOMER_CLASSES,
DIVISION_CODES_US_CENSUS,
EPACEMS_MEASUREMENT_CODES,
EPACEMS_STATES,
FUEL_CLASSES,
NERC_REGIONS,
PLANT_PARTS,
RELIABILITY_STANDARDS,
REVENUE_CLASSES,
RTO_CLASSES,
SUBDIVISION_CODES_ISO3166,
TECH_CLASSES,
TECH_DESCRIPTIONS,
)
from pudl.metadata.labels import ESTIMATED_OR_ACTUAL, FUEL_UNITS_EIA
from pudl.metadata.sources import SOURCES
# from pudl.transform.params.ferc1 import (
# PLANT_TYPE_CATEGORIES,
# PLANT_TYPE_CATEGORIES_HYDRO,
# )
[docs]
FIELD_METADATA: dict[str, dict[str, Any]] = {
"acid_gas_control": {
"type": "boolean",
"description": "Indicates whether the emissions control equipment controls acid (HCl) gas.",
},
"active": {
"type": "boolean",
"description": "Indicates whether or not the dataset has been pulled into PUDL by the extract transform load process.",
},
"actual_peak_demand_savings_mw": {"type": "number", "unit": "MW"},
"additions": {
"type": "number",
"description": "Cost of acquisition of items classified within the account.",
"unit": "USD",
},
"address_2": {"type": "string"},
"adjustments": {
"type": "number",
"description": "Cost of adjustments to the account.",
"unit": "USD",
},
"advanced_metering_infrastructure": {"type": "integer"},
"air_flow_100pct_load_cubic_feet_per_minute": {
"type": "number",
"unit": "cfm",
"description": "Total air flow including excess air at 100 percent load, reported at standard temperature and pressure (i.e. 68 F and one atmosphere pressure).",
},
"alternative_fuel_vehicle_2_activity": {"type": "boolean"},
"alternative_fuel_vehicle_activity": {"type": "boolean"},
"annual_indirect_program_cost": {"type": "number", "unit": "USD"},
"annual_total_cost": {"type": "number", "unit": "USD"},
"amount": {
"description": "Reported amount of dollars. This could be a balance or a change in value.",
"type": "number",
"unit": "USD",
},
"amount_type": {
"type": "string",
"description": "Label describing the type of amount being reported. This could be a balance or a change in value.",
},
"appro_part_label": {
"type": "string",
"description": "Plant part of the associated true granularity record.",
"constraints": {"enum": PLANT_PARTS},
},
"appro_record_id_eia": {
"type": "string",
"description": "EIA record ID of the associated true granularity record.",
},
"area_km2": {"type": "number", "description": "County area in km2.", "unit": "km2"},
"ash_content_pct": {
"type": "number",
"description": "Ash content percentage by weight to the nearest 0.1 percent.",
},
"ash_impoundment": {
"type": "boolean",
"description": "Is there an ash impoundment (e.g. pond, reservoir) at the plant?",
# TODO: Is this really boolean? Or do we have non-null strings that mean False?
},
"ash_impoundment_lined": {
"type": "boolean",
"description": "If there is an ash impoundment at the plant, is the impoundment lined?",
# TODO: Is this really boolean? Or do we have non-null strings that mean False?
},
"ash_impoundment_status": {
"type": "string",
"description": "If there is an ash impoundment at the plant, the ash impoundment status as of December 31 of the reporting year.",
},
"asset_retirement_cost": {
"type": "number",
"description": "Asset retirement cost (USD).",
"unit": "USD",
},
"asset_type": {
"type": "string",
"description": "Type of asset being reported to the balance_sheet_assets_ferc1 table.",
},
"associated_combined_heat_power": {
"type": "boolean",
"description": "Indicates whether the generator is associated with a combined heat and power system",
},
"attention_line": {"type": "string"},
"automated_meter_reading": {"type": "integer"},
"avg_customers_per_month": {
"type": "number",
"description": "Average number of customers per month.",
},
"avg_num_employees": {"type": "number"},
"backup_capacity_mw": {"type": "number", "unit": "MW"},
"balance": {
"type": "string",
"description": "Indication of whether a column is a credit or debit, as reported in the XBRL taxonomy.",
},
"balancing_authority_code_eia": {
"type": "string",
"description": "EIA short code identifying a balancing authority.",
},
"balancing_authority_code_eia_consistent_rate": {
"type": "number",
"description": "Percentage consistency of balancing authority code across entity records.",
},
"balancing_authority_id_eia": {
"type": "integer",
"description": "EIA balancing authority ID. This is often (but not always!) the same as the utility ID associated with the same legal entity.",
},
"balancing_authority_name_eia": {
"type": "string",
"description": "Name of the balancing authority.",
},
"bga_source": {
"type": "string",
"description": "The source from where the unit_id_pudl is compiled. The unit_id_pudl comes directly from EIA 860, or string association (which looks at all the boilers and generators that are not associated with a unit and tries to find a matching string in the respective collection of boilers or generator), or from a unit connection (where the unit_id_eia is employed to find additional boiler generator connections).",
},
"billing_demand_mw": {
"type": "number",
"description": "Monthly average billing demand (for requirements purchases, and any transactions involving demand charges). In megawatts.",
"unit": "MW",
},
"billing_status": {
"type": "string",
"description": (
"Whether an amount is billed, unbilled, or both. Billed amounts pertain to "
"the exchange of energy and unbilled amounts pertain to other sources of "
"revenue such as contracts with peaker plants to keep them on standby "
"or charging rent to host cell antennas on transmission towers."
),
},
"boiler_fuel_code_1": {
"type": "string",
"description": "The code representing the most predominant type of energy that fuels the boiler.",
},
"boiler_fuel_code_2": {
"type": "string",
"description": "The code representing the second most predominant type of energy that fuels the boiler.",
},
"boiler_fuel_code_3": {
"type": "string",
"description": "The code representing the third most predominant type of energy that fuels the boiler.",
},
"boiler_fuel_code_4": {
"type": "string",
"description": "The code representing the fourth most predominant type of energy that fuels the boiler.",
},
"boiler_generator_assn_type_code": {
"type": "string",
"description": (
"Indicates whether boiler associations with generator during the year were "
"actual or theoretical. Only available before 2013."
),
},
"boiler_id": {
"type": "string",
"description": "Alphanumeric boiler ID.",
},
"boiler_manufacturer": {
"type": "string",
"description": "Name of boiler manufacturer.",
},
"boiler_manufacturer_code": {
"type": "string",
"description": "EIA short code for boiler manufacturer.",
},
"boiler_operating_date": {
"type": "date",
"description": "Date the boiler began or is planned to begin commercial operation.",
},
"boiler_retirement_date": {
"type": "date",
"description": "Date of the scheduled or effected retirement of the boiler.",
},
"boiler_status": {
"type": "string",
"description": "EIA short code identifying boiler operational status.",
},
"boiler_type": {
"type": "string",
"description": "EIA short code indicating the standards under which the boiler is operating as described in the U.S. EPA regulation under 40 CFR.",
},
"bulk_agg_fuel_cost_per_mmbtu": {
"type": "number",
"description": (
"Fuel cost per mmbtu reported in the EIA bulk electricity data. This is an "
"aggregate average fuel price for a whole state, region, month, sector, "
"etc. Used to fill in missing fuel prices."
),
},
"bundled_activity": {"type": "boolean"},
"business_model": {
"type": "string",
"constraints": {"enum": ["retail", "energy_services"]},
},
"buying_distribution_activity": {"type": "boolean"},
"buying_transmission_activity": {"type": "boolean"},
"bypass_heat_recovery": {
"type": "boolean",
"description": "Can this generator operate while bypassing the heat recovery steam generator?",
},
"caidi_w_major_event_days_minutes": {"type": "number", "unit": "min"},
"caidi_w_major_event_days_minus_loss_of_service_minutes": {
"type": "number",
"unit": "min",
},
"caidi_wo_major_event_days_minutes": {"type": "number", "unit": "min"},
"capacity_eoy_mw": {
"type": "number",
"description": "Total end of year installed (nameplate) capacity for a plant part, in megawatts.",
"unit": "MW",
},
"capacity_factor": {
"type": "number",
"description": "Fraction of potential generation that was actually reported for a plant part.",
},
"capacity_factor_eia": {
"type": "number",
"description": "Fraction of potential generation that was actually reported for a plant part.",
},
"capacity_factor_ferc1": {
"type": "number",
"description": "Fraction of potential generation that was actually reported for a plant part.",
},
"capacity_mw": {
"type": "number",
"description": "Total installed (nameplate) capacity, in megawatts.",
"unit": "MW",
# TODO: Disambiguate if necessary. Does this mean different things in
# different tables? It shows up in a lot of places.
},
"capacity_mw_eia": {
"type": "number",
"description": "Total installed (nameplate) capacity, in megawatts.",
"unit": "MW",
},
"capacity_mw_ferc1": {
"type": "number",
"description": "Total installed (nameplate) capacity, in megawatts.",
"unit": "MW",
},
"capex_annual_addition": {
"type": "number",
"description": "Annual capital addition into `capex_total`.",
"unit": "USD",
},
"capex_annual_addition_rolling": {
"type": "number",
"description": "Year-to-date capital addition into `capex_total`.",
"unit": "USD",
},
"capex_annual_per_kw": {
"type": "number",
"description": "Annual capital addition into `capex_total` per kw.",
"unit": "USD_per_kw",
},
"capex_annual_per_mw": {
"type": "number",
"description": "Annual capital addition into `capex_total` per MW.",
"unit": "USD_per_MW",
},
"capex_annual_per_mw_rolling": {
"type": "number",
"description": "Year-to-date capital addition into `capex_total` per MW.",
"unit": "USD_per_MW",
},
"capex_annual_per_mwh": {
"type": "number",
"description": "Annual capital addition into `capex_total` per MWh.",
"unit": "USD_per_MWh",
},
"capex_annual_per_mwh_rolling": {
"type": "number",
"description": "Year-to-date capital addition into `capex_total` per MWh.",
"unit": "USD_per_MWh",
},
"capex_equipment": {
"type": "number",
"description": "Cost of plant: equipment (USD).",
"unit": "USD",
},
"capex_equipment_electric": {
"type": "number",
"description": "Cost of plant: accessory electric equipment (USD).",
"unit": "USD",
},
"capex_equipment_misc": {
"type": "number",
"description": "Cost of plant: miscellaneous power plant equipment (USD).",
"unit": "USD",
},
"capex_facilities": {
"type": "number",
"description": "Cost of plant: reservoirs, dams, and waterways (USD).",
"unit": "USD",
},
"capex_land": {
"type": "number",
"description": "Cost of plant: land and land rights (USD).",
"unit": "USD",
},
"capex_other": {
"type": "number",
"description": "Other costs associated with the plant (USD).",
"unit": "USD",
},
"capex_per_mw": {
"type": "number",
"description": "Cost of plant per megawatt of installed (nameplate) capacity. Nominal USD.",
"unit": "USD_per_MW",
},
"capex_roads": {
"type": "number",
"description": "Cost of plant: roads, railroads, and bridges (USD).",
"unit": "USD",
},
"capex_structures": {
"type": "number",
"description": "Cost of plant: structures and improvements (USD).",
"unit": "USD",
},
"capex_total": {
"type": "number",
"description": "Total cost of plant (USD).",
"unit": "USD",
},
"capex_wheels_turbines_generators": {
"type": "number",
"description": "Cost of plant: water wheels, turbines, and generators (USD).",
"unit": "USD",
},
"capex_wo_retirement_total": {
"type": "number",
"description": "Total cost of plant (USD) without retirements.",
"unit": "USD",
},
"carbon_capture": {
"type": "boolean",
"description": "Indicates whether the generator uses carbon capture technology.",
},
"chlorine_content_ppm": {"type": "number", "unit": "ppm"},
"circuits_with_voltage_optimization": {"type": "integer"},
"city": {
"type": "string",
# TODO: Disambiguate column. City means different things in different tables.
},
"co2_mass_measurement_code": {
"type": "string",
"description": "Identifies whether the reported value of emissions was measured, calculated, or measured and substitute.",
"constraints": {"enum": EPACEMS_MEASUREMENT_CODES},
},
"co2_mass_tons": {
"type": "number",
"description": "Carbon dioxide emissions in short tons.",
"unit": "short_ton",
},
"coal_fraction_cost": {
"type": "number",
"description": "Coal cost as a percentage of overall fuel cost.",
},
"coal_fraction_mmbtu": {
"type": "number",
"description": "Coal heat content as a percentage of overall fuel heat content (mmBTU).",
},
"coalmine_county_id_fips": {
"type": "string",
"description": (
"County ID from the Federal Information Processing Standard Publication "
"6-4. This is the county where the coal mine is located."
),
"constraints": {
"pattern": r"^\d{5}$",
},
},
"code": {
"type": "string",
"description": "Originally reported short code.",
},
"cofire_fuels": {
"type": "boolean",
"description": "Can the generator co-fire fuels?.",
},
"coincident_peak_demand_mw": {
"type": "number",
"description": "Average monthly coincident peak (CP) demand (for requirements purchases, and any transactions involving demand charges). Monthly CP demand is the metered demand during the hour (60-minute integration) in which the supplier's system reaches its monthly peak. In megawatts.",
"unit": "MW",
},
"cooling_id_eia": {
"type": "string",
"description": ("The cooling system identification number reported to EIA."),
},
"conductor_size_and_material": {
"type": "string",
"description": "Size of transmission conductor and material of the transmission line.",
},
"construction_type": {
"type": "string",
"description": "Type of plant construction ('outdoor', 'semioutdoor', or 'conventional'). Categorized by PUDL based on our best guess of intended value in FERC1 freeform strings.",
"constraints": {"enum": ["conventional", "outdoor", "semioutdoor"]},
},
"construction_year": {
"type": "integer",
"description": "Year the plant's oldest still operational unit was built.",
},
"construction_year_eia": {
"type": "integer",
"description": "Year the plant's oldest still operational unit was built.",
},
"construction_year_ferc1": {
"type": "integer",
"description": "Year the plant's oldest still operational unit was built.",
},
"consumed_by_facility_mwh": {"type": "number", "unit": "MWh"},
"consumed_by_respondent_without_charge_mwh": {"type": "number", "unit": "MWh"},
"contact_firstname": {
"type": "string",
"description": "First name of utility contact 1.",
},
"contact_firstname_2": {
"type": "string",
"description": "First name of utility contact 2.",
},
"contact_lastname": {
"type": "string",
"description": "Last name of utility contact 1.",
},
"contact_lastname_2": {
"type": "string",
"description": "Last name of utility contact 2.",
},
"contact_title": {
"type": "string",
"description": "Title of of utility contact 1.",
},
"contact_title_2": {"type": "string", "description": "Title of utility contact 2."},
"contract_expiration_date": {
"type": "date",
"description": "Date contract expires.Format: MMYY.",
},
"contract_type_code": {
"type": "string",
"description": "Purchase type under which receipts occurred in the reporting month. C: Contract, NC: New Contract, S: Spot Purchase, T: Tolling Agreement.",
"constraints": {"enum": ["S", "C", "NC", "T"]},
},
"country": {"type": "string", "description": "Three letter country abbreviation."},
"emission_control_id_eia": {
"type": "string",
"description": (
"The emission control ID used to collect so2, nox, particulate, "
"and mercury emissions data. This column should be used in conjunction "
"with emissions_control_type as it's not guaranteed to be unique."
),
},
"emission_control_id_pudl": {
"type": "number",
"description": "A PUDL-generated ID used to distinguish emission control units in the same report year and plant id. This ID should not be used to track units over time or between plants.",
},
"emission_control_id_type": {
"type": "string",
"description": "The type of emissions control id: so2, nox, particulate, or mercury.",
},
"compliance_year_nox": {
"type": "integer",
"description": "Year boiler was or is expected to be in compliance with federal, state and/or local regulations for nitrogen oxide emissions.",
},
"compliance_year_mercury": {
"type": "integer",
"description": "Year boiler was or is expected to be in compliance with federal, state and/or local regulations for mercury emissions.",
},
"compliance_year_particulate": {
"type": "integer",
"description": "Year boiler was or is expected to be in compliance with federal, state and/or local regulations for particulate matter emissions.",
},
"compliance_year_so2": {
"type": "integer",
"description": "Year boiler was or is expected to be in compliance with federal, state and/or local regulations for sulfur dioxide emissions.",
},
"county": {"type": "string", "description": "County name."},
"county_id_fips": {
"type": "string",
"description": "County ID from the Federal Information Processing Standard Publication 6-4.",
"constraints": {
"pattern": r"^\d{5}$",
},
},
"county_name_census": {
"type": "string",
"description": "County name as specified in Census DP1 Data.",
},
"country_code": {
"type": "string",
"description": "Three letter ISO-3166 country code (e.g. USA or CAN).",
"constraints": {"enum": COUNTRY_CODES_ISO3166},
},
"country_name": {
"type": "string",
"description": "Full country name (e.g. United States of America).",
},
"credits_or_adjustments": {"type": "number"},
"critical_peak_pricing": {"type": "boolean"},
"critical_peak_rebate": {"type": "boolean"},
"current_planned_generator_operating_date": {
"type": "date",
"description": "The most recently updated effective date on which the generator is scheduled to start operation",
},
"customer_class": {
"type": "string",
"description": "High level categorization of customer type.",
"constraints": {"enum": CUSTOMER_CLASSES},
},
"customer_incentives_cost": {"type": "number"},
"customer_incentives_incremental_cost": {"type": "number"},
"customer_incentives_incremental_life_cycle_cost": {"type": "number"},
"customer_other_costs_incremental_life_cycle_cost": {"type": "number"},
"customers": {"description": "Number of customers.", "type": "number"},
"daily_digital_access_customers": {"type": "integer"},
"data_observed": {
"type": "boolean",
"description": "Is the value observed (True) or imputed (False).",
},
"data_maturity": {
"type": "string",
"description": "Level of maturity of the data record. Some data sources report less-than-final data. PUDL sometimes includes this data, but use at your own risk.",
},
"datasource": {
"type": "string",
"description": "Code identifying a dataset available within PUDL.",
"constraints": {"enum": list(SOURCES)},
},
"datum": {
"type": "string",
"description": "Geodetic coordinate system identifier (e.g. NAD27, NAD83, or WGS84).",
},
"account_detail": {
"type": "string",
"description": "Description of the account number credited from making debit adjustment to other regulatory liabilities.",
},
"decrease_in_other_regulatory_liabilities": {
"type": "number",
"description": "The decrease during the reporting period of other regulatory liabilities.",
"unit": "USD",
},
"deliver_power_transgrid": {
"type": "boolean",
"description": "Indicate whether the generator can deliver power to the transmission grid.",
},
"delivered_mwh": {
"type": "number",
"description": "Gross megawatt-hours delivered in power exchanges and used as the basis for settlement.",
"unit": "MWh",
},
"delivery_customers": {"type": "number"},
"demand_annual_mwh": {"type": "number", "unit": "MWh"},
"demand_annual_per_capita_mwh": {
"type": "number",
"description": "Per-capita annual demand, averaged using Census county-level population estimates.",
"unit": "MWh/person",
},
"demand_charges": {
"type": "number",
"description": "Demand charges (USD).",
"unit": "USD",
},
"demand_mwh": {"type": "number", "unit": "MWh"},
"demand_density_mwh_km2": {
"type": "number",
"description": "Annual demand per km2 of a given service territory.",
"unit": "MWh/km2",
},
"depreciation_type": {
"type": "string",
"description": (
"Type of depreciation provision within FERC Account 108, including cost of"
"removal, depreciation expenses, salvage, cost of retired plant, etc."
),
},
"depreciation_amortization_value": {
"type": "number",
"unit": "USD",
"description": "Depreciation and amortization values (USD).",
},
"description": {
"type": "string",
"description": "Long human-readable description of the meaning of a code/label.",
},
"designed_voltage_kv": {
"type": "number",
"description": "Manufactured (Designed) voltage, expressed in kilo-volts, for three-phase 60 cycle alternative current transmission lines",
"unit": "KV",
},
"direct_load_control_customers": {"type": "integer"},
"distributed_generation": {
"type": "boolean",
"description": "Whether the generator is considered distributed generation",
},
"distributed_generation_owned_capacity_mw": {"type": "number", "unit": "MW"},
"distribution_activity": {"type": "boolean"},
"distribution_circuits": {"type": "integer"},
"division_code_us_census": {
"type": "string",
"description": (
"Three-letter US Census division code as it appears in the bulk "
"electricity data published by the EIA. Note that EIA splits the Pacific "
"division into distinct contiguous (CA, OR, WA) and non-contiguous (AK, "
"HI) states. For reference see this US Census region and division map: "
"https://www2.census.gov/geo/pdfs/maps-data/maps/reference/us_regdiv.pdf"
),
"constraints": {"enum": DIVISION_CODES_US_CENSUS},
},
"division_name_us_census": {
"type": "string",
"description": "Longer human readable name describing the US Census division.",
},
"doi": {
"type": "string",
"description": "Unique digitial object identifier of Zenodo archive.",
},
"dollar_value": {
"type": "number",
"description": "Dollar value of reported income, expense, asset, or liability.",
"unit": "USD",
},
"duct_burners": {
"type": "boolean",
"description": "Indicates whether the unit has duct-burners for supplementary firing of the turbine exhaust gas",
},
"earnings_type": {
"type": "string",
"description": "Label describing types of earnings.",
},
"efficiency_100pct_load": {
"type": "number",
"description": "Boiler efficiency percentage when burning at 100 percent load to the nearest 0.1 percent.",
},
"efficiency_50pct_load": {
"type": "number",
"description": "Boiler efficiency percentage when burning at 50 percent load to the nearest 0.1 percent.",
},
"eia_code": {
"type": "integer",
"description": (
"EIA utility or balancing area authority ID associated with this FERC Form "
"714 respondent. Note that many utilities are also balancing authorities "
"and in many cases EIA uses the same integer ID to identify a utility in "
"its role as a balancing authority AND as a utility, but there is no "
"requirement that these IDs be the same, and in a number of cases they are "
"different."
),
},
"electric_plant": {
"type": "number",
"description": "Electric Plant In Service (USD).",
"unit": "USD",
},
"emission_control_equipment_cost": {
"type": "number",
"description": "The total cost to install a piece of emission control equipment.",
"unit": "USD",
},
"emission_control_equipment_type_code": {
"type": "string",
"description": "Short code indicating the type of emission control equipment installed.",
},
"emission_control_operating_date": {
"type": "date",
"description": "The date a piece of emissions control equipment began operating. Derived from month and year columns in the raw data.",
},
"emission_control_retirement_date": {
"type": "date",
"description": "The expected or actual retirement date for a piece of emissions control equipment. Derived from month and year columns in the raw data.",
},
"emissions_unit_id_epa": {
"type": "string",
"description": "Emissions (smokestack) unit monitored by EPA CEMS.",
},
"end_point": {
"type": "string",
"description": "The end point of a transmission line.",
},
"ending_balance": {
"type": "number",
"description": "Account balance at end of year.",
"unit": "USD",
},
"energy_charges": {
"type": "number",
"description": "Energy charges (USD).",
"unit": "USD",
},
"energy_displaced_mwh": {"type": "number", "unit": "MWh"},
"energy_disposition_type": {
"type": "string",
"description": "Type of energy disposition reported in the electric_energy_dispositions_ferc1. Dispositions include sales to customers, re-sales of energy, energy used internally, losses, etc.",
},
"energy_efficiency_annual_actual_peak_reduction_mw": {
"type": "number",
"unit": "MW",
},
"energy_efficiency_annual_cost": {"type": "number"},
"energy_efficiency_annual_effects_mwh": {"type": "number", "unit": "MWh"},
"energy_efficiency_annual_incentive_payment": {"type": "number"},
"energy_efficiency_incremental_actual_peak_reduction_mw": {
"type": "number",
"unit": "MW",
},
"energy_efficiency_incremental_effects_mwh": {"type": "number", "unit": "MWh"},
"energy_mwh": {
"type": "number",
"unit": "MWh",
"description": "Sources and uses of energy in MWh.",
},
"energy_savings_estimates_independently_verified": {"type": "boolean"},
"energy_savings_independently_verified": {"type": "boolean"},
"energy_savings_mwh": {"type": "number", "unit": "MWh"},
"energy_served_ami_mwh": {"type": "number", "unit": "MWh"},
"energy_source": {"type": "string"},
"energy_source_code": {
"type": "string",
"description": (
"A 2-3 letter code indicating the energy source (e.g. fuel type) "
"associated with the record."
),
},
"energy_source_code_num": {
"type": "string",
"description": (
"Name of the energy_source_code_N column that this energy source code was "
"reported in for the generator referenced in the same record."
),
"constraints": {
"enum": sorted({f"energy_source_code_{n}" for n in range(1, 9)})
},
},
"energy_source_1_transport_1": {
"type": "string",
"description": "Primary mode of transport for energy source 1.",
},
"energy_source_1_transport_2": {
"type": "string",
"description": "Secondary mode of transport for energy source 1.",
},
"energy_source_1_transport_3": {
"type": "string",
"description": "Tertiary mode of transport for energy source 1.",
},
"energy_source_2_transport_1": {
"type": "string",
"description": "Primary mode of transport for energy source 2.",
},
"energy_source_2_transport_2": {
"type": "string",
"description": "Secondary mode of transport for energy source 2.",
},
"energy_source_2_transport_3": {
"type": "string",
"description": "Tertiary mode of transport for energy source 2.",
},
"energy_source_code_1": {
"type": "string",
"description": "The code representing the most predominant type of energy that fuels the generator.",
},
"energy_source_code_2": {
"type": "string",
"description": "The code representing the second most predominant type of energy that fuels the generator",
},
"energy_source_code_3": {
"type": "string",
"description": "The code representing the third most predominant type of energy that fuels the generator",
},
"energy_source_code_4": {
"type": "string",
"description": "The code representing the fourth most predominant type of energy that fuels the generator",
},
"energy_source_code_5": {
"type": "string",
"description": "The code representing the fifth most predominant type of energy that fuels the generator",
},
"energy_source_code_6": {
"type": "string",
"description": "The code representing the sixth most predominant type of energy that fuels the generator",
},
"energy_source_type": {
"type": "string",
"description": "Type of energy source reported in the electric_energy_sources_ferc1 table. There are three groups of energy sources: generation, power exchanges and transmission.",
},
"energy_storage": {
"type": "boolean",
"description": "Indicates if the facility has energy storage capabilities.",
# TODO: Is this really boolean? Or do we have non-null strings that mean False?
},
"energy_storage_capacity_mwh": {
"type": "number",
"description": "Energy storage capacity in MWh (e.g. for batteries).",
"unit": "MWh",
},
"energy_used_for_pumping_mwh": {
"type": "number",
"description": "Energy used for pumping, in megawatt-hours.",
"unit": "MWh",
},
"entity_type": {
"type": "string",
"description": "Entity type of principal owner.",
},
"environmental_equipment_name": {
"type": "string",
"description": "Name of environmental equipment or technology type used to control air emissions",
},
"estimated_or_actual_capacity_data": {
"type": "string",
"constraints": {"enum": list(ESTIMATED_OR_ACTUAL.values())},
},
"estimated_or_actual_fuel_data": {
"type": "string",
"constraints": {"enum": list(ESTIMATED_OR_ACTUAL.values())},
},
"estimated_or_actual_tech_data": {
"type": "string",
"constraints": {"enum": list(ESTIMATED_OR_ACTUAL.values())},
},
"exchange_energy_delivered_mwh": {"type": "number", "unit": "MWh"},
"exchange_energy_received_mwh": {"type": "number", "unit": "MWh"},
"expense": {
"type": "number",
"unit": "USD",
"description": "The amount of a given expense in USD.",
},
"expense_type": {"type": "string", "description": "The type of expense."},
"ferc1_generator_agg_id": {
"type": "integer",
"description": "ID dynamically assigned by PUDL to EIA records with multiple matches to a single FERC ID in the FERC-EIA manual matching process.",
},
"ferc_account": {
"type": "string",
"description": "Actual FERC Account number (e.g. '359.1') if available, or a PUDL assigned ID when FERC accounts have been split or combined in reporting.",
},
"ferc_account_description": {"type": "string"},
"ferc_account_id": {
"type": "string",
"description": "Account identifier from FERC's Uniform System of Accounts for Electric Plant. Includes higher level labeled categories.",
},
"ferc_account_label": {
"type": "string",
"description": "Long FERC account identifier derived from values reported in the XBRL taxonomies. May also refer to aggregations of individual FERC accounts.",
},
"ferc_acct_name": {
"type": "string",
"description": "Name of FERC account, derived from technology description and prime mover code.",
"constraints": {"enum": ["Hydraulic", "Nuclear", "Steam", "Other"]},
},
"ferc_cogen_docket_no": {
"type": "string",
"description": "The docket number relating to the FERC cogenerator status. See FERC Form 556.",
},
"ferc_cogen_status": {
"type": "boolean",
"description": "Indicates whether the plant has FERC qualifying facility cogenerator status. See FERC Form 556.",
# TODO: Is this really boolean? Or do we have non-null strings that mean False?
},
"ferc_exempt_wholesale_generator": {
"type": "boolean",
"description": "Indicates whether the plant has FERC qualifying facility exempt wholesale generator status",
# TODO: Is this really boolean? Or do we have non-null strings that mean False?
},
"ferc_exempt_wholesale_generator_docket_no": {
"type": "string",
"description": "The docket number relating to the FERC qualifying facility exempt wholesale generator status.",
},
"ferc_license_id": {
"type": "string",
"description": "The FERC license ID of a project.",
},
"ferc_small_power_producer": {
"type": "boolean",
"description": "Indicates whether the plant has FERC qualifying facility small power producer status. See FERC Form 556.",
},
"ferc_small_power_producer_docket_no": {
"type": "string",
"description": "The docket number relating to the FERC qualifying facility small power producer status. See FERC Form 556.",
},
"ferc_qualifying_facility_docket_no": {
"type": "string",
"description": "The docket number relating to the FERC qualifying facility cogenerator status. See FERC Form 556.",
},
"ferc_qualifying_facility": {
"type": "boolean",
"description": "Indicatates whether or not a generator is a qualifying FERC cogeneation facility.",
},
"firing_rate_using_coal_tons_per_hour": {
"type": "number",
"unit": "tons_per_hour",
"description": "Design firing rate at maximum continuous steam flow for coal to the nearest 0.1 ton per hour.",
},
"firing_rate_using_gas_mcf_per_hour": {
"type": "number",
"unit": "mcf_per_hour",
"description": "Design firing rate at maximum continuous steam flow for gas to the nearest 0.1 cubic feet per hour.",
},
"firing_rate_using_oil_bbls_per_hour": {
"type": "number",
"unit": "bbls_per_hour",
"description": "Design firing rate at maximum continuous steam flow for pet coke to the nearest 0.1 barrels per hour.",
},
"firing_rate_using_other_fuels": {
"type": "number", # TO DO: unit not in layout files, how to ID?
"description": "Design firing rate at maximum continuous steam flow for energy sources other than coal, petroleum, or natural gas.",
},
"firing_type_1": {
"type": "string",
"description": "EIA short code indicating the type of firing used by this boiler.",
},
"firing_type_2": {
"type": "string",
"description": "EIA short code indicating the type of firing used by this boiler.",
},
"firing_type_3": {
"type": "string",
"description": "EIA short code indicating the type of firing used by this boiler.",
},
"flue_id_eia": {
"type": "string",
"description": (
"The flue identification value reported to EIA. The flue is a duct, pipe, "
"or opening that transports exhast gases through the stack. This field was "
"reported in conjunction with stack_id_eia until 2013 when "
"stack_flue_id_eia took their place."
),
},
"fluidized_bed_tech": {
"type": "boolean",
"description": "Indicates whether the generator uses fluidized bed technology",
},
"fly_ash_reinjection": {
"type": "boolean",
"description": "Indicates whether the boiler is capable of re-injecting fly ash.",
},
"fraction_owned": {
"type": "number",
"description": "Proportion of generator ownership attributable to this utility.",
},
"fuel_agg": {
"type": "string",
"description": "Category of fuel aggregation in EIA bulk electricity data.",
},
"fuel_class": {
"type": "string",
# TODO: Needs a description / better name. EIA-861 distributed generation only.
"constraints": {"enum": FUEL_CLASSES},
},
"fuel_consumed_for_electricity_mmbtu": {
"type": "number",
"description": "Total consumption of fuel to produce electricity, in physical unit, year to date.",
"unit": "MMBtu",
},
"fuel_consumed_for_electricity_units": {
"type": "number",
"description": "Consumption for electric generation of the fuel type in physical unit.",
},
"fuel_consumed_mmbtu": {
"type": "number",
"description": "Total consumption of fuel in physical unit, year to date. Note: this is the total quantity consumed for both electricity and, in the case of combined heat and power plants, process steam production.",
"unit": "MMBtu",
},
"fuel_consumed_total_cost": {
"type": "number",
"description": "Total cost of consumed fuel.",
"unit": "USD",
},
"fuel_consumed_units": {
"type": "number",
"description": "Consumption of the fuel type in physical unit. Note: this is the total quantity consumed for both electricity and, in the case of combined heat and power plants, process steam production.",
},
"fuel_cost": {
"type": "number",
"description": "Total fuel cost for plant (in $USD).",
"unit": "USD",
},
"fuel_cost_from_eiaapi": {
"type": "boolean",
"description": "Indicates whether the fuel cost was derived from the EIA API.",
},
"fuel_mmbtu": {
"type": "number",
"description": "Total heat content for plant (in MMBtu).",
"unit": "MMBtu",
},
"fuel_cost_per_mmbtu": {
"type": "number",
"description": "Average fuel cost per mmBTU of heat content in nominal USD.",
"unit": "USD_per_MMBtu",
},
"fuel_cost_per_mmbtu_eia": {
"type": "number",
"description": "Average fuel cost per mmBTU of heat content in nominal USD.",
"unit": "USD_per_MMBtu",
},
"fuel_cost_per_mmbtu_ferc1": {
"type": "number",
"description": "Average fuel cost per mmBTU of heat content in nominal USD.",
"unit": "USD_per_MMBtu",
},
"fuel_cost_per_mwh": {
"type": "number",
"description": "Derived from MCOE, a unit level value. Average fuel cost per MWh of heat content in nominal USD.",
"unit": "USD_per_MWh",
},
"fuel_cost_per_mwh_eia": {
"type": "number",
"description": "Derived from MCOE, a unit level value. Average fuel cost per MWh of heat content in nominal USD.",
"unit": "USD_per_MWh",
},
"fuel_cost_per_mwh_ferc1": {
"type": "number",
"description": "Derived from MCOE, a unit level value. Average fuel cost per MWh of heat content in nominal USD.",
"unit": "USD_per_MWh",
},
"fuel_cost_per_unit_burned": {
"type": "number",
"description": "Average cost of fuel consumed in the report year per reported fuel unit (USD).",
"unit": "USD",
},
"fuel_cost_per_unit_delivered": {
"type": "number",
"description": "Average cost of fuel delivered in the report year per reported fuel unit (USD).",
"unit": "USD",
},
"fuel_derived_from": {
"type": "string",
"description": "Original fuel from which this refined fuel was derived.",
"constraints": {
"enum": sorted(
set(CODE_METADATA["energy_sources_eia"]["df"]["fuel_derived_from"])
)
},
},
"fuel_group_code": {
"type": "string",
"description": "Fuel groups used in the Electric Power Monthly",
"constraints": {
"enum": ["petroleum", "other_gas", "petroleum_coke", "natural_gas", "coal"]
},
},
"fuel_group_eia": {
"type": "string",
"description": "High level fuel group defined in the 2021-2023 EIA Form 860 instructions, Table 28.",
"constraints": {
"enum": sorted(
set(CODE_METADATA["energy_sources_eia"]["df"]["fuel_group_eia"])
)
},
},
"fuel_mmbtu_per_unit": {
"type": "number",
"description": "Heat content of the fuel in millions of Btus per physical unit.",
"unit": "MMBtu_per_unit",
},
"fuel_pct": {"type": "number"},
"fuel_phase": {
"type": "string",
"description": "Physical phase of matter of the fuel.",
"constraints": {
"enum": sorted(
set(CODE_METADATA["energy_sources_eia"]["df"]["fuel_phase"].dropna())
)
},
},
"fuel_received_mmbtu": {
"type": "number",
"description": "Aggregated fuel receipts, in MMBtu, in EIA bulk electricity data.",
"unit": "MMBtu",
},
"fuel_received_units": {
"type": "number",
"description": "Quanity of fuel received in tons, barrel, or Mcf.",
},
"fuel_type": {
"type": "string",
# TODO disambiguate column name. This should be just FERC 1 tables, as the EIA
# fuel types are now all energy_source_code
},
"fuel_type_code_aer": {
"type": "string",
"description": "A partial aggregation of the reported fuel type codes into larger categories used by EIA in, for example, the Annual Energy Review (AER). Two or three letter alphanumeric.",
},
"fuel_type_code_pudl": {
"type": "string",
"description": "Simplified fuel type code used in PUDL",
"constraints": {
"enum": sorted(
set(CODE_METADATA["energy_sources_eia"]["df"].fuel_type_code_pudl)
)
},
},
"fuel_type_code_pudl_eia": {
"type": "string",
"description": "Simplified fuel type code used in PUDL",
"constraints": {
"enum": sorted(
set(CODE_METADATA["energy_sources_eia"]["df"].fuel_type_code_pudl)
)
},
},
"fuel_type_code_pudl_ferc1": {
"type": "string",
"description": "Simplified fuel type code used in PUDL",
"constraints": {
"enum": sorted(
set(CODE_METADATA["energy_sources_eia"]["df"].fuel_type_code_pudl)
)
},
},
"fuel_type_count": {
"type": "integer",
"description": "A count of how many different simple energy sources there are associated with a generator.",
},
"fuel_units": {
"type": "string",
"description": "Reported unit of measure for fuel.",
# Note: Different ENUM constraints are applied below on EIA vs. FERC1
},
"furnished_without_charge_mwh": {"type": "number", "unit": "MWh"},
"future_plant": {
"type": "number",
"description": "Electric Plant Held for Future Use (USD).",
"unit": "USD",
},
"gas_fraction_cost": {
"type": "number",
"description": "Natural gas cost as a percentage of overall fuel cost.",
},
"gas_fraction_mmbtu": {
"type": "number",
"description": "Natural gas heat content as a percentage of overall fuel heat content (MMBtu).",
},
"generation_activity": {"type": "boolean"},
"generator_id": {
"type": "string",
"description": (
"Generator ID is usually numeric, but sometimes includes letters. Make "
"sure you treat it as a string!"
),
},
"generator_id_epa": {
"type": "string",
"description": "Generator ID used by the EPA.",
},
"generators_num_less_1_mw": {"type": "number", "unit": "MW"},
"generators_number": {"type": "number"},
"generator_operating_date": {
"type": "date",
"description": "Date the generator began commercial operation.",
},
"generator_operating_year": {
"type": "integer",
"description": "Year a generator went into service.",
},
"generator_retirement_date": {
"type": "date",
"description": "Date of the scheduled or effected retirement of the generator.",
},
"geo_agg": {
"type": "string",
"description": "Category of geographic aggregation in EIA bulk electricity data.",
},
"green_pricing_revenue": {"type": "number", "unit": "USD"},
"grid_voltage_1_kv": {
"type": "number",
"description": "Plant's grid voltage at point of interconnection to transmission or distibution facilities",
"unit": "kV",
},
"grid_voltage_2_kv": {
"type": "number",
"description": "Plant's grid voltage at point of interconnection to transmission or distibution facilities",
"unit": "kV",
},
"grid_voltage_3_kv": {
"type": "number",
"description": "Plant's grid voltage at point of interconnection to transmission or distibution facilities",
"unit": "kV",
},
"gross_load_mw": {
"type": "number",
"description": "Average power in megawatts delivered during time interval measured.",
"unit": "MW",
},
"heat_content_mmbtu": {
"type": "number",
"description": "The energy contained in fuel burned, measured in million BTU.",
"unit": "MMBtu",
},
"heat_rate_mmbtu_mwh": {
"type": "number",
"description": "Fuel content per unit of electricity generated. Coming from MCOE calculation.",
"unit": "MMBtu_MWh",
},
"heat_rate_mmbtu_mwh_eia": {
"type": "number",
"description": "Fuel content per unit of electricity generated. Coming from MCOE calculation.",
"unit": "MMBtu_MWh",
},
"heat_rate_mmbtu_mwh_ferc1": {
"type": "number",
"description": "Fuel content per unit of electricity generated. Calculated from FERC reported fuel consumption and net generation.",
"unit": "MMBtu_MWh",
},
"highest_distribution_voltage_kv": {"type": "number", "unit": "kV"},
"home_area_network": {"type": "integer"},
"hrsg": {
"type": "boolean",
"description": "indicates if the boiler is a heat recovery steam generator (HRSG).",
},
"inactive_accounts_included": {"type": "boolean"},
"income_type": {
"type": "string",
"description": "Type of income reported in income_statement_ferc1 table.",
},
"income": {
"type": "number",
"description": "Utility income reported by income type.",
"unit": "USD",
},
"increase_in_other_regulatory_liabilities": {
"type": "number",
"description": "The increase during the reporting period of other regulatory liabilities.",
"unit": "USD",
},
"incremental_energy_savings_mwh": {"type": "number", "unit": "MWh"},
"incremental_life_cycle_energy_savings_mwh": {"type": "number", "unit": "MWh"},
"incremental_life_cycle_peak_reduction_mwh": {"type": "number", "unit": "MWh"},
"incremental_peak_reduction_mw": {"type": "number", "unit": "MW"},
"installation_year": {
"type": "integer",
"description": "Year the plant's most recently built unit was installed.",
},
"installation_year_eia": {
"type": "integer",
"description": "Year the plant's most recently built unit was installed.",
},
"installation_year_ferc1": {
"type": "integer",
"description": "Year the plant's most recently built unit was installed.",
},
"is_epacems_state": {
"type": "boolean",
"description": (
"Indicates whether the associated state reports data within the EPA's "
"Continuous Emissions Monitoring System."
),
},
"is_total": {
"type": "boolean",
"description": "Indicates whether the row is a total.",
},
"iso_rto_code": {
"type": "string",
"description": "The code of the plant's ISO or RTO. NA if not reported in that year.",
},
"kwh_per_customer": {"type": "number", "description": "kwh per customer."},
"label": {
"type": "string",
"description": "Longer human-readable code using snake_case",
},
"latitude": {
"type": "number",
"description": "Latitude of the plant's location, in degrees.",
},
"leased_plant": {
"type": "number",
"description": "Electric Plant Leased to Others (USD).",
"unit": "USD",
},
"liability_type": {
"type": "string",
"description": "Type of liability being reported to the balance_sheet_liabilities_ferc1 table.",
},
"license_id_ferc1": {
"type": "integer",
"description": "FERC issued operating license ID for the facility, if available. This value is extracted from the original plant name where possible.",
},
"line_id": {
"type": "string",
"description": "A human readable string uniquely identifying the FERC depreciation account. Used in lieu of the actual line number, as those numbers are not guaranteed to be consistent from year to year.",
# TODO disambiguate column name
},
"liquefied_natural_gas_storage": {
"type": "boolean",
"description": "Indicates if the facility have the capability to store the natural gas in the form of liquefied natural gas.",
# TODO: Is this really boolean? Or do we have non-null strings that mean False?
},
"load_management_annual_actual_peak_reduction_mw": {"type": "number", "unit": "MW"},
"load_management_annual_cost": {"type": "number"},
"load_management_annual_effects_mwh": {"type": "number", "unit": "MWh"},
"load_management_annual_incentive_payment": {"type": "number"},
"load_management_annual_potential_peak_reduction_mw": {
"type": "number",
"unit": "MW",
},
"load_management_incremental_actual_peak_reduction_mw": {
"type": "number",
"unit": "MW",
},
"load_management_incremental_effects_mwh": {"type": "number", "unit": "MWh"},
"load_management_incremental_potential_peak_reduction_mw": {
"type": "number",
"unit": "MW",
},
"longitude": {
"type": "number",
"description": "Longitude of the plant's location, in degrees.",
},
"major_program_changes": {"type": "boolean"},
"match_type": {
"type": "string",
"description": "Indicates the source and validation of the match between EIA and FERC. Match types include matches was generated from the model, verified by the training data, overridden by the training data, etc.",
},
"max_fuel_mmbtu_per_unit": {
"type": "number",
"description": "Maximum heat content per physical unit of fuel in MMBtu.",
"unit": "MMBtu",
},
"max_steam_flow_1000_lbs_per_hour": {
"type": "number",
"unit": "1000_lbs_per_hour",
"description": "Maximum continuous steam flow at 100 percent load.",
},
"mercury_content_ppm": {
"type": "number",
"description": "Mercury content in parts per million (ppm) to the nearest 0.001 ppm.",
"unit": "ppm",
},
"mercury_control_existing_strategy_1": {
"type": "string",
"description": "Existing strategy to comply with the most stringent mercury regulation.",
},
"mercury_control_existing_strategy_2": {
"type": "string",
"description": "Existing strategy to comply with the most stringent mercury regulation.",
},
"mercury_control_existing_strategy_3": {
"type": "string",
"description": "Existing strategy to comply with the most stringent mercury regulation.",
},
"mercury_control_existing_strategy_4": {
"type": "string",
"description": "Existing strategy to comply with the most stringent mercury regulation.",
},
"mercury_control_existing_strategy_5": {
"type": "string",
"description": "Existing strategy to comply with the most stringent mercury regulation.",
},
"mercury_control_existing_strategy_6": {
"type": "string",
"description": "Existing strategy to comply with the most stringent mercury regulation.",
},
"mercury_control_id_eia": {
"type": "string",
"description": "Mercury control identification number. This ID is not a unique identifier.",
},
"mercury_control_proposed_strategy_1": {
"type": "string",
"description": "Proposed strategy to comply with the most stringent mercury regulation.",
},
"mercury_control_proposed_strategy_2": {
"type": "string",
"description": "Proposed strategy to comply with the most stringent mercury regulation.",
},
"mercury_control_proposed_strategy_3": {
"type": "string",
"description": "Proposed strategy to comply with the most stringent mercury regulation.",
},
"merge_address": {"type": "string"},
"merge_city": {"type": "string"},
"merge_company": {"type": "string"},
"merge_date": {"type": "date"},
"merge_state": {
"type": "string",
"description": "Two letter US state abbreviations and three letter ISO-3166-1 country codes for international mines.",
# TODO: Add ENUM constraint.
},
"min_fuel_mmbtu_per_unit": {
"type": "number",
"description": "Minimum heat content per physical unit of fuel in MMBtu.",
"unit": "MMBtu",
},
"mine_id_msha": {"type": "integer", "description": "MSHA issued mine identifier."},
"mine_id_pudl": {
"type": "integer",
"description": "Dynamically assigned PUDL mine identifier.",
},
"mine_name": {"type": "string", "description": "Coal mine name."},
"mine_state": {
"type": "string",
"description": "State where the coal mine is located. Two letter abbreviation.",
},
"mine_type_code": {
"type": "string",
"description": "Type of coal mine.",
},
"minimum_load_mw": {
"type": "number",
"description": "The minimum load at which the generator can operate at continuosuly.",
"unit": "MW",
},
"fuel_transportation_mode": {"type": "string"},
"moisture_content_pct": {"type": "number"},
"momentary_interruption_definition": {
"type": "string",
},
"month": {"type": "integer", "description": "Month of the year"},
"multiple_fuels": {
"type": "boolean",
"description": "Can the generator burn multiple fuels?",
},
"nameplate_power_factor": {
"type": "number",
"description": "The nameplate power factor of the generator.",
},
"natural_gas_delivery_contract_type_code": {
"type": "string",
"description": "Contract type for natrual gas delivery service:",
"constraints": {"enum": ["firm", "interruptible"]},
},
"natural_gas_local_distribution_company": {
"type": "string",
"description": "Names of Local Distribution Company (LDC), connected to natural gas burning power plants.",
},
"natural_gas_pipeline_name_1": {
"type": "string",
"description": "The name of the owner or operator of natural gas pipeline that connects directly to this facility or that connects to a lateral pipeline owned by this facility.",
},
"natural_gas_pipeline_name_2": {
"type": "string",
"description": "The name of the owner or operator of natural gas pipeline that connects directly to this facility or that connects to a lateral pipeline owned by this facility.",
},
"natural_gas_pipeline_name_3": {
"type": "string",
"description": "The name of the owner or operator of natural gas pipeline that connects directly to this facility or that connects to a lateral pipeline owned by this facility.",
},
"natural_gas_storage": {
"type": "boolean",
"description": "Indicates if the facility have on-site storage of natural gas.",
# TODO: Is this really boolean? Or do we have non-null strings that mean False?
},
"natural_gas_transport_code": {
"type": "string",
"description": "Contract type for natural gas transportation service.",
"constraints": {"enum": ["firm", "interruptible"]},
},
"nerc_region": {
"type": "string",
"description": "NERC region in which the plant is located",
"constraints": {"enum": NERC_REGIONS},
},
"nerc_regions_of_operation": {
"type": "string",
"constraints": {"enum": NERC_REGIONS},
},
"net_capacity_adverse_conditions_mw": {
"type": "number",
"description": "Net plant capability under the least favorable operating conditions, in megawatts.",
"unit": "MW",
},
"net_capacity_favorable_conditions_mw": {
"type": "number",
"description": "Net plant capability under the most favorable operating conditions, in megawatts.",
"unit": "MW",
},
"net_capacity_mwdc": {
"type": "number",
"description": (
"Generation capacity in megawatts of direct current that is subject to a "
"net metering agreement. Typically used for behind-the-meter solar PV."
),
"unit": "MW",
},
"net_generation_mwh": {
"type": "number",
"description": "Net electricity generation for the specified period in megawatt-hours (MWh).",
"unit": "MWh",
# TODO: disambiguate as this column means something different in
# generation_fuel_eia923:
# "description": "Net generation, year to date in megawatthours (MWh). This is total electrical output net of station service. In the case of combined heat and power plants, this value is intended to include internal consumption of electricity for the purposes of a production process, as well as power put on the grid.",
},
"net_generation_mwh_eia": {
"type": "number",
"description": "Net electricity generation for the specified period in megawatt-hours (MWh).",
"unit": "MWh",
},
"net_generation_mwh_ferc1": {
"type": "number",
"description": "Net electricity generation for the specified period in megawatt-hours (MWh).",
"unit": "MWh",
},
"net_load_mwh": {
"type": "number",
"description": "Net output for load (net generation - energy used for pumping) in megawatt-hours.",
"unit": "MWh",
},
"net_metering": {
"type": "boolean",
"description": "Did this plant have a net metering agreement in effect during the reporting year? (Only displayed for facilities that report the sun or wind as an energy source). This field was only reported up until 2015",
# TODO: Is this really boolean? Or do we have non-null strings that mean False?
},
"net_power_exchanged_mwh": {"type": "number", "unit": "MWh"},
"net_wheeled_power_mwh": {"type": "number", "unit": "MWh"},
"new_parent": {"type": "string"},
"new_source_review": {
"type": "boolean",
"description": "Indicates whether the boiler is subject to New Source Review requirements.",
},
"new_source_review_date": {
"type": "date",
"description": "Month of issued New Source Review permit.",
},
"new_source_review_permit": {
"type": "string",
"description": "New Source Review permit number.",
},
"non_amr_ami": {"type": "integer"},
"non_coincident_peak_demand_mw": {
"type": "number",
"description": "Average monthly non-coincident peak (NCP) demand (for requirements purhcases, and any transactions involving demand charges). Monthly NCP demand is the maximum metered hourly (60-minute integration) demand in a month. In megawatts.",
"unit": "MW",
},
"notes": {
"type": "string",
"description": "Notes previously in the plant_name_ferc1 field that were extracted and associated with the right plant row.",
},
"not_water_limited_capacity_mw": {
"type": "number",
"description": "Plant capacity in MW when not limited by condenser water.",
"unit": "MW",
},
"nox_control_existing_caaa_compliance_strategy_1": {
"type": "string",
"description": "Existing strategies to meet the nitrogen oxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"nox_control_existing_caaa_compliance_strategy_2": {
"type": "string",
"description": "Existing strategies to meet the nitrogen oxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"nox_control_existing_caaa_compliance_strategy_3": {
"type": "string",
"description": "Existing strategies to meet the nitrogen oxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"nox_control_existing_strategy_1": {
"type": "string",
"description": "Existing strategy to comply with the most stringent nitrogen oxide regulation.",
},
"nox_control_existing_strategy_2": {
"type": "string",
"description": "Existing strategy to comply with the most stringent nitrogen oxide regulation.",
},
"nox_control_existing_strategy_3": {
"type": "string",
"description": "Existing strategy to comply with the most stringent nitrogen oxide regulation.",
},
"nox_control_id_eia": {
"type": "string",
"description": "Nitrogen oxide control identification number. This ID is not a unique identifier.",
},
"nox_control_manufacturer": {
"type": "string",
"description": "Name of nitrogen oxide control manufacturer.",
},
"nox_control_manufacturer_code": {
"type": "string",
"description": "Code indicating the nitrogen oxide control burner manufacturer.",
},
"nox_control_out_of_compliance_strategy_1": {
"type": "string",
"description": "If boiler is not in compliance with nitrogen oxide regulations, strategy for compliance.",
},
"nox_control_out_of_compliance_strategy_2": {
"type": "string",
"description": "If boiler is not in compliance with nitrogen oxide regulations, strategy for compliance.",
},
"nox_control_out_of_compliance_strategy_3": {
"type": "string",
"description": "If boiler is not in compliance with nitrogen oxide regulations, strategy for compliance.",
},
"nox_control_planned_caaa_compliance_strategy_1": {
"type": "string",
"description": "Planned strategies to meet the nitrogen oxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"nox_control_planned_caaa_compliance_strategy_2": {
"type": "string",
"description": "Planned strategies to meet the nitrogen oxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"nox_control_planned_caaa_compliance_strategy_3": {
"type": "string",
"description": "Planned strategies to meet the nitrogen oxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"nox_control_proposed_strategy_1": {
"type": "string",
"description": "Proposed strategy to comply with the most stringent nitrogen oxide regulation.",
},
"nox_control_proposed_strategy_2": {
"type": "string",
"description": "Proposed strategy to comply with the most stringent nitrogen oxide regulation.",
},
"nox_control_proposed_strategy_3": {
"type": "string",
"description": "Proposed strategy to comply with the most stringent nitrogen oxide regulation.",
},
"nox_control_status_code": {
"type": "string",
"description": "Nitrogen oxide control status code.",
},
"nox_mass_lbs": {
"type": "number",
"description": "NOx emissions in pounds.",
"unit": "lb",
},
"nox_mass_measurement_code": {
"type": "string",
"description": "Identifies whether the reported value of emissions was measured, calculated, or measured and substitute.",
"constraints": {"enum": EPACEMS_MEASUREMENT_CODES},
},
"nuclear_fraction_cost": {
"type": "number",
"description": "Nuclear cost as a percentage of overall fuel cost.",
},
"nuclear_fraction_mmbtu": {
"type": "number",
"description": "Nuclear heat content as a percentage of overall fuel heat content (MMBtu).",
},
"nuclear_unit_id": {
"type": "string",
"description": "For nuclear plants only, the unit number .One digit numeric. Nuclear plants are the only type of plants for which data are shown explicitly at the generating unit level.",
},
"num_transmission_circuits": {
"type": "integer",
"description": "Number of circuits in a transmission line.",
},
"oil_fraction_cost": {
"type": "number",
"description": "Oil cost as a percentage of overall fuel cost.",
},
"oil_fraction_mmbtu": {
"type": "number",
"description": "Oil heat content as a percentage of overall fuel heat content (MMBtu).",
},
"operates_generating_plant": {"type": "boolean"},
"operating_datetime_utc": {
"type": "datetime",
"description": "Date and time measurement began (UTC).",
},
"operating_switch": {
"type": "string",
"description": "Indicates whether the fuel switching generator can switch when operating",
},
"operating_time_hours": {
"type": "number",
"description": "Length of time interval measured.",
"unit": "hr",
},
"operating_voltage_kv": {
"type": "number",
"description": "The operating voltage, expressed kilo-volts, for three-phase 60 cycle alternative current transmission lines.",
"unit": "KV",
},
"operational_status": {
"type": "string",
"description": "The operating status of the asset. For generators this is based on which tab the generator was listed in in EIA 860.",
},
"operational_status_code": {
"type": "string",
"description": "The operating status of the asset.",
},
"operational_status_pudl": {
"type": "string",
"description": "The operating status of the asset using PUDL categories.",
"constraints": {"enum": ["operating", "retired", "proposed"]},
},
"operator_name": {
"type": "string",
"descripion": "The name of the EIA operator utility.",
},
"operator_state": {
"type": "string",
"description": "The state where the operator utility is located.",
},
"operator_utility_id_eia": {
"type": "integer",
"descrption": "The EIA utility Identification number for the operator utility.",
},
"opex_allowances": {"type": "number", "description": "Allowances.", "unit": "USD"},
"opex_boiler": {
"type": "number",
"description": "Maintenance of boiler (or reactor) plant.",
"unit": "USD",
},
"opex_coolants": {
"type": "number",
"description": "Cost of coolants and water (nuclear plants only)",
"unit": "USD",
},
"opex_dams": {
"type": "number",
"description": "Production expenses: maintenance of reservoirs, dams, and waterways (USD).",
"unit": "USD",
},
"opex_electric": {
"type": "number",
"description": "Production expenses: electric expenses (USD).",
"unit": "USD",
},
"opex_engineering": {
"type": "number",
"description": "Production expenses: maintenance, supervision, and engineering (USD).",
"unit": "USD",
},
"opex_fuel": {
"type": "number",
"description": "Production expenses: fuel (USD).",
"unit": "USD",
},
"opex_fuel_per_mwh": {
"type": "number",
"description": "Production expenses: fuel (USD) per megawatt-hour (Mwh).",
"unit": "USD_per_Mwh",
},
"opex_generation_misc": {
"type": "number",
"description": "Production expenses: miscellaneous power generation expenses (USD).",
"unit": "USD",
},
"opex_hydraulic": {
"type": "number",
"description": "Production expenses: hydraulic expenses (USD).",
"unit": "USD",
},
"opex_maintenance": {
"type": "number",
"description": "Production expenses: Maintenance (USD).",
"unit": "USD",
},
"opex_misc_plant": {
"type": "number",
"description": "Production expenses: maintenance of miscellaneous hydraulic plant (USD).",
"unit": "USD",
},
"opex_misc_power": {
"type": "number",
"description": "Miscellaneous steam (or nuclear) expenses.",
"unit": "USD",
},
"opex_misc_steam": {
"type": "number",
"description": "Maintenance of miscellaneous steam (or nuclear) plant.",
"unit": "USD",
},
"opex_nonfuel_per_mwh": {
"type": "number",
"description": "Investments in non-fuel production expenses per Mwh.",
"unit": "USD_per_Mwh",
},
"opex_operations": {
"type": "number",
"description": "Production expenses: operations, supervision, and engineering (USD).",
"unit": "USD",
},
"opex_per_mwh": {
"type": "number",
"description": "Total production expenses (USD per MWh generated).",
"unit": "USD per MWh",
},
"opex_plant": {
"type": "number",
"description": "Production expenses: maintenance of electric plant (USD).",
"unit": "USD",
},
"opex_plants": {
"type": "number",
"description": "Maintenance of electrical plant.",
"unit": "USD",
},
"opex_production_before_pumping": {
"type": "number",
"description": "Total production expenses before pumping (USD).",
"unit": "USD",
},
"opex_production_total": {
"type": "number",
"description": "Total operating expenses.",
"unit": "USD",
},
"opex_pumped_storage": {
"type": "number",
"description": "Production expenses: pumped storage (USD).",
"unit": "USD",
},
"opex_pumping": {
"type": "number",
"description": "Production expenses: We are here to PUMP YOU UP! (USD).",
"unit": "USD",
},
"opex_rents": {
"type": "number",
"description": "Production expenses: rents (USD).",
"unit": "USD",
},
"opex_steam": {"type": "number", "description": "Steam expenses.", "unit": "USD"},
"opex_steam_other": {
"type": "number",
"description": "Steam from other sources.",
"unit": "USD",
},
"opex_structures": {
"type": "number",
"description": "Production expenses: maintenance of structures (USD).",
"unit": "USD",
},
"opex_total": {
"type": "number",
"description": "Total production expenses, excluding fuel (USD).",
"unit": "USD",
},
"opex_total_nonfuel": { # To do: if identical to `opex_total`, rename column.
"type": "number",
"description": "Total production expenses, excluding fuel (USD).",
"unit": "USD",
},
"opex_transfer": {"type": "number", "description": "Steam transferred (Credit)."},
"opex_water_for_power": {
"type": "number",
"description": "Production expenses: water for power (USD).",
"unit": "USD",
},
"original_planned_generator_operating_date": {
"type": "date",
"description": "The date the generator was originally scheduled to be operational",
},
"other": {"type": "number"},
"other_charges": {
"type": "number",
"description": "Other charges, including out-of-period adjustments (USD).",
"unit": "USD",
},
"other_combustion_tech": {
"type": "boolean",
"description": "Indicates whether the generator uses other combustion technologies",
},
"other_costs": {"type": "number", "unit": "USD"},
"other_costs_incremental_cost": {"type": "number", "unit": "USD"},
"other_modifications_date": {
"type": "date",
"description": "Planned effective date that the generator is scheduled to enter commercial operation after any other planned modification is complete.",
},
"other_planned_modifications": {
"type": "boolean",
"description": "Indicates whether there are there other modifications planned for the generator.",
},
"other_total": {
"type": "number",
"description": "Total Other Production Plant (FERC Accounts 340-347).",
},
"outages_recorded_automatically": {"type": "boolean"},
"owned_by_non_utility": {
"type": "boolean",
"description": "Whether any part of generator is owned by a nonutilty",
},
"owner_city": {"type": "string", "description": "City of owner."},
"owner_country": {
"type": "string",
"description": "Three letter ISO-3166 country code.",
"constraints": {"enum": COUNTRY_CODES_ISO3166},
},
"owner_name": {"type": "string", "description": "Name of owner."},
"owner_state": {
"type": "string",
"description": "Two letter ISO-3166 political subdivision code.",
"constraints": {"enum": SUBDIVISION_CODES_ISO3166},
},
"owner_street_address": {
"type": "string",
"description": "Steet address of owner.",
},
"owner_utility_id_eia": {
"type": "integer",
"description": "The EIA utility Identification number for the owner company that is responsible for the day-to-day operations of the generator, not the operator utility.",
},
"owner_utility_name_eia": {
"type": "string",
"description": "The name of the EIA owner utility.",
},
"owner_zip_code": {
"type": "string",
"description": "Zip code of owner.",
"constraints": {
"pattern": r"^\d{5}$",
},
},
"ownership_record_type": {
"type": "string",
"description": "Whether each generator record is for one owner or represents a total of all ownerships.",
"constraints": {"enum": ["owned", "total"]},
},
"ownership_code": {
"type": "string",
"description": "Identifies the ownership for each generator.",
},
"ownership_dupe": {
"type": "boolean",
"description": "Whether a plant part record has a duplicate record with different ownership status.",
},
"particulate_control_id_eia": {
"type": "string",
"description": "Particulate matter control identification number. This ID is not a unique identifier.",
},
"particulate_control_out_of_compliance_strategy_1": {
"type": "string",
"description": "If boiler is not in compliance with particulate matter regulations, strategy for compliance.",
},
"particulate_control_out_of_compliance_strategy_2": {
"type": "string",
"description": "If boiler is not in compliance with particulate matter regulations, strategy for compliance.",
},
"particulate_control_out_of_compliance_strategy_3": {
"type": "string",
"description": "If boiler is not in compliance with particulate matter regulations, strategy for compliance.",
},
"partitions": {
"type": "string",
"description": "The data parititions used to generate this instance of the database.",
},
"peak_demand_mw": {
"type": "number",
"unit": "MW",
"description": "Net peak demand for 60 minutes. Note: in some cases peak demand for other time periods may have been reported instead, if hourly peak demand was unavailable.",
# TODO Disambiguate column names. Usually this is over 60 minutes, but in
# other tables it's not specified.
},
"peak_demand_summer_mw": {"type": "number", "unit": "MW"},
"peak_demand_winter_mw": {"type": "number", "unit": "MW"},
"period_nox": {
"type": "string",
"description": "The time period specified by the most stringent nitrogen oxide regulation.",
},
"period_particulate": {
"type": "string",
"description": "The time period specified by the most stringent particulate matter regulation.",
},
"period_so2": {
"type": "string",
"description": "The time period specified by the most stringent sulfur dioxide regulation.",
},
"phone_extension": {
"type": "string",
"description": "Phone extension for utility contact 1",
},
"phone_extension_2": {
"type": "string",
"description": "Phone extension for utility contact 2",
},
"phone_number": {
"type": "string",
"description": "Phone number for utility contact 1.",
},
"phone_number_2": {
"type": "string",
"description": "Phone number for utility contact 2.",
},
"pipeline_notes": {
"type": "string",
"description": "Additional owner or operator of natural gas pipeline.",
},
"planned_derate_date": {
"type": "date",
"description": "Planned effective month that the generator is scheduled to enter operation after the derate modification.",
},
"planned_energy_source_code_1": {
"type": "string",
"description": "New energy source code for the planned repowered generator.",
},
"planned_generator_retirement_date": {
"type": "date",
"description": "Planned effective date of the scheduled retirement of the generator.",
},
"planned_modifications": {
"type": "boolean",
"description": "Indicates whether there are any planned capacity uprates/derates, repowering, other modifications, or generator retirements scheduled for the next 5 years.",
},
"planned_net_summer_capacity_derate_mw": {
"type": "number",
"description": "Decrease in summer capacity expected to be realized from the derate modification to the equipment.",
"unit": "MW",
},
"planned_net_summer_capacity_uprate_mw": {
"type": "number",
"description": "Increase in summer capacity expected to be realized from the modification to the equipment.",
"unit": "MW",
},
"planned_net_winter_capacity_derate_mw": {
"type": "number",
"description": "Decrease in winter capacity expected to be realized from the derate modification to the equipment.",
"unit": "MW",
},
"planned_net_winter_capacity_uprate_mw": {
"type": "number",
"description": "Increase in winter capacity expected to be realized from the uprate modification to the equipment.",
"unit": "MW",
},
"planned_new_capacity_mw": {
"type": "number",
"description": "The expected new namplate capacity for the generator.",
"unit": "MW",
},
"planned_new_prime_mover_code": {
"type": "string",
"description": "New prime mover for the planned repowered generator.",
},
"planned_repower_date": {
"type": "date",
"description": "Planned effective date that the generator is scheduled to enter operation after the repowering is complete.",
},
"planned_uprate_date": {
"type": "date",
"description": "Planned effective date that the generator is scheduled to enter operation after the uprate modification.",
},
"plant_capability_mw": {
"type": "number",
"description": "Net plant capability in megawatts.",
"unit": "MW",
},
"plant_function": {
"type": "string",
"description": "Functional role played by utility plant (steam production, nuclear production, distribution, transmission, etc.).",
},
"plant_hours_connected_while_generating": {
"type": "number",
"description": "Hours the plant was connected to load while generating in the report year.",
"unit": "hr",
# TODO Add min/max constraint. 0 <= X <= 8784
},
"plant_id_eia": {
"type": "integer",
"description": "The unique six-digit facility identification number, also called an ORISPL, assigned by the Energy Information Administration.",
},
"plant_id_epa": {
"type": "integer",
"description": "The ORISPL ID used by EPA to refer to the plant. Usually but not always the same as plant_id_eia.",
},
"plant_id_ferc1": {
"type": "integer",
"description": "Algorithmically assigned PUDL FERC Plant ID. WARNING: NOT STABLE BETWEEN PUDL DB INITIALIZATIONS.",
},
"plant_id_pudl": {
"type": "integer",
"description": "A manually assigned PUDL plant ID. May not be constant over time.",
},
"plant_id_report_year": {
"type": "string",
"description": "PUDL plant ID and report year of the record.",
},
"plant_name_eia": {"type": "string", "description": "Plant name."},
"plant_name_ferc1": {
"type": "string",
"description": "Name of the plant, as reported to FERC. This is a freeform string, not guaranteed to be consistent across references to the same plant.",
},
"plant_name_ppe": {
"type": "string",
"description": "Derived plant name that includes EIA plant name and other strings associated with ID and PK columns of the plant part.",
},
"plant_name_pudl": {
"type": "string",
"description": "Plant name, chosen arbitrarily from the several possible plant names available in the plant matching process. Included for human readability only.",
},
"plant_part": {
"type": "string",
"description": "The part of the plant a record corresponds to.",
"constraints": {"enum": PLANT_PARTS},
},
"plant_part_id_eia": {
"type": "string",
"description": "Contains EIA plant ID, plant part, ownership, and EIA utility id",
},
"plant_status": {
"type": "string",
"description": "Utility plant financial status (in service, future, leased, total).",
},
"plant_type": {
"type": "string" # if plant_type is categorized w/ categorize_strings, add enum in FIELD_METADATA_BY_RESOURCE
},
"plants_reported_asset_manager": {
"type": "boolean",
"description": "Is the reporting entity an asset manager of power plants reported on Schedule 2 of the form?",
},
"plants_reported_operator": {
"type": "boolean",
"description": "Is the reporting entity an operator of power plants reported on Schedule 2 of the form?",
},
"plants_reported_other_relationship": {
"type": "boolean",
"description": "Does the reporting entity have any other relationship to the power plants reported on Schedule 2 of the form?",
},
"plants_reported_owner": {
"type": "boolean",
"description": "Is the reporting entity an owner of power plants reported on Schedule 2 of the form?",
},
"population": {
"type": "number",
"description": "County population, sourced from Census DP1 data.",
},
"population_density_km2": {
"type": "number",
"description": "Average population per sq. km area of a service territory.",
},
"potential_peak_demand_savings_mw": {"type": "number", "unit": "MW"},
"previously_canceled": {
"type": "boolean",
"description": "Indicates whether the generator was previously reported as indefinitely postponed or canceled",
},
"price_responsive_programs": {"type": "boolean"},
"price_responsiveness_customers": {"type": "integer"},
"primary_fuel_by_cost": {
"type": "string",
"description": "Primary fuel for plant as a percentage of cost.",
},
"primary_fuel_by_mmbtu": {
"type": "string",
"description": "Primary fuel for plant as a percentage of heat content.",
},
"primary_purpose_id_naics": {
"type": "integer",
"description": "North American Industry Classification System (NAICS) code that best describes the primary purpose of the reporting plant",
},
"primary_transportation_mode_code": {
"type": "string",
"description": "Transportation mode for the longest distance transported.",
},
"prime_mover": {
"type": "string",
"description": "Full description of the type of prime mover.",
},
"prime_mover_code": {
"type": "string",
"description": "Code for the type of prime mover (e.g. CT, CG)",
},
"project_num": {"type": "integer", "description": "FERC Licensed Project Number."},
"pudl_version": {
"type": "string",
"description": "The version of PUDL used to generate this database.",
},
"pulverized_coal_tech": {
"type": "boolean",
"description": "Indicates whether the generator uses pulverized coal technology",
},
"purchase_type_code": {
"type": "string",
"description": "Categorization based on the original contractual terms and conditions of the service. Must be one of 'requirements', 'long_firm', 'intermediate_firm', 'short_firm', 'long_unit', 'intermediate_unit', 'electricity_exchange', 'other_service', or 'adjustment'. Requirements service is ongoing high reliability service, with load integrated into system resource planning. 'Long term' means 5+ years. 'Intermediate term' is 1-5 years. 'Short term' is less than 1 year. 'Firm' means not interruptible for economic reasons. 'unit' indicates service from a particular designated generating unit. 'exchange' is an in-kind transaction.",
},
"purchased_mwh": {
"type": "number",
"description": "Megawatt-hours shown on bills rendered to the respondent. Includes both electricity purchased for storage and non-storage purposes, which were lumped together prior to 2021.",
"unit": "MWh",
},
"purchased_other_than_storage_mwh": {
"type": "number",
"description": "Number of megawatt hours purchased during the period for other than energy storage.",
"unit": "MWh",
},
"purchased_storage_mwh": {
"type": "number",
"description": "Number of megawatt hours purchased during the period for energy storage.",
"unit": "MWh",
},
"pv_current_flow_type": {"type": "string", "constraints": {"enum": ["AC", "DC"]}},
"rate_schedule_description": {
"type": "string",
"description": "Free-form description of what the rate schedule name is. Not standardized. Often a sub-category of rate_schedule_type.",
},
"rate_schedule_type": {
"type": "string",
"description": "Categorization of rate schedule type.",
},
"reactive_power_output_mvar": {
"type": "number",
"description": "Reactive Power Output (MVAr)",
"unit": "MVAr",
},
"real_time_pricing": {"type": "boolean"},
"rec_revenue": {"type": "number", "unit": "USD"},
"rec_sales_mwh": {"type": "number", "unit": "MWh"},
"received_mwh": {
"type": "number",
"description": "Gross megawatt-hours received in power exchanges and used as the basis for settlement.",
"unit": "MWh",
},
"record_count": {
"type": "integer",
"description": "Number of distinct generator IDs that partcipated in the aggregation for a plant part list record.",
},
"record_id": {
"type": "string",
"description": "Identifier indicating original FERC Form 1 source record. format: {table_name}_{report_year}_{report_prd}_{respondent_id}_{spplmnt_num}_{row_number}. Unique within FERC Form 1 DB tables which are not row-mapped.", # noqa: FS003
},
"record_id_eia": {
"type": "string",
"description": "Identifier for EIA plant parts analysis records.",
},
"record_id_ferc1": {
"type": "string",
"description": "Identifier indicating original FERC Form 1 source record. format: {table_name}_{report_year}_{report_prd}_{respondent_id}_{spplmnt_num}_{row_number}. Unique within FERC Form 1 DB tables which are not row-mapped.", # noqa: FS003
},
"region_name_us_census": {
"type": "string",
"description": "Human-readable name of a US Census region.",
},
"regulation_mercury": {
"type": "string",
"description": "Most stringent type of statute or regulation code under which the boiler is operating for mercury control standards.",
},
"regulation_nox": {
"type": "string",
"description": "EIA short code for most stringent type of statute or regulation code under which the boiler is operating for nitrogen oxide control standards.",
},
"regulation_particulate": {
"type": "string",
"description": "EIA short code for most stringent type of statute or regulation code under which the boiler is operating for particulate matter control standards.",
},
"regulation_so2": {
"type": "string",
"description": "EIA short code for most stringent type of statute or regulation code under which the boiler is operating for sulfur dioxide control standards.",
},
"regulatory_status_code": {
"type": "string",
"description": "Indicates whether the plant is regulated or non-regulated.",
},
"report_date": {"type": "date", "description": "Date reported."},
"report_year": {
"type": "integer",
"description": "Four-digit year in which the data was reported.",
},
"reported_as_another_company": {"type": "string"},
"reporting_frequency_code": {
"type": "string",
"description": "Code that specifies what time period data has to be reported (i.e. monthly data or annual totals) and how often the power plant reports this data to EIA. See reporting_frequencies_eia for more details.",
"constraints": {
"enum": sorted(
set(CODE_METADATA["reporting_frequencies_eia"]["df"]["code"])
)
},
},
"respondent_id_ferc714": {
"type": "integer",
"description": "FERC Form 714 respondent ID. Note that this ID does not correspond to FERC respondent IDs from other forms.",
},
"respondent_name_ferc714": {
"type": "string",
"description": "Name of the utility, balancing area authority, or planning authority responding to FERC Form 714.",
},
"respondent_type": {
"type": "string",
"constraints": {"enum": ["utility", "balancing_authority"]},
},
"retail_marketing_activity": {"type": "boolean"},
"retail_sales": {"type": "number"},
"retail_sales_mwh": {"type": "number", "unit": "MWh"},
"retirements": {
"type": "number",
"description": "Cost of disposal of items classified within the account.",
"unit": "USD",
},
"revenue": {"type": "number", "unit": "USD"},
"revenue_class": {"type": "string", "constraints": {"enum": REVENUE_CLASSES}},
"revenue_per_kwh": {"type": "number", "unit": "USD"},
"revenue_type": {
"type": "string",
"description": "Label describing types of revenues.",
},
"row_type_xbrl": {
"type": "string",
"description": "Indicates whether the value reported in the row is calculated, or uniquely reported within the table.",
"constraints": {"enum": ["calculated_value", "reported_value", "correction"]},
},
"rto_iso_lmp_node_id": {
"type": "string",
"description": "The designation used to identify the price node in RTO/ISO Locational Marginal Price reports",
},
"rto_iso_location_wholesale_reporting_id": {
"type": "string",
"description": "The designation used to report ths specific location of the wholesale sales transactions to FERC for the Electric Quarterly Report",
},
"rtos_of_operation": {"type": "string", "constraints": {"enum": RTO_CLASSES}},
"saidi_w_major_event_days_minus_loss_of_service_minutes": {
"type": "number",
"unit": "min",
},
"saidi_w_major_event_days_minutes": {"type": "number", "unit": "min"},
"saidi_wo_major_event_days_minutes": {"type": "number", "unit": "min"},
"saifi_w_major_event_days_customers": {"type": "number"},
"saifi_w_major_event_days_minus_loss_of_service_customers": {"type": "number"},
"saifi_wo_major_event_days_customers": {"type": "number"},
"sales_for_resale": {"type": "number"},
"sales_for_resale_mwh": {"type": "number", "unit": "MWh"},
"sales_mwh": {
"description": "Quantity of electricity sold in MWh.",
"type": "number",
"unit": "MWh",
},
"sales_revenue": {
"description": "Revenue from electricity sold.",
"type": "number",
"unit": "USD",
},
"sales_to_ultimate_consumers_mwh": {"type": "number", "unit": "MWh"},
"scaled_demand_mwh": {
"type": "number",
"description": "Estimated electricity demand scaled by the total sales within a state.",
"unit": "MWh",
},
"secondary_transportation_mode_code": {
"type": "string",
"description": "Transportation mode for the second longest distance transported.",
},
"sector_agg": {
"type": "string",
"description": "Category of sectoral aggregation in EIA bulk electricity data.",
},
"sector_id_eia": {
"type": "integer",
"description": "EIA assigned sector ID, corresponding to high level NAICS sector, designated by the primary purpose, regulatory status and plant-level combined heat and power status",
},
"sector_name_eia": {
"type": "string",
"description": "EIA assigned sector name, corresponding to high level NAICS sector, designated by the primary purpose, regulatory status and plant-level combined heat and power status",
},
"seller_name": {
"type": "string",
"description": "Name of the seller, or the other party in an exchange transaction.",
},
"service_area": {
"type": "string",
"description": "Service area in which plant is located; for unregulated companies, it's the electric utility with which plant is interconnected",
},
"service_type": {
"type": "string",
"constraints": {"enum": ["bundled", "energy", "delivery"]},
},
"short_form": {"type": "boolean"},
"so2_control_existing_caaa_compliance_strategy_1": {
"type": "string",
"description": "Existing strategies to meet the sulfur dioxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"so2_control_existing_caaa_compliance_strategy_2": {
"type": "string",
"description": "Existing strategies to meet the sulfur dioxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"so2_control_existing_caaa_compliance_strategy_3": {
"type": "string",
"description": "Existing strategies to meet the sulfur dioxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"so2_control_existing_strategy_1": {
"type": "string",
"description": "Existing strategy to comply with the most stringent sulfur dioxide regulation.",
},
"so2_control_existing_strategy_2": {
"type": "string",
"description": "Existing strategy to comply with the most stringent sulfur dioxide regulation.",
},
"so2_control_existing_strategy_3": {
"type": "string",
"description": "Existing strategy to comply with the most stringent sulfur dioxide regulation.",
},
"so2_control_id_eia": {
"type": "string",
"description": "Sulfur dioxide control identification number. This ID is not a unique identifier.",
},
"so2_control_out_of_compliance_strategy_1": {
"type": "string",
"description": "If boiler is not in compliance with sulfur dioxide regulations, strategy for compliance.",
},
"so2_control_out_of_compliance_strategy_2": {
"type": "string",
"description": "If boiler is not in compliance with sulfur dioxide regulations, strategy for compliance.",
},
"so2_control_out_of_compliance_strategy_3": {
"type": "string",
"description": "If boiler is not in compliance with sulfur dioxide regulations, strategy for compliance.",
},
"so2_control_planned_caaa_compliance_strategy_1": {
"type": "string",
"description": "Planned strategies to meet the sulfur dioxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"so2_control_planned_caaa_compliance_strategy_2": {
"type": "string",
"description": "Planned strategies to meet the sulfur dioxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"so2_control_planned_caaa_compliance_strategy_3": {
"type": "string",
"description": "Planned strategies to meet the sulfur dioxide requirements of Title IV of the Clean Air Act Amendment of 1990.",
},
"so2_control_proposed_strategy_1": {
"type": "string",
"description": "Proposed strategy to comply with the most stringent sulfur dioxide regulation.",
},
"so2_control_proposed_strategy_2": {
"type": "string",
"description": "Proposed strategy to comply with the most stringent sulfur dioxide regulation.",
},
"so2_control_proposed_strategy_3": {
"type": "string",
"description": "Proposed strategy to comply with the most stringent sulfur dioxide regulation.",
},
"so2_mass_lbs": {
"type": "number",
"description": "Sulfur dioxide emissions in pounds.",
"unit": "lb",
},
"so2_mass_measurement_code": {
"type": "string",
"description": "Identifies whether the reported value of emissions was measured, calculated, or measured and substitute.",
"constraints": {"enum": EPACEMS_MEASUREMENT_CODES},
},
"sold_to_utility_mwh": {"type": "number", "unit": "MWh"},
"solid_fuel_gasification": {
"type": "boolean",
"description": "Indicates whether the generator is part of a solid fuel gasification system",
},
"stack_flue_id_eia": {
"type": "string",
"description": (
"The stack or flue identification value reported to EIA. This denotes the "
"place where emissions from the combusion process are released into the "
"atmosphere. Prior to 2013, this was reported as `stack_id_eia` and "
"`flue_id_eia`."
),
},
"stack_flue_id_pudl": {
"type": "string",
"description": (
"A stack and/or flue identification value created by PUDL for use as part "
"of the primary key for the stack flue equipment and boiler association "
"tables. For 2013 and onward, this value is equal to the value for "
"stack_flue_id_eia. Prior to 2013, this value is equal to the value for "
"stack_id_eia and the value for flue_id_eia seperated by an underscore or "
"just the stack_flue_eia in cases where flue_id_eia is NA."
),
},
"stack_id_eia": {
"type": "string",
"description": (
"The stack identification value reported to EIA. Stacks or chimneys are "
"the place where emissions from the combustion process are released into "
"the atmosphere. This field was reported in conjunction with flue_id_eia "
"until 2013 when stack_flue_id_eia took their place."
),
},
"standard": {"type": "string", "constraints": {"enum": RELIABILITY_STANDARDS}},
"standard_nox_rate": {
"type": "number",
"description": "Numeric value for the unit of measurement specified for nitrogen oxide.",
},
"standard_particulate_rate": {
"type": "number",
"description": "Numeric value for the unit of measurement specified for particulate matter.",
},
"standard_so2_rate": {
"type": "number",
"description": "Numeric value for the unit of measurement specified for sulfur dioxide.",
},
"standard_so2_percent_scrubbed": {
"type": "number",
"description": "The percent of sulfur dioxide to be scrubbed specified by the most stringent sulfur dioxide regulation.",
},
"start_point": {
"type": "string",
"description": "The starting point of a transmission line.",
},
"starting_balance": {
"type": "number",
"description": "Account balance at beginning of year.",
"unit": "USD",
},
"startup_source_code_1": {
"type": "string",
"description": "The code representing the first, second, third or fourth start-up and flame stabilization energy source used by the combustion unit(s) associated with this generator.",
},
"startup_source_code_2": {
"type": "string",
"description": "The code representing the first, second, third or fourth start-up and flame stabilization energy source used by the combustion unit(s) associated with this generator.",
},
"startup_source_code_3": {
"type": "string",
"description": "The code representing the first, second, third or fourth start-up and flame stabilization energy source used by the combustion unit(s) associated with this generator.",
},
"startup_source_code_4": {
"type": "string",
"description": "The code representing the first, second, third or fourth start-up and flame stabilization energy source used by the combustion unit(s) associated with this generator.",
},
"state": {
"type": "string",
# TODO: disambiguate the column name. State means different things in
# different tables. E.g. state of the utility's HQ address vs. state that a
# plant is located in vs. state in which a utility provides service.
"description": "Two letter US state abbreviation.",
},
"state_id_fips": {
"type": "string",
"description": "Two digit state FIPS code.",
"constraints": {
"pattern": r"^\d{2}$",
},
},
"status": {
"type": "string"
# TODO: Disambiguate column name.
},
"steam_load_1000_lbs": {
"type": "number",
"description": "Total steam pressure produced by a unit during the reported hour.",
"unit": "lb",
},
"steam_plant_type_code": {
"type": "integer",
"description": "Code that describes types of steam plants from EIA 860. See steam_plant_types_eia table for more details.",
},
"stoker_tech": {
"type": "boolean",
"description": "Indicates whether the generator uses stoker technology",
},
"storage_capacity_mw": {"type": "number", "unit": "MW"},
"storage_customers": {"type": "integer"},
"street_address": {
"type": "string",
# TODO: Disambiguate as this means different things in different tables.
},
"subcritical_tech": {
"type": "boolean",
"description": "Indicates whether the generator uses subcritical technology",
},
"subdivision_code": {
"type": "string",
"description": (
"Two-letter ISO-3166 political subdivision code (e.g. US state "
"or Canadian provice abbreviations like CA or AB)."
),
"constraints": {"enum": SUBDIVISION_CODES_ISO3166},
},
"subdivision_name": {
"type": "string",
"description": (
"Full name of political subdivision (e.g. US state or Canadian "
"province names like California or Alberta."
),
},
"subdivision_type": {
"type": "string",
"description": (
"ISO-3166 political subdivision type. E.g. state, province, outlying_area."
),
},
"subplant_id": {
"type": "integer",
"description": "Sub-plant ID links EPA CEMS emissions units to EIA units.",
},
"sulfur_content_pct": {
"type": "number",
"description": "Sulfur content percentage by weight to the nearest 0.01 percent.",
},
"summer_capacity_estimate": {
"type": "boolean",
"description": "Whether the summer capacity value was an estimate",
},
"summer_capacity_mw": {
"type": "number",
"description": "The net summer capacity.",
"unit": "MW",
},
"summer_estimated_capability_mw": {
"type": "number",
"description": "EIA estimated summer capacity (in MWh).",
"unit": "MWh",
},
"summer_peak_demand_mw": {"type": "number", "unit": "MW"},
"supercritical_tech": {
"type": "boolean",
"description": "Indicates whether the generator uses supercritical technology",
},
"supplier_name": {
"type": "string",
"description": "Company that sold the fuel to the plant or, in the case of Natural Gas, pipline owner.",
},
"supporting_structure_type": {
"type": "string",
"description": "Supporting structure of the transmission line.",
},
"switch_oil_gas": {
"type": "boolean",
"description": "Indicates whether the generator switch between oil and natural gas.",
},
"syncronized_transmission_grid": {
"type": "boolean",
"description": "Indicates whether standby generators (SB status) can be synchronized to the grid.",
},
"tariff": {
"type": "string",
"description": "FERC Rate Schedule Number or Tariff. (Note: may be incomplete if originally reported on multiple lines.)",
},
"tech_class": {"type": "string", "constraints": {"enum": TECH_CLASSES}},
"technology_description": {
"type": "string",
"description": "High level description of the technology used by the generator to produce electricity.",
},
"temporal_agg": {
"type": "string",
"description": "Category of temporal aggregation in EIA bulk electricity data.",
},
"time_cold_shutdown_full_load_code": {
"type": "string",
"description": "The minimum amount of time required to bring the unit to full load from shutdown.",
},
"time_of_use_pricing": {"type": "boolean"},
"time_responsive_programs": {"type": "boolean"},
"time_responsiveness_customers": {"type": "integer"},
"timezone": {
"type": "string",
"description": "IANA timezone name",
"constraints": {"enum": all_timezones},
},
"timezone_approx": {
"type": "string",
"description": (
"IANA timezone name of the timezone which encompasses the largest portion "
"of the population in the associated geographic area."
),
"constraints": {"enum": all_timezones},
},
"topping_bottoming_code": {
"type": "string",
"description": "If the generator is associated with a combined heat and power system, indicates whether the generator is part of a topping cycle or a bottoming cycle",
},
"total": {
"type": "number",
"description": "Total of Electric Plant In Service, Electric Plant Held for Future Use, and Electric Plant Leased to Others (USD).",
"unit": "USD",
},
"total_capacity_less_1_mw": {"type": "number", "unit": "MW"},
"total_disposition_mwh": {"type": "number", "unit": "MWh"},
"total_energy_losses_mwh": {"type": "number", "unit": "MWh"},
"total_fuel_cost": {
"type": "number",
"description": "Total annual reported fuel costs for the plant part. Includes costs from all fuels.",
},
"total_fuel_cost_eia": {
"type": "number",
"description": "Total annual reported fuel costs for the plant part. Includes costs from all fuels.",
},
"total_fuel_cost_ferc1": {
"type": "number",
"description": "Total annual reported fuel costs for the plant part. Includes costs from all fuels.",
},
"total_meters": {"type": "integer", "unit": "m"},
"total_mmbtu": {
"type": "number",
"description": "Total annual heat content of fuel consumed by a plant part record in the plant parts list.",
},
"total_mmbtu_eia": {
"type": "number",
"description": "Total annual heat content of fuel consumed by a plant part record in the plant parts list.",
},
"total_mmbtu_ferc1": {
"type": "number",
"description": "Total annual heat content of fuel consumed by a plant part record in the plant parts list.",
},
"total_settlement": {
"type": "number",
"description": "Sum of demand, energy, and other charges (USD). For power exchanges, the settlement amount for the net receipt of energy. If more energy was delivered than received, this amount is negative.",
"unit": "USD",
},
"total_sources_mwh": {"type": "number", "unit": "MWh"},
"transmission": {"type": "number"},
"transmission_activity": {"type": "boolean"},
"transmission_by_other_losses_mwh": {"type": "number", "unit": "MWh"},
"transmission_distribution_owner_id": {
"type": "integer",
"description": "EIA-assigned code for owner of transmission/distribution system to which the plant is interconnected.",
},
"transfers": {
"type": "number",
"description": "Cost of transfers into (out of) the account.",
"unit": "USD",
},
"transmission_distribution_owner_name": {
"type": "string",
"description": "Name of the owner of the transmission or distribution system to which the plant is interconnected.",
},
"transmission_distribution_owner_state": {
"type": "string",
"description": "State location for owner of transmission/distribution system to which the plant is interconnected.",
},
"transmission_line_and_structures_length_miles": {
"type": "number",
"description": "Length (in pole miles or circuit miles (if transmission lines are underground)) for lines that are agrregated with other lines / structures (whose cost are aggregated and combined with other structures).",
},
"transmission_line_length_miles": {
"type": "number",
"description": "Length (in pole miles or circuit miles (if transmission lines are underground)) for lines that are stand alone structures (whose cost are reported on a stand-alone basis).",
},
"true_gran": {
"type": "boolean",
"description": "Indicates whether a plant part list record is associated with the highest priority plant part for all identical records.",
},
"turbines_inverters_hydrokinetics": {
"type": "integer",
"description": "Number of wind turbines, or hydrokinetic buoys.",
},
"turbines_num": {
"type": "integer",
"description": "Number of wind turbines, or hydrokinetic buoys.",
},
"turndown_ratio": {
"type": "number",
"description": "The turndown ratio for the boiler.",
},
"ultrasupercritical_tech": {
"type": "boolean",
"description": "Indicates whether the generator uses ultra-supercritical technology",
},
"unbundled_revenues": {"type": "number", "unit": "USD"},
"unit_id_eia": {
"type": "string",
"description": "EIA-assigned unit identification code.",
},
"unit_id_pudl": {
"type": "integer",
"description": "Dynamically assigned PUDL unit id. WARNING: This ID is not guaranteed to be static long term as the input data and algorithm may evolve over time.",
},
"unit_nox": {
"type": "string",
"description": "Numeric value for the unit of measurement specified for nitrogen oxide.",
},
"unit_particulate": {
"type": "string",
"description": "Numeric value for the unit of measurement specified for particulate matter.",
},
"unit_so2": {
"type": "string",
"description": "Numeric value for the unit of measurement specified for sulfur dioxide.",
},
"uprate_derate_completed_date": {
"type": "date",
"description": "The date when the uprate or derate was completed.",
},
"uprate_derate_during_year": {
"type": "boolean",
"description": "Was an uprate or derate completed on this generator during the reporting year?",
},
"utc_datetime": {"type": "datetime"},
"utility_attn": {"type": "string"},
"utility_id_eia": {
"type": "integer",
"description": "The EIA Utility Identification number.",
},
"utility_id_ferc1": {
"type": "integer",
"description": "PUDL-assigned utility ID, identifying a FERC1 utility. This is an auto-incremented ID and is not expected to be stable from year to year.",
},
"utility_id_ferc1_dbf": {
"type": "integer",
"description": "FERC-assigned respondent_id from DBF reporting years, identifying the reporting entity. Stable from year to year.",
},
"utility_id_ferc1_xbrl": {
"type": "string",
"description": "FERC-assigned entity_id from XBRL reporting years, identifying the reporting entity. Stable from year to year.",
},
"utility_id_pudl": {
"type": "integer",
"description": "A manually assigned PUDL utility ID. May not be stable over time.",
},
"utility_name_eia": {"type": "string", "description": "The name of the utility."},
"utility_name_ferc1": {
"type": "string",
"description": "Name of the responding utility, as it is reported in FERC Form 1. For human readability only.",
},
"utility_name_pudl": {
"type": "string",
"description": "Utility name, chosen arbitrarily from the several possible utility names available in the utility matching process. Included for human readability only.",
},
"utility_owned_capacity_mw": {"type": "number", "unit": "MW"},
"utility_plant_asset_type": {
"type": "string",
"description": "Type of utility plant asset reported in the utility_plant_summary_ferc1 table. Assets include those leased to others, held for future use, construction work-in-progress and details of accumulated depreciation.",
},
"utility_pobox": {"type": "string"},
"utility_type": {
"type": "string",
"description": "Listing of utility plant types. Examples include Electric Utility, Gas Utility, and Other Utility.",
},
"utility_type_other": {
"type": "string",
"description": "Freeform description of type of utility reported in one of the other three other utility_type sections in the utility_plant_summary_ferc1 table. This field is reported only in the DBF reporting years (1994-2020).",
},
"variable_peak_pricing": {"type": "boolean"},
"virtual_capacity_mw": {"type": "number", "unit": "MW"},
"virtual_customers": {"type": "integer"},
"waste_fraction_cost": {
"type": "number",
"description": "Waste-heat cost as a percentage of overall fuel cost.",
},
"waste_fraction_mmbtu": {
"type": "number",
"description": "Waste-heat heat content as a percentage of overall fuel heat content (MMBtu).",
},
"waste_heat_input_mmbtu_per_hour": {
"type": "number",
"unit": "MMBtu_per_hour",
"description": "Design waste-heat input rate at maximum continuous steam flow where a waste-heat boiler is a boiler that receives all or a substantial portion of its energy input from the noncumbustible exhaust gases of a separate fuel-burning process (MMBtu per hour).",
},
"water_heater": {"type": "integer"},
"water_limited_capacity_mw": {
"type": "number",
"description": "Plant capacity in MW when limited by condenser water.",
"unit": "MW",
},
"water_source": {
"type": "string",
"description": "Name of water source associated with the plant.",
},
"weighted_average_life_years": {"type": "number"},
"wet_dry_bottom": {
"type": "string",
"unit": "MMBtu_per_hour",
"description": "Wet or Dry Bottom where Wet Bottom is defined as slag tanks that are installed at furnace throat to contain and remove molten ash from the furnace, and Dry Bottom is defined as having no slag tanks at furnace throat area, throat area is clear, and bottom ash drops through throat to bottom ash water hoppers.",
},
"wheeled_power_delivered_mwh": {"type": "number", "unit": "MWh"},
"wheeled_power_received_mwh": {"type": "number", "unit": "MWh"},
"wholesale_marketing_activity": {"type": "boolean"},
"wholesale_power_purchases_mwh": {"type": "number", "unit": "MWh"},
"winter_capacity_estimate": {
"type": "boolean",
"description": "Whether the winter capacity value was an estimate",
},
"winter_capacity_mw": {
"type": "number",
"description": "The net winter capacity.",
"unit": "MW",
},
"winter_estimated_capability_mw": {
"type": "number",
"description": "EIA estimated winter capacity (in MWh).",
"unit": "MWh",
},
"winter_peak_demand_mw": {"type": "number", "unit": "MW"},
"year": {
"type": "integer",
"description": "Year the data was reported in, used for partitioning EPA CEMS.",
},
"zip_code": {
"type": "string",
"description": "Five digit US Zip Code.",
"constraints": {
"pattern": r"^\d{5}$",
},
},
"zip_code_4": {
"type": "string",
"description": "Four digit US Zip Code suffix.",
"constraints": {
"pattern": r"^\d{4}$",
},
},
}
"""Field attributes by PUDL identifier (`field.name`).
Keys are in alphabetical order.
"""
[docs]
FIELD_METADATA_BY_GROUP: dict[str, dict[str, Any]] = {
"epacems": {
"state": {"constraints": {"enum": EPACEMS_STATES}},
"operating_datetime_utc": {
"constraints": {
"required": True,
}
},
"year": {
"constraints": {
"required": True,
}
},
},
"eia": {"fuel_units": {"constraints": {"enum": sorted(FUEL_UNITS_EIA.keys())}}},
"ferc1": {
"fuel_units": {
"constraints": {
"enum": [
"mmbtu",
"gramsU",
"kg",
"mwhth",
"kgal",
"bbl",
"klbs",
"mcf",
"gal",
"mwdth",
"btu",
"ton",
]
}
}
},
}
"""Field attributes by resource group (`resource.group`) and PUDL identifier.
If a field exists in more than one data group (e.g. both ``eia`` and ``ferc1``) and has
distinct metadata in those groups, this is the place to specify the override. Only those
elements which should be overridden need to be specified.
"""
[docs]
FIELD_METADATA_BY_RESOURCE: dict[str, dict[str, Any]] = {
"sector_consolidated_eia": {"code": {"type": "integer"}},
"plants_hydro_ferc1": {
"plant_type": {
"type": "string",
"constraints": {
# This ENUM is made up of the keys from
# pudl.transform.params.ferc1.PLANT_TYPE_CATEGORIES_HYDRO, which it
# would be better to use directly, but we have to work out some cross
# subpackage import dependencies
"enum": {
"hydro",
"na_category",
"run_of_river_with_storage",
"run_of_river",
"storage",
}
},
}
},
"plants_steam_ferc1": {
"plant_type": {
"type": "string",
"constraints": {
# This ENUM is made up of the keys from
# pudl.transform.params.ferc1.PLANT_TYPE_CATEGORIES, which it
# would be better to use directly, but we have to work out some cross
# subpackage import dependencies
"enum": {
"combined_cycle",
"combustion_turbine",
"geothermal",
"internal_combustion",
"na_category",
"nuclear",
"photovoltaic",
"solar_thermal",
"steam",
"wind",
}
},
}
},
"plant_parts_eia": {
"energy_source_code_1": {
"constraints": {"enum": set(CODE_METADATA["energy_sources_eia"]["df"].code)}
},
"prime_movers_eia": {
"constraints": {"enum": set(CODE_METADATA["prime_movers_eia"]["df"].code)}
},
"technology_description": {"constraints": {"enum": set(TECH_DESCRIPTIONS)}},
},
"transmission_statistics_ferc1": {
"capex_land": {
"description": "Cost of Land and land rights for the transmission line."
},
"capex_other": {
"description": "Construction and other costs for the transmission line."
},
"capex_total": {"description": "Total costs for the transmission line."},
"opex_operations": {
"description": "Operating expenses for the transmission line."
},
"opex_maintenance": {
"description": "Maintenance expenses for the transmission line."
},
"opex_rents": {"description": "Rent expenses for the transmission line."},
"opex_total": {"description": "Overall expenses for the transmission line."},
},
"demand_hourly_pa_ferc714": {
"timezone": {
"constraints": {
"enum": [
"America/New_York",
"America/Chicago",
"America/Denver",
"America/Los_Angeles",
"America/Anchorage",
"Pacific/Honolulu",
]
}
},
"report_date": {
"constraints": {
"required": True,
}
},
},
}
[docs]
def get_pudl_dtypes(
group: str | None = None,
field_meta: dict[str, Any] | None = FIELD_METADATA,
field_meta_by_group: dict[str, Any] | None = FIELD_METADATA_BY_GROUP,
dtype_map: dict[str, Any] | None = FIELD_DTYPES_PANDAS,
) -> dict[str, Any]:
"""Compile a dictionary of field dtypes, applying group overrides.
Args:
group: The data group (e.g. ferc1, eia) to use for overriding the default
field types. If None, no overrides are applied and the default types
are used.
field_meta: Field metadata dictionary which at least describes a "type".
field_meta_by_group: Field metadata type overrides to apply based on the data
group that the field is part of, if any.
dtype_map: Mapping from canonical PUDL data types to some other set of data
types. Uses pandas data types by default.
Returns:
A mapping of PUDL field names to their associated data types.
"""
field_meta = deepcopy(field_meta)
dtypes = {}
for f in field_meta:
if f in field_meta_by_group.get(group, []):
field_meta[f].update(field_meta_by_group[group][f])
dtypes[f] = dtype_map[field_meta[f]["type"]]
return dtypes
[docs]
def apply_pudl_dtypes(
df: pd.DataFrame,
group: str | None = None,
field_meta: dict[str, Any] | None = FIELD_METADATA,
field_meta_by_group: dict[str, Any] | None = FIELD_METADATA_BY_GROUP,
) -> pd.DataFrame:
"""Apply dtypes to those columns in a dataframe that have PUDL types defined.
Note that ad-hoc column dtypes can be defined and merged with default PUDL field
metadata before it's passed in as ``field_meta`` if you have module specific column
types you need to apply alongside the standard PUDL field types.
Args:
df: The dataframe to apply types to. Not all columns need to have types
defined in the PUDL metadata.
group: The data group to use for overrides, if any. E.g. "eia", "ferc1".
field_meta: A dictionary of field metadata, where each key is a field name
and the values are dictionaries which must have a "type" element. By
default this is pudl.metadata.fields.FIELD_METADATA.
field_meta_by_group: A dictionary of field metadata to use as overrides,
based on the value of `group`, if any. By default it uses the overrides
defined in pudl.metadata.fields.FIELD_METADATA_BY_GROUP.
Returns:
The input dataframe, but with standard PUDL types applied.
"""
dtypes = get_pudl_dtypes(
group=group,
field_meta=field_meta,
field_meta_by_group=field_meta_by_group,
dtype_map=FIELD_DTYPES_PANDAS,
)
return df.astype({col: dtypes[col] for col in df.columns if col in dtypes})