Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Year one name changes #396

Merged
merged 14 commits into from Jan 10, 2023
Merged

Year one name changes #396

merged 14 commits into from Jan 10, 2023

Conversation

adfarth
Copy link
Collaborator

@adfarth adfarth commented Dec 28, 2022 •
edited

Please check if the PR fulfills these requirements

What kind of change does this PR introduce?

(Bug fix, feature, docs update, ...)

  • Name changes of outputs in job/ app to align with new REopt.jl results naming
  • Removal & addition of outputs to align with REopt.jl results

What is the current behavior?

(You can also link to an open issue here)

  • 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.
  • Some outputs included in the API job/ app are not results in REopt.jl

What is the new behavior (if this is a feature change)?

  • Name changes shown in table below

Does this PR introduce a breaking change?

(What changes might users need to make in their application due to this PR?)
Users should expect different output naming when using the API v3 (job/ app)

Other information:

Key SubKey Series or Total Cost or Energy New Name
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_battery_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_tes_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
  added 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 production_to_load_series_kw
  year_one_to_battery_series_kw Series Energy production_to_battery_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_tes_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 production_to_tes_series_ton
  year_one_to_load_series_ton Series Energy production_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 production_to_battery_series_kw
  year_one_to_grid_series_kw Series Energy production_to_grid_series_kw
  year_one_to_load_series_kw Series Energy production_to_load_series_kw
  year_one_energy_produced_kwh Total Energy REMOVED
  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.
  average_annual_energy_produced_kwh Total Energy annual_energy_produced_kwh
  year_one_to_load_series_kw Series Energy production_to_load_series_kw
  year_one_to_battery_series_kw Series Energy production_to_battery_series_kw
  year_one_to_grid_series_kw Series Energy production_to_grid_series_kw
  year_one_curtailed_production_series_kw Series Energy production_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
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 production_to_battery_series_kw
  year_one_to_grid_series_kw Series Energy production_to_grid_series_kw
  average_annual_energy_exported_kwh Total Energy annual_energy_exported_kwh
  year_one_to_load_series_kw Series Energy production_to_load_series_kw
  year_one_energy_produced_kwh Total Energy REMOVED
  average_annual_energy_produced_kwh Total Energy annual_energy_produced_kwh
  year_one_curtailed_production_series_kw Series Energy production_curtailed_series_kw

adfarth
adfarth commented Dec 28, 2022
View reviewed changes
job/models.py Show resolved Hide resolved
adfarth
adfarth commented Dec 28, 2022
View reviewed changes
job/models.py Outdated Show resolved Hide resolved
@adfarth adfarth marked this pull request as ready for review January 6, 2023 01:44
@adfarth adfarth linked an issue Jan 6, 2023 that may be closed by this pull request
Change "year_one" naming in API #386
Open
@adfarth adfarth merged commit f62d820 into develop Jan 10, 2023
@adfarth adfarth deleted the year-one-name-changes branch January 10, 2023 22:54
@adfarth adfarth mentioned this pull request Jan 11, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Bill-Becker Bill-Becker Bill-Becker approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
new API version with REopt.jl backend
Development

Successfully merging this pull request may close these issues.

Change "year_one" naming in API
2 participants
@adfarth @Bill-Becker