Output naming changes
v0.24.0
Current behavior
Currently, we use the "year_one" naming convention for many outputs (scalars and time series) that include degradation, making them not a true "year_one" metrics.
We also have some inconsistencies in naming of outputs.
Changes
- Name changes shown in table below
- Generally, changes are for energy outputs (not costs) that include "year_one", and are changed to
annual_for scalars and toelectric_to_,thermal_to_etc. for time series. - Changed
to_tesandto_batteryoutputs toto_storagefor consistency - Included help text to this end in results page for relevant output keys
- Added output: [
CHP][thermal_production_series_mmbtu_per_hour] - Removed outputs: [
Wind][year_one_energy_produced_kwh] and [Generator][year_one_energy_produced_kwh]
| Key | SubKey | Series or Total | Cost or Energy | New Name |
|---|---|---|---|---|
| AbsorptionChiller | year_one_to_tes_series_ton | Series | Energy | thermal_to_storage_series_ton |
| year_one_to_load_series_ton | Series | Energy | thermal_to_load_series_ton | |
| year_one_thermal_consumption_series_mmbtu_per_hour | Series | Energy | thermal_consumption_series_mmbtu_per_hour | |
| year_one_thermal_consumption_mmbtu | Total | Energy | annual_thermal_consumption_mmbtu | |
| year_one_thermal_production_tonhour | Total | Energy | annual_thermal_production_tonhour | |
| year_one_electric_consumption_series_kw | Series | Energy | electric_consumption_series_kw | |
| year_one_electric_consumption_kwh | Total | Energy | annual_electric_consumption_kwh | |
| Boiler | year_one_fuel_consumption_series_mmbtu_per_hour | Series | Energy | fuel_consumption_series_mmbtu_per_hour |
| year_one_fuel_consumption_mmbtu | Total | Energy | annual_fuel_consumption_mmbtu | |
| year_one_thermal_production_series_mmbtu_per_hour | Series | Energy | thermal_production_series_mmbtu_per_hour | |
| year_one_thermal_production_mmbtu | Total | Energy | annual_thermal_production_mmbtu | |
| year_one_thermal_to_tes_series_mmbtu_per_hour | Series | Energy | thermal_to_storage_series_mmbtu_per_hour | |
| year_one_thermal_to_steamturbine_series_mmbtu_per_hour | Series | Energy | thermal_to_steamturbine_series_mmbtu_per_hour | |
| year_one_thermal_to_load_series_mmbtu_per_hour | Series | Energy | thermal_to_load_series_mmbtu_per_hour | |
| lifecycle_fuel_cost | Total | Cost | lifecycle_fuel_cost_after_tax | |
| CHP | year_one_fuel_used_mmbtu | Total | Energy | annual_fuel_consumption_mmbtu |
| year_one_electric_energy_produced_kwh | Total | Energy | annual_electric_production_kwh | |
| year_one_thermal_energy_produced_mmbtu | Total | Energy | annual_thermal_production_mmbtu | |
| year_one_electric_production_series_kw | Series | Energy | electric_production_series_kw | |
| year_one_to_grid_series_kw | Series | Energy | electric_to_grid_series_kw | |
| year_one_to_battery_series_kw | Series | Energy | electric_to_storage_series_kw | |
| year_one_to_load_series_kw | Series | Energy | electric_to_load_series_kw | |
| year_one_thermal_to_tes_series_mmbtu_per_hour | Series | Energy | thermal_to_storage_series_mmbtu_per_hour | |
| year_one_thermal_to_waste_series_mmbtu_per_hour | Series | Energy | thermal_curtailed_series_mmbtu_per_hour | |
| year_one_thermal_to_load_series_mmbtu_per_hour | Series | Energy | thermal_to_load_series_mmbtu_per_hour | |
| year_one_thermal_to_steamturbine_series_mmbtu_per_hour | Series | Energy | thermal_to_steamturbine_series_mmbtu_per_hour | |
| add | Total | Energy | thermal_production_series_mmbtu_per_hour | |
| year_one_chp_fuel_cost_before_tax | Total | Cost | year_one_fuel_cost_before_tax | |
| year_one_chp_standby_cost_before_tax | Total | Cost | year_one_standby_cost_before_tax | |
| lifecycle_chp_fuel_cost_after_tax | Total | Cost | lifecycle_fuel_cost_after_tax | |
| lifecycle_chp_standby_cost_after_tax | Total | Cost | lifecycle_standby_cost_after_tax | |
| ElectricStorage | year_one_soc_series_fraction | Series | Energy | soc_series_fraction |
| year_one_to_load_series_kw | Series | Energy | storage_to_load_series_kw | |
| ElectricUtility | year_one_energy_supplied_kwh | Total | Energy | annual_energy_supplied_kwh |
| year_one_to_load_series_kw | Series | Energy | electric_to_load_series_kw | |
| year_one_to_battery_series_kw | Series | Energy | electric_to_storage_series_kw | |
| year_one_emissions_tonnes_CO2 | Total | Energy | annual_emissions_tonnes_CO2 | |
| year_one_emissions_tonnes_NOx | Total | Energy | annual_emissions_tonnes_Nox | |
| year_one_emissions_tonnes_SO2 | Total | Energy | annual_emissions_tonnes_SO2 | |
| year_one_emissions_tonnes_PM25 | Total | Energy | annual_emissions_tonnes_PM25 | |
| ExistingBoiler | year_one_fuel_consumption_series_mmbtu_per_hour | Series | Energy | fuel_consumption_series_mmbtu_per_hour |
| year_one_fuel_consumption_mmbtu | Total | Energy | annual_fuel_consumption_mmbtu | |
| year_one_thermal_production_series_mmbtu_per_hour | Series | Energy | thermal_production_series_mmbtu_per_hour | |
| year_one_thermal_production_mmbtu | Total | Energy | annual_thermal_production_mmbtu | |
| year_one_thermal_to_tes_series_mmbtu_per_hour | Series | Energy | thermal_to_storage_series_mmbtu_per_hour | |
| year_one_thermal_to_steamturbine_series_mmbtu_per_hour | Series | Energy | thermal_to_steamturbine_series_mmbtu_per_hour | |
| year_one_thermal_to_load_series_mmbtu_per_hour | Series | Energy | thermal_to_load_series_mmbtu_per_hour | |
| ExistingChiller | year_one_to_tes_series_ton | Series | Energy | thermal_to_storage_series_ton |
| year_one_to_load_series_ton | Series | Energy | thermal_to_load_series_ton | |
| year_one_electric_consumption_series_kw | Series | Energy | electric_consumption_series_kw | |
| year_one_electric_consumption_kwh | Total | Energy | annual_electric_consumption_kwh | |
| year_one_thermal_production_tonhour | Total | Energy | annual_thermal_production_tonhour | |
| Generator | year_one_to_battery_series_kw | Series | Energy | electric_to_storage_series_kw |
| year_one_to_grid_series_kw | Series | Energy | electric_to_grid_series_kw | |
| year_one_to_load_series_kw | Series | Energy | electric_to_load_series_kw | |
| year_one_energy_produced_kwh | Total | Energy | Keep as-is for now | |
| average_annual_energy_produced_kwh | Total | Energy | annual_energy_produced_kwh | |
| average_annual_fuel_used_gal | Total | Energy | annual_fuel_consumption_gal | |
| PV | year_one_energy_produced_kwh | Total | Energy | Keep as-is for now |
| average_annual_energy_produced_kwh | Total | Energy | annual_energy_produced_kwh | |
| year_one_to_load_series_kw | Series | Energy | electric_to_load_series_kw | |
| year_one_to_battery_series_kw | Series | Energy | electric_to_storage_series_kw | |
| year_one_to_grid_series_kw | Series | Energy | electric_to_grid_series_kw | |
| year_one_curtailed_production_series_kw | Series | Energy | electric_curtailed_series_kw | |
| average_annual_energy_exported_kwh | Total | Energy | annual_energy_exported_kwh | |
| Site | year_one_emissions_tonnes_CO2 | Total | Energy | annual_emissions_tonnes_CO2 |
| year_one_emissions_tonnes_NOx | Total | Energy | annual_emissions_tonnes_Nox | |
| year_one_emissions_tonnes_SO2 | Total | Energy | annual_emissions_tonnes_SO2 | |
| year_one_emissions_tonnes_PM25 | Total | Energy | annual_emissions_tonnes_PM25 | |
| year_one_emissions_from_fuelburn_tonnes_CO2 | Total | Energy | annual_emissions_from_fuelburn_tonnes_CO2 | |
| year_one_emissions_from_fuelburn_tonnes_NOx | Total | Energy | annual_emissions_from_fuelburn_tonnes_NOx | |
| year_one_emissions_from_fuelburn_tonnes_SO2 | Total | Energy | annual_emissions_from_fuelburn_tonnes_SO2 | |
| year_one_emissions_from_fuelburn_tonnes_PM25 | Total | Energy | annual_emissions_from_fuelburn_tonnes_PM25 | |
| SteamTurbine | year_one_thermal_consumption_mmbtu | Total | Energy | annual_thermal_consumption_mmbtu |
| year_one_electric_energy_produced_kwh | Total | Energy | annual_electric_production_kwh | |
| year_one_thermal_energy_produced_mmbtu | Total | Energy | annual_thermal_production_mmbtu | |
| year_one_thermal_consumption_series_mmbtu_per_hour | Series | Energy | thermal_consumption_series_mmbtu_per_hour | |
| year_one_electric_production_series_kw | Series | Energy | electric_production_series_kw | |
| year_one_electric_to_grid_series_kw | Series | Energy | electric_to_grid_series_kw | |
| year_one_electric_to_battery_series_kw | Series | Energy | electric_to_storage_series_kw | |
| year_one_electric_to_load_series_kw | Series | Energy | electric_to_load_series_kw | |
| year_one_thermal_to_tes_series_mmbtu_per_hour | Series | Energy | thermal_to_storage_series_mmbtu_per_hour | |
| year_one_thermal_to_load_series_mmbtu_per_hour | Series | Energy | thermal_to_load_series_mmbtu_per_hour | |
| HotThermalStorage | year_one_soc_series_fraction | Series | Energy | soc_series_fraction |
| year_one_to_load_series_mmbtu_per_hour | Series | Energy | storage_to_load_series_mmbtu_per_hour | |
| ColdThermalStorage | year_one_soc_series_fraction | Series | Energy | soc_series_fraction |
| year_one_to_load_series_ton | Series | Energy | storage_to_load_series_ton | |
| Wind | year_one_to_battery_series_kw | Series | Energy | electric_to_storage_series_kw |
| year_one_to_grid_series_kw | Series | Energy | electric_to_grid_series_kw | |
| average_annual_energy_exported_kwh | Total | Energy | annual_energy_exported_kwh | |
| year_one_to_load_series_kw | Series | Energy | electric_to_load_series_kw | |
| year_one_energy_produced_kwh | Total | Energy | Keep as-is for now | |
| average_annual_energy_produced_kwh | Total | Energy | annual_energy_produced_kwh | |
| year_one_curtailed_production_series_kw | Series | Energy | electric_curtailed_series_kw |