diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml index a413879b3..d82f8a49a 100644 --- a/.github/ISSUE_TEMPLATE/config.yaml +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: Usage question - url: https://github.com/NREL/H2Integrate/discussions - about: Have any questions about using H2Integrate? Post in Discussions to engage with the NREL team and H2Integrate community. + url: https://github.com/NatLabRockies/H2Integrate/discussions + about: Have any questions about using H2Integrate? Post in Discussions to engage with the NLR team and H2Integrate community. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 38eea35b9..c778240b8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -134,11 +134,11 @@ failing test cases. diff --git a/CHANGELOG.md b/CHANGELOG.md index 073bd92a2..08c2baa9e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -156,55 +156,55 @@ ### New Features and Technology Models -- Added PySAM Windpower performance model to simulate wind [PR 306](https://github.com/NREL/H2Integrate/pull/306) -- Added `simple_grid_layout.py` for wind plant layout modeling, can model square or rectangular layouts [PR 306](https://github.com/NREL/H2Integrate/pull/306) -- Added ability to visualize the wind plant layout for PySAM Windpower model using `post_process(show_plots=True)` [PR 306](https://github.com/NREL/H2Integrate/pull/306) -- Added Wind Annual Technology Baseline cost model `atb_wind_cost.py` [PR 306](https://github.com/NREL/H2Integrate/pull/306) -- Added resource models to make solar resource API calls to the NREL Developer GOES dataset [PR 279](https://github.com/NREL/H2Integrate/pull/279) -- Added solar resource models for Meteosat Prime Meridian and Himawari datasets available through NSRDB [PR 377](https://github.com/NREL/H2Integrate/pull/377) -- Added wind resource model for API calls to Open-Meteo archive [PR 332](https://github.com/NREL/H2Integrate/pull/332) -- Added PySAM battery model as a storage technology performance model [PR 211](https://github.com/NREL/H2Integrate/pull/211) -- Added framework to run heuristic load following dispatch for storage technologies [PR 211](https://github.com/NREL/H2Integrate/pull/211) -- Added storage auto-sizing performance model based on storage sizing calculations that existed in the coupled hydrogen storage performance and cost model [PR 324](https://github.com/NREL/H2Integrate/pull/324) -- Added grid converter performance and cost model which can be used to buy, sell, or buy and sell electricity to/from the grid [PR 340](https://github.com/NREL/H2Integrate/pull/340) -- Add feature for natural gas plant converter to take electricity demand as an input and added system capacity as an input [PR 334](https://github.com/NREL/H2Integrate/pull/334) -- Added standalone iron mine performance and cost model [PR 364](https://github.com/NREL/H2Integrate/pull/364) -- Add open-loop load demand controllers: `DemandOpenLoopConverterController` and `FlexibleDemandOpenLoopConverterController` [PR 328](https://github.com/NREL/H2Integrate/pull/328) +- Added PySAM Windpower performance model to simulate wind [PR 306](https://github.com/NatLabRockies/H2Integrate/pull/306) +- Added `simple_grid_layout.py` for wind plant layout modeling, can model square or rectangular layouts [PR 306](https://github.com/NatLabRockies/H2Integrate/pull/306) +- Added ability to visualize the wind plant layout for PySAM Windpower model using `post_process(show_plots=True)` [PR 306](https://github.com/NatLabRockies/H2Integrate/pull/306) +- Added Wind Annual Technology Baseline cost model `atb_wind_cost.py` [PR 306](https://github.com/NatLabRockies/H2Integrate/pull/306) +- Added resource models to make solar resource API calls to the NREL Developer GOES dataset [PR 279](https://github.com/NatLabRockies/H2Integrate/pull/279) +- Added solar resource models for Meteosat Prime Meridian and Himawari datasets available through NSRDB [PR 377](https://github.com/NatLabRockies/H2Integrate/pull/377) +- Added wind resource model for API calls to Open-Meteo archive [PR 332](https://github.com/NatLabRockies/H2Integrate/pull/332) +- Added PySAM battery model as a storage technology performance model [PR 211](https://github.com/NatLabRockies/H2Integrate/pull/211) +- Added framework to run heuristic load following dispatch for storage technologies [PR 211](https://github.com/NatLabRockies/H2Integrate/pull/211) +- Added storage auto-sizing performance model based on storage sizing calculations that existed in the coupled hydrogen storage performance and cost model [PR 324](https://github.com/NatLabRockies/H2Integrate/pull/324) +- Added grid converter performance and cost model which can be used to buy, sell, or buy and sell electricity to/from the grid [PR 340](https://github.com/NatLabRockies/H2Integrate/pull/340) +- Add feature for natural gas plant converter to take electricity demand as an input and added system capacity as an input [PR 334](https://github.com/NatLabRockies/H2Integrate/pull/334) +- Added standalone iron mine performance and cost model [PR 364](https://github.com/NatLabRockies/H2Integrate/pull/364) +- Add open-loop load demand controllers: `DemandOpenLoopConverterController` and `FlexibleDemandOpenLoopConverterController` [PR 328](https://github.com/NatLabRockies/H2Integrate/pull/328) ### Improvements and Refactoring -- Updated inputs for the `ATBBatteryCostModel` and `DemandOpenLoopController` so storage capacity and charge rate can be design variables [PR 290](https://github.com/NREL/H2Integrate/pull/290) -- Split out cost models from coupled hydrogen storage performance and cost model [PR 324](https://github.com/NREL/H2Integrate/pull/324) -- Created `ProFastBase`, a base class for the `ProFastLCO` and `ProFastNPV` models [PR 310](https://github.com/NREL/H2Integrate/pull/310) -- Added `ProFastNPV`, a finance model using ProFAST to calculate NPV of the commodity [PR 310](https://github.com/NREL/H2Integrate/pull/310) -- Moved `compute()` from `ProFastBase` to `ProFastLCO` [PR 310](https://github.com/NREL/H2Integrate/pull/310) -- Added `NumpyFinancialNPV`, a finance model that uses NumPy Financial npv to calculate the npv from the cash flows [PR 310](https://github.com/NREL/H2Integrate/pull/310) -- Added capability for user-defined finance models in the H2Integrate framework [PR 247](https://github.com/NREL/H2Integrate/pull/247) -- Enabled dynamic plant component sizing modes through the resizeable model class `ResizeablePerformanceModelBaseClass` [PR 198](https://github.com/NREL/H2Integrate/pull/198) -- Move geologic hydrogen models into specific geoh2 subsurface converters [PR 367](https://github.com/NREL/H2Integrate/pull/367) -- Updated generic combiner to accept any number of inflow streams instead of just 2 [PR 406](https://github.com/NREL/H2Integrate/pull/406) -- Allow multiple instances of the same electricity producing technologies using prefix-based matching [PR 397](https://github.com/NREL/H2Integrate/pull/397) -- Allow multiple instances of custom models in the same hybrid system [PR 397](https://github.com/NREL/H2Integrate/pull/397) -- Removed a large portion of the old GreenHEART code that was no longer being used [PR 384](https://github.com/NREL/H2Integrate/pull/384) -- Moved high-level tests to the appropriate directory and removed defunct tests [PR 412](https://github.com/NREL/H2Integrate/pull/412) +- Updated inputs for the `ATBBatteryCostModel` and `DemandOpenLoopController` so storage capacity and charge rate can be design variables [PR 290](https://github.com/NatLabRockies/H2Integrate/pull/290) +- Split out cost models from coupled hydrogen storage performance and cost model [PR 324](https://github.com/NatLabRockies/H2Integrate/pull/324) +- Created `ProFastBase`, a base class for the `ProFastLCO` and `ProFastNPV` models [PR 310](https://github.com/NatLabRockies/H2Integrate/pull/310) +- Added `ProFastNPV`, a finance model using ProFAST to calculate NPV of the commodity [PR 310](https://github.com/NatLabRockies/H2Integrate/pull/310) +- Moved `compute()` from `ProFastBase` to `ProFastLCO` [PR 310](https://github.com/NatLabRockies/H2Integrate/pull/310) +- Added `NumpyFinancialNPV`, a finance model that uses NumPy Financial npv to calculate the npv from the cash flows [PR 310](https://github.com/NatLabRockies/H2Integrate/pull/310) +- Added capability for user-defined finance models in the H2Integrate framework [PR 247](https://github.com/NatLabRockies/H2Integrate/pull/247) +- Enabled dynamic plant component sizing modes through the resizeable model class `ResizeablePerformanceModelBaseClass` [PR 198](https://github.com/NatLabRockies/H2Integrate/pull/198) +- Move geologic hydrogen models into specific geoh2 subsurface converters [PR 367](https://github.com/NatLabRockies/H2Integrate/pull/367) +- Updated generic combiner to accept any number of inflow streams instead of just 2 [PR 406](https://github.com/NatLabRockies/H2Integrate/pull/406) +- Allow multiple instances of the same electricity producing technologies using prefix-based matching [PR 397](https://github.com/NatLabRockies/H2Integrate/pull/397) +- Allow multiple instances of custom models in the same hybrid system [PR 397](https://github.com/NatLabRockies/H2Integrate/pull/397) +- Removed a large portion of the old GreenHEART code that was no longer being used [PR 384](https://github.com/NatLabRockies/H2Integrate/pull/384) +- Moved high-level tests to the appropriate directory and removed defunct tests [PR 412](https://github.com/NatLabRockies/H2Integrate/pull/412) ### Configuration and Optimization -- Added `tools/run_cases.py` with tools to run different `tech_config` cases from a spreadsheet, with new docs page to describe: docs/user_guide/how_to_run_several_cases_in_sequence.md [PR 242](https://github.com/NREL/H2Integrate/pull/242) -- Updated setting up recorder in `PoseOptimization` [PR 291](https://github.com/NREL/H2Integrate/pull/291) -- Added `create_om_reports` option to driver config to enable/disable OpenMDAO reports (N2 diagrams, etc.) [PR 308](https://github.com/NREL/H2Integrate/pull/308) -- Added design of experiment functionality [PR 314](https://github.com/NREL/H2Integrate/pull/314) -- Added "csvgen" as generator type for design of experiments [PR 314](https://github.com/NREL/H2Integrate/pull/314) -- Added `load_yaml()` function and flexibility to input a config dictionary to H2IntegrateModel rather than a filepath [PR 313](https://github.com/NREL/H2Integrate/pull/313) -- Removed `boundaries` from the necessary keys in `plant_config` validation [PR 361](https://github.com/NREL/H2Integrate/pull/361) -- Added ability for latitude and longitude to be design variables in design sweep [PR 336](https://github.com/NREL/H2Integrate/pull/336) +- Added `tools/run_cases.py` with tools to run different `tech_config` cases from a spreadsheet, with new docs page to describe: docs/user_guide/how_to_run_several_cases_in_sequence.md [PR 242](https://github.com/NatLabRockies/H2Integrate/pull/242) +- Updated setting up recorder in `PoseOptimization` [PR 291](https://github.com/NatLabRockies/H2Integrate/pull/291) +- Added `create_om_reports` option to driver config to enable/disable OpenMDAO reports (N2 diagrams, etc.) [PR 308](https://github.com/NatLabRockies/H2Integrate/pull/308) +- Added design of experiment functionality [PR 314](https://github.com/NatLabRockies/H2Integrate/pull/314) +- Added "csvgen" as generator type for design of experiments [PR 314](https://github.com/NatLabRockies/H2Integrate/pull/314) +- Added `load_yaml()` function and flexibility to input a config dictionary to H2IntegrateModel rather than a filepath [PR 313](https://github.com/NatLabRockies/H2Integrate/pull/313) +- Removed `boundaries` from the necessary keys in `plant_config` validation [PR 361](https://github.com/NatLabRockies/H2Integrate/pull/361) +- Added ability for latitude and longitude to be design variables in design sweep [PR 336](https://github.com/NatLabRockies/H2Integrate/pull/336) ### Documentation, Examples, and Miscellaneous -- Added an optimized offshore methanol production case to examples/03_methanol/co2_hydrogenation_doc [PR 137](https://github.com/NREL/H2Integrate/pull/137) -- Improved the readability of the postprocessing printout [PR 361](https://github.com/NREL/H2Integrate/pull/361) -- Improved readability of the postprocessing printout by simplifying numerical representation, especially for years [PR 378](https://github.com/NREL/H2Integrate/pull/378) -- Fixed stoichiometry mistake in ammonia synloop [PR 363](https://github.com/NREL/H2Integrate/pull/363) +- Added an optimized offshore methanol production case to examples/03_methanol/co2_hydrogenation_doc [PR 137](https://github.com/NatLabRockies/H2Integrate/pull/137) +- Improved the readability of the postprocessing printout [PR 361](https://github.com/NatLabRockies/H2Integrate/pull/361) +- Improved readability of the postprocessing printout by simplifying numerical representation, especially for years [PR 378](https://github.com/NatLabRockies/H2Integrate/pull/378) +- Fixed stoichiometry mistake in ammonia synloop [PR 363](https://github.com/NatLabRockies/H2Integrate/pull/363) ## 0.4.0 [October 1, 2025] @@ -212,70 +212,70 @@ This release introduces significant new technology models and framework capabili ### New Features and Technology Models -- Added capability for user-defined technologies in the H2Integrate framework, allowing for custom models to be integrated into the system [PR 128](https://github.com/NREL/H2Integrate/pull/128). -- Added a check for if a custom model's name clashes with an existing model name in the H2Integrate framework, raising an error if it does [PR 128](https://github.com/NREL/H2Integrate/pull/128). -- Added geologic hydrogen (GeoH2) converter and examples [PR 135](https://github.com/NREL/H2Integrate/pull/135). -- Added methanol production base class [PR 137](https://github.com/NREL/H2Integrate/pull/137). -- Added steam methane reforming methanol production technology [PR 137](https://github.com/NREL/H2Integrate/pull/137). -- Added CO2 hydrogenation methanol production technology [PR 137](https://github.com/NREL/H2Integrate/pull/137). -- Added run of river hydro plant model, an example, and a documentation page [PR 145](https://github.com/NREL/H2Integrate/pull/145). -- Added marine carbon capture base class [PR 165](https://github.com/NREL/H2Integrate/pull/165). -- Added direct ocean capture technology [PR 165](https://github.com/NREL/H2Integrate/pull/165). -- Added ammonia synloop, partially addressing [Issue 169](https://github.com/NREL/H2Integrate/issues/169) [PR 177](https://github.com/NREL/H2Integrate/pull/177). -- Added simple air separation unit (ASU) converter to model nitrogen production [PR 179](https://github.com/NREL/H2Integrate/pull/179). -- Added rule-based storage system control capability (e.g., for battery, H2, CO2) [PR 195](https://github.com/NREL/H2Integrate/pull/195). -- Added ocean alkalinity enhancement technology model [PR 212](https://github.com/NREL/H2Integrate/pull/212). -- Added `natural_gas_performance` and `natural_gas_cost` models, allowing for natural gas power plant modeling [PR 221](https://github.com/NREL/H2Integrate/pull/221). -- Added wind resource model, API baseclasses, updated examples, and documentation [PR 245](https://github.com/NREL/H2Integrate/pull/245). -- Added generic storage model, useful for battery, hydrogen, CO2, or other resource storage [PR 248](https://github.com/NREL/H2Integrate/pull/248). +- Added capability for user-defined technologies in the H2Integrate framework, allowing for custom models to be integrated into the system [PR 128](https://github.com/NatLabRockies/H2Integrate/pull/128). +- Added a check for if a custom model's name clashes with an existing model name in the H2Integrate framework, raising an error if it does [PR 128](https://github.com/NatLabRockies/H2Integrate/pull/128). +- Added geologic hydrogen (GeoH2) converter and examples [PR 135](https://github.com/NatLabRockies/H2Integrate/pull/135). +- Added methanol production base class [PR 137](https://github.com/NatLabRockies/H2Integrate/pull/137). +- Added steam methane reforming methanol production technology [PR 137](https://github.com/NatLabRockies/H2Integrate/pull/137). +- Added CO2 hydrogenation methanol production technology [PR 137](https://github.com/NatLabRockies/H2Integrate/pull/137). +- Added run of river hydro plant model, an example, and a documentation page [PR 145](https://github.com/NatLabRockies/H2Integrate/pull/145). +- Added marine carbon capture base class [PR 165](https://github.com/NatLabRockies/H2Integrate/pull/165). +- Added direct ocean capture technology [PR 165](https://github.com/NatLabRockies/H2Integrate/pull/165). +- Added ammonia synloop, partially addressing [Issue 169](https://github.com/NatLabRockies/H2Integrate/issues/169) [PR 177](https://github.com/NatLabRockies/H2Integrate/pull/177). +- Added simple air separation unit (ASU) converter to model nitrogen production [PR 179](https://github.com/NatLabRockies/H2Integrate/pull/179). +- Added rule-based storage system control capability (e.g., for battery, H2, CO2) [PR 195](https://github.com/NatLabRockies/H2Integrate/pull/195). +- Added ocean alkalinity enhancement technology model [PR 212](https://github.com/NatLabRockies/H2Integrate/pull/212). +- Added `natural_gas_performance` and `natural_gas_cost` models, allowing for natural gas power plant modeling [PR 221](https://github.com/NatLabRockies/H2Integrate/pull/221). +- Added wind resource model, API baseclasses, updated examples, and documentation [PR 245](https://github.com/NatLabRockies/H2Integrate/pull/245). +- Added generic storage model, useful for battery, hydrogen, CO2, or other resource storage [PR 248](https://github.com/NatLabRockies/H2Integrate/pull/248). ### Improvements and Refactoring -- Removed the `to_organize` directory [PR 138](https://github.com/NREL/H2Integrate/pull/138). -- Updated the naming scheme throughout the framework so resources produced always have `_out` and resources consumed always have `_in` in their names [PR 148](https://github.com/NREL/H2Integrate/pull/148). -- Added ability to export ProFAST object to yaml file in `ProFastComp` [PR 207](https://github.com/NREL/H2Integrate/pull/207). -- Refactored `ProFastComp` and put in a new file (`h2integrate/core/profast_financial.py`). Added flexibility to allow users to specify different financial models [PR 218](https://github.com/NREL/H2Integrate/pull/218). -- Revamped the feedstocks technology group to allow for more precise modeling of feedstock supply chains, including capacity constraints and feedstock amount consumed [PR 221](https://github.com/NREL/H2Integrate/pull/221). -- Made `pipe` and `cable` substance-agnostic rather than hard-coded for `hydrogen` and `electricity` [PR 241](https://github.com/NREL/H2Integrate/pull/241). -- Updated option to pass variables in technology interconnections to allow for different variable names from source to destination in the format `[source_tech, dest_tech, (source_tech_variable, dest_tech_variable)]` [PR 236](https://github.com/NREL/H2Integrate/pull/236). -- Split out the electrolyzer cost models `basic` and `singlitico` for clarity [PR 147](https://github.com/NREL/H2Integrate/pull/147). -- Refactored the ammonia production model to use the new H2Integrate framework natively and removed the prior performance and cost functions [PR 163](https://github.com/NREL/H2Integrate/pull/163). -- Added a new ammonia production model which has nitrogen, hydrogen, and electricity inputs and ammonia output, with performance and cost functions [PR 163](https://github.com/NREL/H2Integrate/pull/163). -- Added WOMBAT electrolyzer O&M model [PR 168](https://github.com/NREL/H2Integrate/pull/168). -- Changed electrolyzer capacity to be specified as `n_clusters` rather than `rating` in electrolyzer performance model config [PR 194](https://github.com/NREL/H2Integrate/pull/194). -- Changed electrolyzer capacity to be an input to the electrolyzer cost models rather than pulled from the cost model config [PR 194](https://github.com/NREL/H2Integrate/pull/194). -- Added cost model base class and removed `plant_config['finance_parameters']['discount_years']['tech']`. Cost year is now an optional input (`tech_config[tech]['model_inputs']['cost_parameters']['cost_year']`) and a discrete output [PR 199](https://github.com/NREL/H2Integrate/pull/199). -- Added two ATB-compatible solar-PV cost models [PR 193](https://github.com/NREL/H2Integrate/pull/193). -- Update PySAM solar performance model to allow for more user-configurability [PR 187](https://github.com/NREL/H2Integrate/pull/187). -- Added `"custom_electrolyzer_cost"` model, an electrolyzer cost model that allows for user-defined CapEx and OpEx values [PR 227](https://github.com/NREL/H2Integrate/pull/227). -- Added variable O&M to `CostModelBaseClass` and integrated into finance-related models [PR 235](https://github.com/NREL/H2Integrate/pull/235). -- Improved `h2integrate/transporters/power_combiner.py` and enabled usage of multiple electricity producing technologies [PR 232](https://github.com/NREL/H2Integrate/pull/232). +- Removed the `to_organize` directory [PR 138](https://github.com/NatLabRockies/H2Integrate/pull/138). +- Updated the naming scheme throughout the framework so resources produced always have `_out` and resources consumed always have `_in` in their names [PR 148](https://github.com/NatLabRockies/H2Integrate/pull/148). +- Added ability to export ProFAST object to yaml file in `ProFastComp` [PR 207](https://github.com/NatLabRockies/H2Integrate/pull/207). +- Refactored `ProFastComp` and put in a new file (`h2integrate/core/profast_financial.py`). Added flexibility to allow users to specify different financial models [PR 218](https://github.com/NatLabRockies/H2Integrate/pull/218). +- Revamped the feedstocks technology group to allow for more precise modeling of feedstock supply chains, including capacity constraints and feedstock amount consumed [PR 221](https://github.com/NatLabRockies/H2Integrate/pull/221). +- Made `pipe` and `cable` substance-agnostic rather than hard-coded for `hydrogen` and `electricity` [PR 241](https://github.com/NatLabRockies/H2Integrate/pull/241). +- Updated option to pass variables in technology interconnections to allow for different variable names from source to destination in the format `[source_tech, dest_tech, (source_tech_variable, dest_tech_variable)]` [PR 236](https://github.com/NatLabRockies/H2Integrate/pull/236). +- Split out the electrolyzer cost models `basic` and `singlitico` for clarity [PR 147](https://github.com/NatLabRockies/H2Integrate/pull/147). +- Refactored the ammonia production model to use the new H2Integrate framework natively and removed the prior performance and cost functions [PR 163](https://github.com/NatLabRockies/H2Integrate/pull/163). +- Added a new ammonia production model which has nitrogen, hydrogen, and electricity inputs and ammonia output, with performance and cost functions [PR 163](https://github.com/NatLabRockies/H2Integrate/pull/163). +- Added WOMBAT electrolyzer O&M model [PR 168](https://github.com/NatLabRockies/H2Integrate/pull/168). +- Changed electrolyzer capacity to be specified as `n_clusters` rather than `rating` in electrolyzer performance model config [PR 194](https://github.com/NatLabRockies/H2Integrate/pull/194). +- Changed electrolyzer capacity to be an input to the electrolyzer cost models rather than pulled from the cost model config [PR 194](https://github.com/NatLabRockies/H2Integrate/pull/194). +- Added cost model base class and removed `plant_config['finance_parameters']['discount_years']['tech']`. Cost year is now an optional input (`tech_config[tech]['model_inputs']['cost_parameters']['cost_year']`) and a discrete output [PR 199](https://github.com/NatLabRockies/H2Integrate/pull/199). +- Added two ATB-compatible solar-PV cost models [PR 193](https://github.com/NatLabRockies/H2Integrate/pull/193). +- Update PySAM solar performance model to allow for more user-configurability [PR 187](https://github.com/NatLabRockies/H2Integrate/pull/187). +- Added `"custom_electrolyzer_cost"` model, an electrolyzer cost model that allows for user-defined CapEx and OpEx values [PR 227](https://github.com/NatLabRockies/H2Integrate/pull/227). +- Added variable O&M to `CostModelBaseClass` and integrated into finance-related models [PR 235](https://github.com/NatLabRockies/H2Integrate/pull/235). +- Improved `h2integrate/transporters/power_combiner.py` and enabled usage of multiple electricity producing technologies [PR 232](https://github.com/NatLabRockies/H2Integrate/pull/232). ### Configuration and Optimization -- Updated finance parameter organization naming in `plant_config` [PR 218](https://github.com/NREL/H2Integrate/pull/218). -- Changed finance handling to use `finance_subgroups` and `finance_groups` defined in the `plant_config` rather than previous `financial_groups` in the `tech_config` and `technologies_to_include_in_metrics` in `plant_config` [PR 240](https://github.com/NREL/H2Integrate/pull/240). -- Allow users to specify the technologies to include in the metrics calculations in the plant configuration file [PR 240](https://github.com/NREL/H2Integrate/pull/240). -- Added option for user to provide ProFAST parameters in finance parameters [PR 240](https://github.com/NREL/H2Integrate/pull/240). -- Changed `plant_config` `atb_year` entry to `financial_analysis_start_year` [PR 190](https://github.com/NREL/H2Integrate/pull/190). -- Added `simulation` section under `plant_config['plant']` that has information such as number of timesteps in the simulation, time step interval in seconds, simulation start time, and time zone [PR 219](https://github.com/NREL/H2Integrate/pull/219). -- Moved `overwrite_fin_values` to HOPP [PR 164](https://github.com/NREL/H2Integrate/pull/164). -- Enable optimization with HOPP technology ratings using `recreate_hopp_config_for_optimization` [PR 164](https://github.com/NREL/H2Integrate/pull/164). -- Made caching in the HOPP wrapper optional [PR 164](https://github.com/NREL/H2Integrate/pull/164). -- Added more available constraints from the HOPP wrapper useful for design optimizations [PR 164](https://github.com/NREL/H2Integrate/pull/164). +- Updated finance parameter organization naming in `plant_config` [PR 218](https://github.com/NatLabRockies/H2Integrate/pull/218). +- Changed finance handling to use `finance_subgroups` and `finance_groups` defined in the `plant_config` rather than previous `financial_groups` in the `tech_config` and `technologies_to_include_in_metrics` in `plant_config` [PR 240](https://github.com/NatLabRockies/H2Integrate/pull/240). +- Allow users to specify the technologies to include in the metrics calculations in the plant configuration file [PR 240](https://github.com/NatLabRockies/H2Integrate/pull/240). +- Added option for user to provide ProFAST parameters in finance parameters [PR 240](https://github.com/NatLabRockies/H2Integrate/pull/240). +- Changed `plant_config` `atb_year` entry to `financial_analysis_start_year` [PR 190](https://github.com/NatLabRockies/H2Integrate/pull/190). +- Added `simulation` section under `plant_config['plant']` that has information such as number of timesteps in the simulation, time step interval in seconds, simulation start time, and time zone [PR 219](https://github.com/NatLabRockies/H2Integrate/pull/219). +- Moved `overwrite_fin_values` to HOPP [PR 164](https://github.com/NatLabRockies/H2Integrate/pull/164). +- Enable optimization with HOPP technology ratings using `recreate_hopp_config_for_optimization` [PR 164](https://github.com/NatLabRockies/H2Integrate/pull/164). +- Made caching in the HOPP wrapper optional [PR 164](https://github.com/NatLabRockies/H2Integrate/pull/164). +- Added more available constraints from the HOPP wrapper useful for design optimizations [PR 164](https://github.com/NatLabRockies/H2Integrate/pull/164). ### Documentation, Examples, and Miscellaneous -- Added an example of a user-defined technology in the `examples` directory, demonstrating an extremely simple paper mill model [PR 128](https://github.com/NREL/H2Integrate/pull/128). -- Added example for running with HOPP as the only technology in the H2Integrate system [PR 164](https://github.com/NREL/H2Integrate/pull/164). -- Added an optimization example with a wind plant and electrolyzer to showcase how to define design variables, constraints, and objective functions [PR 126](https://github.com/NREL/H2Integrate/pull/126). -- Expanded docs to include a new section on modifying config dicts after model instantiation [PR 151](https://github.com/NREL/H2Integrate/pull/151). -- Added `*_out/` to `.gitignore` to avoid clutter [PR 191](https://github.com/NREL/H2Integrate/pull/191). -- Bump min Python version and removed unnecessary packages from `pyproject.toml` [PR 150](https://github.com/NREL/H2Integrate/pull/150). -- Bugfix: only run `pyxdsm` when there are connections in the system [PR 201](https://github.com/NREL/H2Integrate/pull/201). +- Added an example of a user-defined technology in the `examples` directory, demonstrating an extremely simple paper mill model [PR 128](https://github.com/NatLabRockies/H2Integrate/pull/128). +- Added example for running with HOPP as the only technology in the H2Integrate system [PR 164](https://github.com/NatLabRockies/H2Integrate/pull/164). +- Added an optimization example with a wind plant and electrolyzer to showcase how to define design variables, constraints, and objective functions [PR 126](https://github.com/NatLabRockies/H2Integrate/pull/126). +- Expanded docs to include a new section on modifying config dicts after model instantiation [PR 151](https://github.com/NatLabRockies/H2Integrate/pull/151). +- Added `*_out/` to `.gitignore` to avoid clutter [PR 191](https://github.com/NatLabRockies/H2Integrate/pull/191). +- Bump min Python version and removed unnecessary packages from `pyproject.toml` [PR 150](https://github.com/NatLabRockies/H2Integrate/pull/150). +- Bugfix: only run `pyxdsm` when there are connections in the system [PR 201](https://github.com/NatLabRockies/H2Integrate/pull/201). ## 0.3.0 [May 2, 2025] @@ -286,7 +286,7 @@ This release introduces significant new technology models and framework capabili ## 0.2.1 Unreleased, TBD -- Fixed iron data save issue [PR 122](https://github.com/NREL/H2Integrate/pull/122) +- Fixed iron data save issue [PR 122](https://github.com/NatLabRockies/H2Integrate/pull/122) - Added optional inputs to electrolyzer model, including curve coefficients and water usage rate. - Bug-fix in electrolyzer outputs (H2_Results) if some stacks are never turned on. @@ -294,7 +294,7 @@ This release introduces significant new technology models and framework capabili - Allow users to save the H2IntegrateOutput class as a yaml file and read that yaml to an instance of the output class - Include new plotting capabilities: (1) hydrogen storage, production, and dispatch; (2) electricity and hydrogen dispatch -- Remove reference_plants from examples. Reference plants can now be found in the [ReferenceHybridSystemDesigns](https://github.com/NREL/ReferenceHybridSystemDesigns) repository. +- Remove reference_plants from examples. Reference plants can now be found in the [ReferenceHybridSystemDesigns](https://github.com/NatLabRockies/ReferenceHybridSystemDesigns) repository. - Use sentence capitalization for plot labels and legends - Use "metric ton" instead of "tonne" or "metric tonne" in all internal naming and plots - Fix bug in hydrogen dispatch plotting by storing time series of hydrogen demand by hour @@ -303,11 +303,11 @@ This release introduces significant new technology models and framework capabili - Removed defunct conda build and upload scripts - Return full solution dictionary from ProFAST, allowing access to CRF and WACC - Renamed code from GreenHEART to H2Integrate -- Added iron processing framework and capabilities [PR 90](https://github.com/NREL/H2Integrate/pull/90) -- Added Martin and Rosner iron ore models, performance and cost for each [PR 90](https://github.com/NREL/H2Integrate/pull/90) -- Added Rosner direct reduction iron (DRI) model, performance and cost [PR 90](https://github.com/NREL/H2Integrate/pull/90) -- Added Martin transport module for performance and cost of iron [PR 90](https://github.com/NREL/H2Integrate/pull/90) -- Added generalized Stinn cost model for electrolysis of arbitrary materials [PR 90](https://github.com/NREL/H2Integrate/pull/90) +- Added iron processing framework and capabilities [PR 90](https://github.com/NatLabRockies/H2Integrate/pull/90) +- Added Martin and Rosner iron ore models, performance and cost for each [PR 90](https://github.com/NatLabRockies/H2Integrate/pull/90) +- Added Rosner direct reduction iron (DRI) model, performance and cost [PR 90](https://github.com/NatLabRockies/H2Integrate/pull/90) +- Added Martin transport module for performance and cost of iron [PR 90](https://github.com/NatLabRockies/H2Integrate/pull/90) +- Added generalized Stinn cost model for electrolysis of arbitrary materials [PR 90](https://github.com/NatLabRockies/H2Integrate/pull/90) ## v0.1.4 [4 February, 2025] diff --git a/README.md b/README.md index a15f7fbdd..eb7642b21 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # H2Integrate: Holistic Hybrids Optimization and Design Tool [![PyPI version](https://badge.fury.io/py/H2Integrate.svg)](https://badge.fury.io/py/H2Integrate) -![CI Tests](https://github.com/NREL/H2Integrate/actions/workflows/ci.yml/badge.svg) +![CI Tests](https://github.com/NatLabRockies/H2Integrate/actions/workflows/ci.yml/badge.svg) [![image](https://img.shields.io/pypi/pyversions/H2Integrate.svg)](https://pypi.python.org/pypi/H2Integrate) [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![DOI:10.5281/zenodo.17903150](https://zenodo.org/badge/DOI/10.5281/zenodo.17903149.svg)](https://zenodo.org/records/17903149) @@ -113,7 +113,7 @@ pip install h2integrate 1. Using Git, navigate to a local target directory and clone repository: ```bash - git clone https://github.com/NREL/H2Integrate.git + git clone https://github.com/NatLabRockies/H2Integrate.git ``` 2. Navigate to `H2Integrate` @@ -156,7 +156,7 @@ pip install -e ".[all]" 1. Using Git, navigate to a local target directory and clone repository: ```bash - git clone https://github.com/NREL/H2Integrate.git + git clone https://github.com/NatLabRockies/H2Integrate.git ``` 2. Navigate to `H2Integrate` diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 441544b02..d33ccb64e 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -3,9 +3,9 @@ We welcome contributions in the form of bug reports, bug fixes, improvements to the documentation, ideas for enhancements (or the enhancements themselves!). -You can find a [list of current issues](https://github.com/NREL/H2Integrate/issues) in the project's +You can find a [list of current issues](https://github.com/NatLabRockies/H2Integrate/issues) in the project's GitHub repo. Feel free to tackle any existing bugs or enhancement ideas by submitting a -[pull request](https://github.com/NREL/H2Integrate/pulls). +[pull request](https://github.com/NatLabRockies/H2Integrate/pulls). ## Bug Reports @@ -21,7 +21,7 @@ GitHub repo. Feel free to tackle any existing bugs or enhancement ideas by submi * Docstrings are required and should follow the [Google style](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html). * When you start working on a pull request, start by creating a new branch pointing at the latest - commit on [main](https://github.com/NREL/H2Integrate). + commit on [main](https://github.com/NatLabRockies/H2Integrate). * Code formatting is enforced using pre-commit hooks and is required for any code pushed up to the repository. The pre-commit package is included in the developer install of the repository. The pre-commit hooks can be installed by running ```bash pre-commit install @@ -31,7 +31,7 @@ in the repository directory. This will automatically run the pre-commit formatti git commit -am "" ``` which will re-add the reformatted files to the commit. -* The H2Integrate copyright policy is detailed in the [`LICENSE`](https://github.com/NREL/H2Integrate/blob/main/LICENSE). +* The H2Integrate copyright policy is detailed in the [`LICENSE`](https://github.com/NatLabRockies/H2Integrate/blob/main/LICENSE). ## Documentation @@ -89,7 +89,7 @@ pytest tests/h2integrate/test_hybrid.py::test_h2integrate_system ``` When you push to your fork, or open a PR, your tests will be run against the -[Continuous Integration (CI)](https://github.com/NREL/HOPP/actions) suite. This will start a build +[Continuous Integration (CI)](https://github.com/NatLabRockies/HOPP/actions) suite. This will start a build that runs all tests on your branch against multiple Python versions, and will also test documentation builds. @@ -142,7 +142,7 @@ met the following steps should be taken to create a new release ``` 6. Check that the - [Test PyPI GitHub Action](https://github.com/NREL/H2Integrate/actions/workflows/publish_to_test_pypi.yml) + [Test PyPI GitHub Action](https://github.com/NatLabRockies/H2Integrate/actions/workflows/publish_to_test_pypi.yml) has run successfully. 1. If the action failed, identify and fix the issue, then 2. delete the local and remote tag using the following (replace "v0.1" in all instances just like @@ -155,7 +155,7 @@ met the following steps should be taken to create a new release 3. Start back at step 1. 7. When the Test PyPI Action has successfully run, - [create a new release](https://github.com/NREL/H2Integrate/releases/new) using the tag created in + [create a new release](https://github.com/NatLabRockies/H2Integrate/releases/new) using the tag created in step 5. ### Patches @@ -167,4 +167,4 @@ below: 1. All CI tests pass and the patch version has been bumped according to the [semantic versioning guidelines](https://semver.org/). 2. Follow steps 4 through 7 above. -3. Merge the NREL main branch back into the develop branch and push the changes. +3. Merge the NLR main branch back into the develop branch and push the changes. diff --git a/docs/_config.yml b/docs/_config.yml index 10effe641..a140e3997 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -24,7 +24,7 @@ latex: targetname: book.tex # Information about where the book exists on the web repository: - url: https://github.com/NREL/H2Integrate + url: https://github.com/NatLabRockies/H2Integrate path_to_book: docs branch: main # Add GitHub buttons to your book @@ -39,33 +39,6 @@ sphinx: - sphinx.ext.autosummary - sphinx.ext.napoleon config: - # html_theme: sphinx_book_theme - # html_theme_options: - # use_issues_button: true - # use_repository_button: true - # use_edit_page_button: true - # show_toc_level: 2 - # repository_url: https://github.com/NREL/WAVES - # repository_branch: main - # icon_links: [ - # { - # name: GitHub, - # url: https://github.com/NREL/WAVES, - # icon: fa-brands fa-github, - # }, - # { - # name: PyPI version, - # url: https://pypi.org/project/WAVES/, - # icon: "https://img.shields.io/pypi/v/WAVES?link=https%3A%2F%2Fpypi.org%2Fproject%2FWAVES%2F", - # type: url, - # }, - # { - # name: Binder, - # url: "https://mybinder.org/v2/gh/NREL/WAVES/main?filepath=examples", - # icon: "https://mybinder.org/badge_logo.svg", - # type: url, - # }, - # ] language: python autosummary_generate: true autodoc_default_options: diff --git a/docs/developer_guide/why_make_h2integrate.md b/docs/developer_guide/why_make_h2integrate.md index 7d2d48768..851813c36 100644 --- a/docs/developer_guide/why_make_h2integrate.md +++ b/docs/developer_guide/why_make_h2integrate.md @@ -45,7 +45,7 @@ Using OpenMDAO for this gives quite a few benefits: - internal units handling and conversion - built-in nonlinear solvers to resolve model coupling - built-in optimization and parameter sweep drivers -- multiple existing NREL tools use OpenMDAO, including [WISDEM](https://github.com/WISDEM/WISDEM/) and [WEIS](https://github.com/WISDEM/WEIS), so we can draw from institutional knowledge +- multiple existing NLR tools use OpenMDAO, including [WISDEM](https://github.com/NLRWindSystems/WISDEM/) and [WEIS](https://github.com/NLRWindSystems/WEIS), so we can draw from institutional knowledge - set up with gradient-based optimization in mind, which is not currently a focus for H2Integrate but this positions the tool well for potential future additions - parallelization done using MPI, which is also not currently a focus but useful for the future @@ -60,7 +60,7 @@ Additionally, we can code H2Integrate in a way to minimize some of the potential ## Where does HOPP come into play? -[HOPP](https://github.com/NREL/HOPP) is a well-structured and useful tool that analyzes hybrid plants producing electricity. +[HOPP](https://github.com/NatLabRockies/HOPP) is a well-structured and useful tool that analyzes hybrid plants producing electricity. H2Integrate historically calls HOPP to obtain the plant's outputted electricity, which is then used downstream to feed into electrolyzers, steel, and other components. The current setup of H2Integrate largely works in the same way. diff --git a/docs/finance_models/ProFastBase.md b/docs/finance_models/ProFastBase.md index baa212e77..b2ce0798e 100644 --- a/docs/finance_models/ProFastBase.md +++ b/docs/finance_models/ProFastBase.md @@ -1,10 +1,10 @@ (profastmodel:profastmodel)= # ProFAST Financial Model -The Production Financial Analysis Scenario Tool or (ProFAST)[https://www.nrel.gov/hydrogen/profast-access] is a financial modeling tool developed at the NREL based on General Accepted Accounting Principles (GAAP) methodology. The model provides a quick and convenient way to conduct in-depth financial analysis for production system and services. +The Production Financial Analysis Scenario Tool or (ProFAST)[https://www.nlr.gov/hydrogen/profast-access] is a financial modeling tool developed at the NLR based on General Accepted Accounting Principles (GAAP) methodology. The model provides a quick and convenient way to conduct in-depth financial analysis for production system and services. Currently there are two ProFAST models that can be used: -- [``ProFastLCO``](profastcomp:profastcompmodel): A price-taker model that calculates levelized cost of commodity (or breakeven price) using [ProFAST](https://github.com/NREL/ProFAST). -- [``ProFastNPV``](profastnpv:profastnpvmodel): A price-setter model that calculates the net present value of a commodity using [ProFAST](https://github.com/NREL/ProFAST). +- [``ProFastLCO``](profastcomp:profastcompmodel): A price-taker model that calculates levelized cost of commodity (or breakeven price) using [ProFAST](https://github.com/NatLabRockies/ProFAST). +- [``ProFastNPV``](profastnpv:profastnpvmodel): A price-setter model that calculates the net present value of a commodity using [ProFAST](https://github.com/NatLabRockies/ProFAST). (profast:overview)= ## Finance parameters overview diff --git a/docs/finance_models/ProFastComp.md b/docs/finance_models/ProFastComp.md index 6403505d3..e94fe210e 100644 --- a/docs/finance_models/ProFastComp.md +++ b/docs/finance_models/ProFastComp.md @@ -1,7 +1,7 @@ (profastcomp:profastcompmodel)= # ProFastComp -The `ProFastLCO` finance model calculates levelized cost of a commodity using [ProFAST](https://github.com/NREL/ProFAST). +The `ProFastLCO` finance model calculates levelized cost of a commodity using [ProFAST](https://github.com/NatLabRockies/ProFAST). The inputs, outputs, and naming convention for the `ProFastLCO` model are outlined in this doc page. diff --git a/docs/finance_models/ProFastNPV.md b/docs/finance_models/ProFastNPV.md index ffe645f88..70447fc6c 100644 --- a/docs/finance_models/ProFastNPV.md +++ b/docs/finance_models/ProFastNPV.md @@ -1,6 +1,6 @@ (profastnpv:profastnpvmodel)= # ProFastNPV -The `ProFastNPV` finance model calculates the net present value (NPV) of a commodity using [ProFAST](https://github.com/NREL/ProFAST). +The `ProFastNPV` finance model calculates the net present value (NPV) of a commodity using [ProFAST](https://github.com/NatLabRockies/ProFAST). `ProFastNPV` inherits from `ProFastBase` so refer to the [`ProFastBase` documentation](profast:overview) for setting the finance parameters. diff --git a/docs/finance_models/finance_index.md b/docs/finance_models/finance_index.md index ab9f2c018..737ca4332 100644 --- a/docs/finance_models/finance_index.md +++ b/docs/finance_models/finance_index.md @@ -18,15 +18,15 @@ The `commodity_type` and `description` are used in the finance model naming conv (finance:supportedmodels)= ## Currently supported general finance models -- [``ProFastLCO``](profastcomp:profastcompmodel): calculates levelized cost of commodity using [ProFAST](https://github.com/NREL/ProFAST). -- [``ProFastNPV``](profastnpv:profastnpvmodel): calculates the net present value of a commodity using [ProFAST](https://github.com/NREL/ProFAST). +- [``ProFastLCO``](profastcomp:profastcompmodel): calculates levelized cost of commodity using [ProFAST](https://github.com/NatLabRockies/ProFAST). +- [``ProFastNPV``](profastnpv:profastnpvmodel): calculates the net present value of a commodity using [ProFAST](https://github.com/NatLabRockies/ProFAST). - [``NumpyFinancialNPV``](numpyfinancialnpvfinance:numpyfinancialnpvmodel): calculates the net present value of a commodity using the [NumPy Financial npv](https://numpy.org/numpy-financial/latest/npv.html#numpy_financial.npv) method. ## Custom finance models A general finance model can be defined similarly to a custom technology model. A custom finance model should be defined in the plant configuration file within the `finance_groups` section under `finance_parameters`. -Below shows an example, similar to the [Wind Electrolyzer Example](https://github.com/NREL/H2Integrate/tree/develop/examples/08_wind_electrolyzer/) of how to define a custom finance model within the `plant_config.yaml` file: +Below shows an example, similar to the [Wind Electrolyzer Example](https://github.com/NatLabRockies/H2Integrate/tree/develop/examples/08_wind_electrolyzer/) of how to define a custom finance model within the `plant_config.yaml` file: ```yaml finance_parameters: finance_groups: diff --git a/docs/getting_started/expected_user_knowledge.md b/docs/getting_started/expected_user_knowledge.md index 7c1c6ea96..42b49d554 100644 --- a/docs/getting_started/expected_user_knowledge.md +++ b/docs/getting_started/expected_user_knowledge.md @@ -27,8 +27,8 @@ Users should also be familiar with the [Google style](https://www.sphinx-doc.org H2Integrate itself is a framework that relies on a number of other tools and libraries to function. Users should be familiar with the following tools and libraries to use H2Integrate effectively: -- [HOPP](https://github.com/NREL/HOPP): Used for simulating technologies that produce electricity for other components in H2Integrate -- [PySAM](https://github.com/NREL/pysam): Provides access to the System Advisor Model (SAM) for performance and financial modeling; underlying tool used for modeling certain generation technologies +- [HOPP](https://github.com/NatLabRockies/HOPP): Used for simulating technologies that produce electricity for other components in H2Integrate +- [PySAM](https://github.com/NatLabRockies/pysam): Provides access to the System Advisor Model (SAM) for performance and financial modeling; underlying tool used for modeling certain generation technologies - [OpenMDAO](https://openmdao.org/): A framework for multidisciplinary optimization, analysis, and design; used for data-passing, model organization, and optimization - [Pyomo](http://www.pyomo.org/): A Python-based, open-source optimization modeling language; only useful to understand if you are modifying the dispatch algorithms - [Pandas](https://pandas.pydata.org/): A data manipulation and analysis library used for handling and analyzing data structures; useful for post-processing results diff --git a/docs/getting_started/install.md b/docs/getting_started/install.md index a65b34c3f..b77e4485c 100644 --- a/docs/getting_started/install.md +++ b/docs/getting_started/install.md @@ -12,7 +12,7 @@ pip install h2integrate If you want to develop new models or contribute to H2Integrate, you can install it from source. -### NREL Resource Data +### NLR Resource Data 1. The functions which download resource data require an NLR API key. Obtain a key from: @@ -29,12 +29,12 @@ If you want to develop new models or contribute to H2Integrate, you can install NLR_API_EMAIL=your.name@email.com ``` -### NREL-Provided Conda Environment Specification (recommended) +### NLR-Provided Conda Environment Specification (recommended) 1. Using Git, navigate to a local target directory and clone repository: ```bash - git clone https://github.com/NREL/H2Integrate.git + git clone https://github.com/NatLabRockies/H2Integrate.git ``` 2. Navigate to `H2Integrate` @@ -90,7 +90,7 @@ pip install -e ".[all]" 1. Using Git, navigate to a local target directory and clone repository: ```bash - git clone https://github.com/NREL/H2Integrate.git + git clone https://github.com/NatLabRockies/H2Integrate.git ``` 2. Navigate to `H2Integrate` diff --git a/docs/intro.md b/docs/intro.md index 6a50e4619..734fddc85 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -1,14 +1,14 @@ # H2Integrate - Holistic Hybrids Optimization and Design Tool [![PyPI version](https://badge.fury.io/py/h2integrate.svg)](https://badge.fury.io/py/h2integrate) -![CI Tests](https://github.com/NREL/H2Integrate/actions/workflows/ci.yml/badge.svg) +![CI Tests](https://github.com/NatLabRockies/H2Integrate/actions/workflows/ci.yml/badge.svg) [![image](https://img.shields.io/pypi/pyversions/h2integrate.svg)](https://pypi.python.org/pypi/h2integrate) [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![DOI:10.5281/zenodo.17903150](https://zenodo.org/badge/DOI/10.5281/zenodo.17903149.svg)](https://zenodo.org/records/17903149) H2Integrate is an open-source Python package for modeling and designing hybrid energy systems producing electricity, hydrogen, ammonia, steel, and other products. -Browse the example workflows in the GitHub repository: https://github.com/NREL/H2Integrate/tree/main/examples +Browse the example workflows in the GitHub repository: https://github.com/NatLabRockies/H2Integrate/tree/main/examples ```{note} H2Integrate is under active development and may be missing features that existed in previous versions. H2Integrate v0.2.0 is the last version that uses the prior framework. @@ -55,7 +55,7 @@ If you use this software in your work, please cite using the following BibTeX: H2Integrate is designed to be flexible and extensible, allowing users to create their own components and models for various energy systems. The tool currently includes renewable energy generation (wind, solar, wave, tidal), battery storage, hydrogen, ammonia, methanol, and steel technologies. Other elements such as desalination systems, pipelines, compressors, and storage systems can also be included as developed by users. -Some modeling capabilities in H2Integrate are provided by integrating existing tools, such as [HOPP](https://github.com/NREL/HOPP), [PySAM](https://github.com/NREL/pysam), [ORBIT](https://github.com/wisdem/ORBIT), and [ProFAST](https://github.com/NREL/ProFAST). +Some modeling capabilities in H2Integrate are provided by integrating existing tools, such as [HOPP](https://github.com/NatLabRockies/HOPP), [PySAM](https://github.com/NatLabRockies/pysam), [ORBIT](https://github.com/NLRWindSystems/ORBIT), and [ProFAST](https://github.com/NatLabRockies/ProFAST). The H2Integrate tool is built on top of [NASA's OpenMDAO framework](https://github.com/OpenMDAO/OpenMDAO/), which provides a powerful and flexible environment for modeling and optimization. ```{note} @@ -84,15 +84,15 @@ The modular nature of the H2Integrate system makes adding custom models, includi ## How does H2Integrate differ from other tools? -H2Integrate is developed at NREL, which has a long history of developing high-quality tools for renewable energy systems. +H2Integrate is developed at NLR, which has a long history of developing high-quality tools for renewable energy systems. Although there are many tools available for modeling hybrid energy systems, H2Integrate is unique in its focus on component-level modeling and design including nonlinear physics models, as well as its modularity and extensibility. H2Integrate stands out by offering a modular approach that models the entire energy system, from generation to end-use products such as hydrogen, ammonia, methanol, and steel, which is a capability not commonly found in other tools. -[REopt](https://reopt.nrel.gov/tool) is similar to H2Integrate in that it models hybrid energy systems, though it is a higher-level tool that focuses on linear optimization. +[REopt](https://reopt.nlr.gov/tool) is similar to H2Integrate in that it models hybrid energy systems, though it is a higher-level tool that focuses on linear optimization. One significant difference is that REopt can accommodate various external loads such as steel or ammonia, as long as the user provides the load profiles for those end-uses. H2Integrate models the processes themselves and does not require the user to provide a load profile, instead modeling what the load profile would be based on physics-based or analytical models. -[SAM](https://sam.nrel.gov/) is another relevant tool (that H2Integrate partially uses), which gives more detailed performance and financial modeling capabilities than REopt. +[SAM](https://sam.nrl.gov/) is another relevant tool (that H2Integrate partially uses), which gives more detailed performance and financial modeling capabilities than REopt. Like REopt, SAM also does not model loads or end-uses but accepts timeseries data of the loads for design purposes. H2Integrate goes into more component-level details than those tools, especially in terms of nonlinear physics-based modeling and design. diff --git a/docs/misc_resources/turbine_models_library_preprocessing.md b/docs/misc_resources/turbine_models_library_preprocessing.md index 10ed2c813..3b67ae2d5 100644 --- a/docs/misc_resources/turbine_models_library_preprocessing.md +++ b/docs/misc_resources/turbine_models_library_preprocessing.md @@ -13,9 +13,9 @@ kernelspec: # Turbine Models Library Pre-Processing Tools -The [turbine-models package](https://github.com/NREL/turbine-models/tree/main) hosts wind turbine data for a variety of wind turbines and has tools that can streamline the process to run new turbines with the [PySAM Windpower model](https://nrel-pysam.readthedocs.io/en/main/modules/Windpower.html) or [FLORIS](https://github.com/NREL/floris/tree/main). +The [turbine-models package](https://github.com/NatLabRockies/turbine-models/tree/main) hosts wind turbine data for a variety of wind turbines and has tools that can streamline the process to run new turbines with the [PySAM Windpower model](https://nrel-pysam.readthedocs.io/en/main/modules/Windpower.html) or [FLORIS](https://github.com/NatLabRockies/floris/tree/main). -The full list of turbine models available in the turbine-models library can be found [here](https://github.com/NREL/turbine-models/blob/main/turbine_models/supported_turbines.py) +The full list of turbine models available in the turbine-models library can be found [here](https://github.com/NatLabRockies/turbine-models/blob/main/turbine_models/supported_turbines.py) H2Integrate has preprocessing tools that leverage the functionality available in the turbine-models library. The function `export_turbine_to_pysam_format()` will save turbine model specifications formatted for the PySAM Windpower model. The PySAM Windpower model is wrapped in H2I and can be utilized with the "pysam_wind_plant_performance" model. Example usage of the `export_turbine_to_pysam_format()` function is demonstrated in the following section using Example 8. diff --git a/docs/technology_models/atb_costs_pv.md b/docs/technology_models/atb_costs_pv.md index 23415f748..1a5d9d050 100644 --- a/docs/technology_models/atb_costs_pv.md +++ b/docs/technology_models/atb_costs_pv.md @@ -1,12 +1,12 @@ # Solar-PV Cost Models based on ATB-Formatted Cost Data -NREL's [Annual Technology Baseline (ATB)](https://atb.nrel.gov) is commonly referenced for technology costs such as overnight capital cost, fixed operations and maintenance costs, and capital expenditures. Two solar-PV cost models are available in H2I that are intended to be easily used with cost values pulled from [NREL's ATB Excel workbook](https://atb.nrel.gov/electricity/2024/data). +NLR's [Annual Technology Baseline (ATB)](https://atb.nlr.gov) is commonly referenced for technology costs such as overnight capital cost, fixed operations and maintenance costs, and capital expenditures. Two solar-PV cost models are available in H2I that are intended to be easily used with cost values pulled from [NLR's ATB Excel workbook](https://atb.nlr.gov/electricity/2024/data). ```{note} The Annual Technology Baseline (ATB) is updated annually. While we do our best to update our documentation regularly, be sure that you're using the most recent version of the ATB in case our links are pointing to an older version. ``` -As mentioned on the [Utility-Scale PV ATB page](https://atb.nrel.gov/electricity/2024/utility-scale_pv), the costs for utility-scale PV have been published in `$/kW-AC` since 2020. The costs for [Commercial PV](https://atb.nrel.gov/electricity/2024/commercial_pv) and [Residential PV](https://atb.nrel.gov/electricity/2024/residential_pv) are published in `$/kW-DC`. The only difference between the two cost models in H2I are whether costs are input in `$/kW-AC` or `$/kW-DC`. +As mentioned on the [Utility-Scale PV ATB page](https://atb.nlr.gov/electricity/2024/utility-scale_pv), the costs for utility-scale PV have been published in `$/kW-AC` since 2020. The costs for [Commercial PV](https://atb.nlr.gov/electricity/2024/commercial_pv) and [Residential PV](https://atb.nlr.gov/electricity/2024/residential_pv) are published in `$/kW-DC`. The only difference between the two cost models in H2I are whether costs are input in `$/kW-AC` or `$/kW-DC`. - The `"ATBUtilityPVCostModel"` model has costs input in `$/kW-AC` to match the ATB and the outputted capacity in kW-AC from the PV performance model. Example usage of this cost model in the `tech_config.yaml` file is shown [in the first section below](#utility-scale-pv-cost-model). - The `"ATBResComPVCostModel"` model has costs input in `$/kW-DC` and the PV capacity is input in kW-DC from the **shared input parameter** of the PV performance model. Example usage of this cost model in the `tech_config.yaml` file is shown [in the second section below](#commercial-and-residential-pv-cost-model). diff --git a/docs/technology_models/atb_costs_wind.md b/docs/technology_models/atb_costs_wind.md index e3e628b4e..6d2cc58ce 100644 --- a/docs/technology_models/atb_costs_wind.md +++ b/docs/technology_models/atb_costs_wind.md @@ -1,15 +1,15 @@ # Wind Cost Model based on ATB-Formatted Cost Data -NREL's [Annual Technology Baseline (ATB)](https://atb.nrel.gov) is commonly referenced for technology costs such as overnight capital cost, fixed operations and maintenance costs, and capital expenditures. The `ATBWindPlantCostModel` cost model available in H2I that is intended to be easily used with cost values pulled from [NREL's ATB Excel workbook](https://atb.nrel.gov/electricity/2024/data). +NLR's [Annual Technology Baseline (ATB)](https://atb.nlr.gov) is commonly referenced for technology costs such as overnight capital cost, fixed operations and maintenance costs, and capital expenditures. The `ATBWindPlantCostModel` cost model available in H2I that is intended to be easily used with cost values pulled from [NLR's ATB Excel workbook](https://atb.nlr.gov/electricity/2024/data). ```{note} The Annual Technology Baseline (ATB) is updated annually. While we do our best to update our documentation regularly, be sure that you're using the most recent version of the ATB in case our links are pointing to an older version. ``` There are specific costs and performance specifications in the ATB for: -- [Land-Based Wind](https://atb.nrel.gov/electricity/2024/land-based_wind) -- [Offshore Wind](https://atb.nrel.gov/electricity/2024/offshore_wind) -- [Distributed Wind](https://atb.nrel.gov/electricity/2024/distributed_wind) +- [Land-Based Wind](https://atb.nlr.gov/electricity/2024/land-based_wind) +- [Offshore Wind](https://atb.nlr.gov/electricity/2024/offshore_wind) +- [Distributed Wind](https://atb.nlr.gov/electricity/2024/distributed_wind) Example usage of this cost model in the `tech_config.yaml` file is shown [in the first section below](#atb-wind-cost-model). diff --git a/docs/technology_models/geologic_hydrogen.md b/docs/technology_models/geologic_hydrogen.md index af74e4cf5..751ca44eb 100644 --- a/docs/technology_models/geologic_hydrogen.md +++ b/docs/technology_models/geologic_hydrogen.md @@ -43,7 +43,7 @@ The modeling approach in this performance model is informed by: The modeling approach in this cost model is based on: - Mathur et al. (Stanford): - NETL Quality Guidelines: -- Drill cost curves are based on an adapted [GETEM model](https://sam.nrel.gov/geothermal.html) +- Drill cost curves are based on an adapted [GETEM model](https://sam.nlr.gov/geothermal.html) ## Hydrogen Surface Processing Models diff --git a/docs/technology_models/methanol.md b/docs/technology_models/methanol.md index 1e02eea11..86fee1ef8 100644 --- a/docs/technology_models/methanol.md +++ b/docs/technology_models/methanol.md @@ -2,9 +2,9 @@ Methanol is an essential precursor to many chemicals, and is also used as a fuel, especially in marine applications. It can be produced from many substances, which the most conventional route using natural gas as the main feedstock, and other developing technologies that combine hydrogen and carbon dioxide (CO2). A basic framework for modeling methanol production is set up in `h2integrate/converters/methanol/methanol_baseclass.py`, and specific technologies are modeled in inherited classes. Examples of each methanol production method can be found in `examples/03_methanol`. Currently, H2I models two methanol production technologies: -1. Steam Methane Reforming (SMR): This is the most prominent commercial production route for methanol in the United States, and utilizes natural gas as the main feedstock. This model is found at `h2integrate/converters/methanol/smr_methanol_plant.py`. The NREL modeling of this process is based on an [NETL Baseline Analysis of Crude Methanol Production from Coal and Natural Gas](https://doi.org/10.2172/1601964). +1. Steam Methane Reforming (SMR): This is the most prominent commercial production route for methanol in the United States, and utilizes natural gas as the main feedstock. This model is found at `h2integrate/converters/methanol/smr_methanol_plant.py`. The NLR modeling of this process is based on an [NETL Baseline Analysis of Crude Methanol Production from Coal and Natural Gas](https://doi.org/10.2172/1601964). -2. CO2 Hydrogenation: This is a developing methanol production technology that directly combines hydrogen with carbon dioxide to produce methanol. This model is found at `h2integrate/converters/methanol/co2h_methanol_plant.py`. The NREL modeling of this process is based on a combination of three peer-reviewed studies: +2. CO2 Hydrogenation: This is a developing methanol production technology that directly combines hydrogen with carbon dioxide to produce methanol. This model is found at `h2integrate/converters/methanol/co2h_methanol_plant.py`. The NLR modeling of this process is based on a combination of three peer-reviewed studies: - [Perez-Fortes et al.](https://doi.org/10.1016/j.apenergy.2015.07.067) - [Szima et al.](https://doi.org/10.1016/j.jcou.2018.02.007) - [Nyari et al.](https://doi.org/10.1016/j.jcou.2020.101166) diff --git a/docs/technology_models/pvwattsv8_solar_pv.md b/docs/technology_models/pvwattsv8_solar_pv.md index a6e8796f7..dceada8a0 100644 --- a/docs/technology_models/pvwattsv8_solar_pv.md +++ b/docs/technology_models/pvwattsv8_solar_pv.md @@ -54,16 +54,16 @@ $$ - `create_model_from`: this can either be set to `"new"` or `"default"` and defaults to `"new"`. If `create_model_from` is `"new"`, the PV model is initialized using `Pvwattsv8.new()` and *populated* with parameters specified in `pysam_options`. If `create_model_from` is `"default"`, the PV model is initialized using `Pvwattsv8.default(config_name)` (`config_name` is also an input parameter) then *updated* with parameters specified in `pysam_options`. - `config_name`: this is only used if `create_model_from` is `"default"`. The default value for this is `"PVWattsSingleOwner"`. The available options and their default parameters are listed below: - - [PVWattsCommercial](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsCommercial.json) - - [PVWattsCommunitySolar](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsCommunitySolar.json) - - [PVWattsHostDeveloper](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsHostDeveloper.json) - - [PVWattsMerchantPlant](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsMerchantPlant.json) - - [PVWattsNone](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsNone.json) - - [PVWattsResidential](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsResidential.json) - - [PVWattsSaleLeaseback](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsSaleLeaseback.json) - - [PVWattsSingleOwner](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsSingleOwner.json) - - [PVWattsThirdParty](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsThirdParty.json) - - [PVWattsAllEquityPartnershipFlip](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsAllEquityPartnershipFlip.json) + - [PVWattsCommercial](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsCommercial.json) + - [PVWattsCommunitySolar](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsCommunitySolar.json) + - [PVWattsHostDeveloper](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsHostDeveloper.json) + - [PVWattsMerchantPlant](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsMerchantPlant.json) + - [PVWattsNone](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsNone.json) + - [PVWattsResidential](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsResidential.json) + - [PVWattsSaleLeaseback](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsSaleLeaseback.json) + - [PVWattsSingleOwner](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsSingleOwner.json) + - [PVWattsThirdParty](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsThirdParty.json) + - [PVWattsAllEquityPartnershipFlip](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Pvwattsv8_PVWattsAllEquityPartnershipFlip.json) - `pysam_options` (dict): The top-level keys correspond to the Groups available in the [Pvwattsv8 module](https://nrel-pysam.readthedocs.io/en/main/modules/Pvwattsv8.html). The next level is the individual attributes a user could set and a full list is available through the PySAM documentation of Pvwattsv8 module. The Groups that users may want to specify specific options for are the: - [SystemDesign](#systemdesign-group) - [SolarResource](#solarresource-group) diff --git a/docs/technology_models/pysam_battery.md b/docs/technology_models/pysam_battery.md index 0811f8fd9..97416b6a0 100644 --- a/docs/technology_models/pysam_battery.md +++ b/docs/technology_models/pysam_battery.md @@ -1,6 +1,6 @@ # PySAM Battery Model -The PySAM battery model in H2Integrate is a wrapper that integrates the NREL PySAM `BatteryStateful` model into +The PySAM battery model in H2Integrate is a wrapper that integrates the NLR PySAM `BatteryStateful` model into an OpenMDAO component. For full documentation see the [PySAM battery model documentation](https://nrel-pysam.readthedocs.io/en/main/modules/BatteryStateful.html). The PySAM battery model simulates the response of the battery to control commands. However, the control commands may not be strictly followed. Specifically, the SOC bounds have been seen to be exceeded by nearly 4% SOC for the upper bound and close to 1% SOC on the lower bound. diff --git a/docs/technology_models/run_of_river.md b/docs/technology_models/run_of_river.md index 88dedc758..4822d9d87 100644 --- a/docs/technology_models/run_of_river.md +++ b/docs/technology_models/run_of_river.md @@ -75,4 +75,4 @@ Also within the `tech_config` yaml, you can set the performance and cost paramet For additional information regarding hydropower technology and performance see [New Stream-reach Development: A Comprehensive Assessment of Hydropower Energy Potential in the United States](https://info.ornl.gov/sites/publications/Files/Pub46481.pdf) and -for relevant performance and cost assumptions see the [Annual Technology Baseline - Hydropower](https://atb.nrel.gov/electricity/2024/hydropower). +for relevant performance and cost assumptions see the [Annual Technology Baseline - Hydropower](https://atb.nlr.gov/electricity/2024/hydropower). diff --git a/docs/technology_models/wind_plant_ard.md b/docs/technology_models/wind_plant_ard.md index 29e83f88b..659f0d33b 100644 --- a/docs/technology_models/wind_plant_ard.md +++ b/docs/technology_models/wind_plant_ard.md @@ -57,18 +57,18 @@ technologies: rated_power: 5000000.0 # W num_blades: 3 rated_thrust_N: 823484.4216152605 # from NREL 5MW definition - gust_velocity_m_per_s: 70.0 # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + gust_velocity_m_per_s: 70.0 # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml blade_surface_area: 69.7974979 tower_mass: 620.4407337521 nacelle_mass: 101.98582836439 hub_mass: 8.38407517646 blade_mass: 14.56341339641 foundation_height: 0.0 - commissioning_cost_kW: 44.0 # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml - decommissioning_cost_kW: 58.0 # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + commissioning_cost_kW: 44.0 # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + decommissioning_cost_kW: 58.0 # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml trench_len_to_substation_km: 50.0 distance_to_interconnect_mi: 4.97096954 - interconnect_voltage_kV: 130.0 # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + interconnect_voltage_kV: 130.0 # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml tcc_per_kW: 1300.00 # (USD/kW) opex_per_kW: 44.00 # (USD/kWh) analysis_options: diff --git a/docs/technology_models/windpower_wind_plant.md b/docs/technology_models/windpower_wind_plant.md index 4f7785b81..36a4a33f4 100644 --- a/docs/technology_models/windpower_wind_plant.md +++ b/docs/technology_models/windpower_wind_plant.md @@ -50,14 +50,14 @@ technologies: - `turbine_rating_kw` (required): rated power of individual wind turbine in kW - `create_model_from`: this can either be set to `"new"` or `"default"` and defaults to `"new"`. If `create_model_from` is `"new"`, the wind model is initialized using `Windpower.new()` and *populated* with parameters specified in `pysam_options`. If `create_model_from` is `"default"`, the wind model is initialized using `Windpower.default(config_name)` (`config_name` is also an input parameter) then *updated* with parameters specified in `pysam_options`. - `config_name`: this is only used if `create_model_from` is `"default"`. The default value for this is `"WindPowerSingleOwner"`. The available options and their default parameters are listed below: - - [WindPowerAllEquityPartnershipFlip](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerAllEquityPartnershipFlip.json) - - [WindPowerCommercial](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerCommercial.json) - - [WindPowerLeveragedPartnershipFlip](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerLeveragedPartnershipFlip.json) - - [WindPowerMerchantPlant](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerMerchantPlant.json) - - [WindPowerNone](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerNone.json) - - [WindPowerResidential](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerResidential.json) - - [WindPowerSaleLeaseback](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerSaleLeaseback.json) - - [WindPowerSingleOwner](https://github.com/NREL/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerSingleOwner.json) + - [WindPowerAllEquityPartnershipFlip](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerAllEquityPartnershipFlip.json) + - [WindPowerCommercial](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerCommercial.json) + - [WindPowerLeveragedPartnershipFlip](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerLeveragedPartnershipFlip.json) + - [WindPowerMerchantPlant](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerMerchantPlant.json) + - [WindPowerNone](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerNone.json) + - [WindPowerResidential](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerResidential.json) + - [WindPowerSaleLeaseback](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerSaleLeaseback.json) + - [WindPowerSingleOwner](https://github.com/NatLabRockies/SAM/blob/develop/api/api_autogen/library/defaults/Windpower_WindPowerSingleOwner.json) - `run_recalculate_power_curve` (optional): Flag whether to recalculate the wind turbine power curve. defaults to True. diff --git a/docs/technology_models/wombat_electrolyzer_om.md b/docs/technology_models/wombat_electrolyzer_om.md index 57f71ebcf..432674770 100644 --- a/docs/technology_models/wombat_electrolyzer_om.md +++ b/docs/technology_models/wombat_electrolyzer_om.md @@ -1,6 +1,6 @@ # WOMBAT Electrolyzer O&M Model -The `WOMBATElectrolyzerModel` provides a detailed, simulation-based approach to estimating the operations and maintenance (O&M) costs and availability of hydrogen electrolyzers. This model leverages the [WOMBAT](https://github.com/WISDEM/WOMBAT) (Windfarm Operations and Maintenance cost-Benefit Analysis Tool) framework, originally developed for wind farm O&M analysis, and adapts it for hydrogen systems. +The `WOMBATElectrolyzerModel` provides a detailed, simulation-based approach to estimating the operations and maintenance (O&M) costs and availability of hydrogen electrolyzers. This model leverages the [WOMBAT](https://github.com/NLRWindSystems/WOMBAT) (Windfarm Operations and Maintenance cost-Benefit Analysis Tool) framework, originally developed for wind farm O&M analysis, and adapts it for hydrogen systems. ## What is WOMBAT? diff --git a/docs/user_guide/how_to_interface_with_user_defined_model.md b/docs/user_guide/how_to_interface_with_user_defined_model.md index 709894cd9..9f13197f5 100644 --- a/docs/user_guide/how_to_interface_with_user_defined_model.md +++ b/docs/user_guide/how_to_interface_with_user_defined_model.md @@ -29,11 +29,11 @@ To demonstrate this capability, we include a minimal example of a custom technol - A `PaperMillCost` model that estimates capital and operational expenditures. - A `PaperMillFinance` technology finance model that computes the levelized cost of paper production (LCOP). -Refer to the [Paper Mill Model Example](https://github.com/NREL/H2Integrate/tree/develop/examples/06_custom_tech/) for a complete walkthrough. +Refer to the [Paper Mill Model Example](https://github.com/NatLabRockies/H2Integrate/tree/develop/examples/06_custom_tech/) for a complete walkthrough. ### Custom General Finance Model Example: simple LCO finance model -To demonstrate this capability, we include an example of a custom general finance model: a **simple LCO (levelized cost of) calculation** found in [Example 08: Wind Electrolyzer Example](https://github.com/NREL/H2Integrate/tree/develop/examples/08_wind_electrolyzer/). This example includes: +To demonstrate this capability, we include an example of a custom general finance model: a **simple LCO (levelized cost of) calculation** found in [Example 08: Wind Electrolyzer Example](https://github.com/NatLabRockies/H2Integrate/tree/develop/examples/08_wind_electrolyzer/). This example includes: - A `SimpleLCOFinanceConfig`: configuration class that is populated with inputs specific to that finance model. - A `SimpleLCOFinance` general finance model that computes the levelized cost of a commodity diff --git a/docs/user_guide/specifying_finance_parameters.md b/docs/user_guide/specifying_finance_parameters.md index 7ae08217d..3f12b4e4c 100644 --- a/docs/user_guide/specifying_finance_parameters.md +++ b/docs/user_guide/specifying_finance_parameters.md @@ -76,7 +76,7 @@ finance_subgroup_default. ``` Examples: -- [Example 7](https://github.com/NREL/H2Integrate/blob/develop/examples/07_run_of_river_plant/plant_config.yaml) +- [Example 7](https://github.com/NatLabRockies/H2Integrate/blob/develop/examples/07_run_of_river_plant/plant_config.yaml) (finparams:singlemodelsubgroups)= @@ -106,9 +106,9 @@ finance_subgroup_. ``` Examples: -- [Example 02](https://github.com/NREL/H2Integrate/tree/develop/examples/02_texas_ammonia/plant_config.yaml) -- [Example 03 - CO2H](https://github.com/NREL/H2Integrate/tree/develop/examples/03_methanol/co2_hydrogenation/plant_config_co2h.yaml) -- [Example 09 - DOC](https://github.com/NREL/H2Integrate/tree/develop/examples/09_co2/direct_ocean_capture/plant_config.yaml) +- [Example 02](https://github.com/NatLabRockies/H2Integrate/tree/develop/examples/02_texas_ammonia/plant_config.yaml) +- [Example 03 - CO2H](https://github.com/NatLabRockies/H2Integrate/tree/develop/examples/03_methanol/co2_hydrogenation/plant_config_co2h.yaml) +- [Example 09 - DOC](https://github.com/NatLabRockies/H2Integrate/tree/develop/examples/09_co2/direct_ocean_capture/plant_config.yaml) @@ -151,7 +151,7 @@ finance_subgroup_subgroup_b.NPV_hydrogen_delivered_group_b ``` Examples: -- [Example 10](https://github.com/NREL/H2Integrate/blob/develop/examples/10_electrolyzer_om/plant_config.yaml) +- [Example 10](https://github.com/NatLabRockies/H2Integrate/blob/develop/examples/10_electrolyzer_om/plant_config.yaml) #### Key Behaviors - If `finance_parameters` is missing --> no finance model is created. diff --git a/examples/01_onshore_steel_mn/plant_config.yaml b/examples/01_onshore_steel_mn/plant_config.yaml index fbd42d963..6134dc3f7 100644 --- a/examples/01_onshore_steel_mn/plant_config.yaml +++ b/examples/01_onshore_steel_mn/plant_config.yaml @@ -48,7 +48,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/02_texas_ammonia/plant_config.yaml b/examples/02_texas_ammonia/plant_config.yaml index 9d42bd2c5..60de0219e 100644 --- a/examples/02_texas_ammonia/plant_config.yaml +++ b/examples/02_texas_ammonia/plant_config.yaml @@ -48,7 +48,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for real analysis discount_rate: 0.06 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 0.724 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.025 # https://www.house.mn.gov/hrd/issinfo/clsrates.aspx and # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf + property_tax_and_insurance: 0.025 # https://www.house.mn.gov/hrd/issinfo/clsrates.aspx and # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf total_income_tax_rate: 0.2574 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.0 # average combined state and local sales tax https://taxfoundation.org/location/texas/ diff --git a/examples/04_geo_h2/plant_config_natural.yaml b/examples/04_geo_h2/plant_config_natural.yaml index bb828355e..1bf46c69a 100644 --- a/examples/04_geo_h2/plant_config_natural.yaml +++ b/examples/04_geo_h2/plant_config_natural.yaml @@ -19,7 +19,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/04_geo_h2/plant_config_stimulated.yaml b/examples/04_geo_h2/plant_config_stimulated.yaml index fa361a863..2fa0f0591 100644 --- a/examples/04_geo_h2/plant_config_stimulated.yaml +++ b/examples/04_geo_h2/plant_config_stimulated.yaml @@ -17,7 +17,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/05_wind_h2_opt/plant_config.yaml b/examples/05_wind_h2_opt/plant_config.yaml index a8570032a..027f5f45a 100644 --- a/examples/05_wind_h2_opt/plant_config.yaml +++ b/examples/05_wind_h2_opt/plant_config.yaml @@ -31,7 +31,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/07_run_of_river_plant/plant_config.yaml b/examples/07_run_of_river_plant/plant_config.yaml index 215f7a720..0383cf89b 100644 --- a/examples/07_run_of_river_plant/plant_config.yaml +++ b/examples/07_run_of_river_plant/plant_config.yaml @@ -34,7 +34,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.308 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/09_co2/direct_ocean_capture/plant_config.yaml b/examples/09_co2/direct_ocean_capture/plant_config.yaml index 2bb100ef1..9035f7709 100644 --- a/examples/09_co2/direct_ocean_capture/plant_config.yaml +++ b/examples/09_co2/direct_ocean_capture/plant_config.yaml @@ -37,7 +37,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/09_co2/ocean_alkalinity_enhancement/plant_config.yaml b/examples/09_co2/ocean_alkalinity_enhancement/plant_config.yaml index d684aff3e..f6f0e190c 100644 --- a/examples/09_co2/ocean_alkalinity_enhancement/plant_config.yaml +++ b/examples/09_co2/ocean_alkalinity_enhancement/plant_config.yaml @@ -35,7 +35,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/09_co2/ocean_alkalinity_enhancement_financials/plant_config_financials.yaml b/examples/09_co2/ocean_alkalinity_enhancement_financials/plant_config_financials.yaml index 09d8969f5..bf53e153b 100644 --- a/examples/09_co2/ocean_alkalinity_enhancement_financials/plant_config_financials.yaml +++ b/examples/09_co2/ocean_alkalinity_enhancement_financials/plant_config_financials.yaml @@ -33,7 +33,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/11_hybrid_energy_plant/plant_config.yaml b/examples/11_hybrid_energy_plant/plant_config.yaml index 3cccee7c8..1b91ae6bc 100644 --- a/examples/11_hybrid_energy_plant/plant_config.yaml +++ b/examples/11_hybrid_energy_plant/plant_config.yaml @@ -17,7 +17,7 @@ finance_parameters: inflation_rate: 0.025 # 0 for nominal analysis discount_rate: 0.089 # nominal return debt_equity_ratio: 2.1746031746031744 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.015 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf + property_tax_and_insurance: 0.015 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.045 diff --git a/examples/12_ammonia_synloop/plant_config.yaml b/examples/12_ammonia_synloop/plant_config.yaml index b836b5335..fe90d4177 100644 --- a/examples/12_ammonia_synloop/plant_config.yaml +++ b/examples/12_ammonia_synloop/plant_config.yaml @@ -46,7 +46,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for real analysis discount_rate: 0.06 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 0.724 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.025 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.025 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.2574 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.0 # average combined state and local sales tax https://taxfoundation.org/location/texas/ diff --git a/examples/14_wind_hydrogen_dispatch/inputs/plant_config.yaml b/examples/14_wind_hydrogen_dispatch/inputs/plant_config.yaml index 57da1e324..eeb32d512 100644 --- a/examples/14_wind_hydrogen_dispatch/inputs/plant_config.yaml +++ b/examples/14_wind_hydrogen_dispatch/inputs/plant_config.yaml @@ -31,7 +31,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/15_wind_solar_electrolyzer/plant_config.yaml b/examples/15_wind_solar_electrolyzer/plant_config.yaml index 3ed82e0e0..cc45921b4 100644 --- a/examples/15_wind_solar_electrolyzer/plant_config.yaml +++ b/examples/15_wind_solar_electrolyzer/plant_config.yaml @@ -47,7 +47,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/17_splitter_wind_doc_h2/plant_config.yaml b/examples/17_splitter_wind_doc_h2/plant_config.yaml index 9059c57e4..187c6cd12 100644 --- a/examples/17_splitter_wind_doc_h2/plant_config.yaml +++ b/examples/17_splitter_wind_doc_h2/plant_config.yaml @@ -32,7 +32,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for real analysis discount_rate: 0.06 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 0.724 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.025 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.025 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.2574 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.0 # average combined state and local sales tax https://taxfoundation.org/location/texas/ diff --git a/examples/18_pyomo_heuristic_dispatch/plant_config.yaml b/examples/18_pyomo_heuristic_dispatch/plant_config.yaml index 64e0848c7..ef17a03c1 100644 --- a/examples/18_pyomo_heuristic_dispatch/plant_config.yaml +++ b/examples/18_pyomo_heuristic_dispatch/plant_config.yaml @@ -37,7 +37,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # p-tax https://www.house.mn.gov/hrd/issinfo/clsrates.aspx # insurance percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf + property_tax_and_insurance: 0.03 # p-tax https://www.house.mn.gov/hrd/issinfo/clsrates.aspx # insurance percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/19_simple_dispatch/plant_config.yaml b/examples/19_simple_dispatch/plant_config.yaml index f43314101..15577c242 100644 --- a/examples/19_simple_dispatch/plant_config.yaml +++ b/examples/19_simple_dispatch/plant_config.yaml @@ -33,7 +33,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ @@ -56,7 +56,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/21_iron_examples/iron_dri/plant_config.yaml b/examples/21_iron_examples/iron_dri/plant_config.yaml index 36e3d356a..83e240172 100644 --- a/examples/21_iron_examples/iron_dri/plant_config.yaml +++ b/examples/21_iron_examples/iron_dri/plant_config.yaml @@ -40,7 +40,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/21_iron_examples/iron_electrowinning/plant_config.yaml b/examples/21_iron_examples/iron_electrowinning/plant_config.yaml index 274070b36..fe1ed3001 100644 --- a/examples/21_iron_examples/iron_electrowinning/plant_config.yaml +++ b/examples/21_iron_examples/iron_electrowinning/plant_config.yaml @@ -30,7 +30,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/21_iron_examples/iron_mapping/plant_config.yaml b/examples/21_iron_examples/iron_mapping/plant_config.yaml index b0190ae45..e0c8b12f0 100644 --- a/examples/21_iron_examples/iron_mapping/plant_config.yaml +++ b/examples/21_iron_examples/iron_mapping/plant_config.yaml @@ -35,7 +35,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/23_solar_wind_ng_demand/plant_config.yaml b/examples/23_solar_wind_ng_demand/plant_config.yaml index 555b9b13e..30457af94 100644 --- a/examples/23_solar_wind_ng_demand/plant_config.yaml +++ b/examples/23_solar_wind_ng_demand/plant_config.yaml @@ -51,7 +51,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ @@ -74,7 +74,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/25_sizing_modes/plant_config.yaml b/examples/25_sizing_modes/plant_config.yaml index fa237f4af..b5089cf47 100644 --- a/examples/25_sizing_modes/plant_config.yaml +++ b/examples/25_sizing_modes/plant_config.yaml @@ -25,7 +25,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for real analysis discount_rate: 0.06 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 0.724 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.025 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.025 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.2574 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.0 # average combined state and local sales tax https://taxfoundation.org/location/texas/ diff --git a/examples/25_sizing_modes/tech_inputs/hopp_config_tx.yaml b/examples/25_sizing_modes/tech_inputs/hopp_config_tx.yaml index 71d06343d..6a6b35816 100644 --- a/examples/25_sizing_modes/tech_inputs/hopp_config_tx.yaml +++ b/examples/25_sizing_modes/tech_inputs/hopp_config_tx.yaml @@ -57,7 +57,7 @@ technologies: federal_tax_rate: 21.0 # https://taxsummaries.pwc.com/quick-charts/corporate-income-tax-cit-rates state_tax_rate: 4.74 # 0.75 # https://comptroller.texas.gov/taxes/franchise/ --> The TX franchise tax should be applied to margin but is included in income tax here as an approximation property_tax_rate: 1.47 # average effective real property tax rate in Texas https://taxfoundation.org/data/all/state/property-taxes-by-state-county-2024/ - insurance_rate: 1.0 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf + insurance_rate: 1.0 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf debt_percent: 72.4 # based on 2024 ATB for land-based wind term_int_rate: 4.4 # based on 2024 ATB real interest rate for land-based onshore wind months_working_reserve: 1 @@ -125,7 +125,7 @@ technologies: federal_tax_rate: 21.0 # https://taxsummaries.pwc.com/quick-charts/corporate-income-tax-cit-rates state_tax_rate: 4.74 # 0.75 # https://comptroller.texas.gov/taxes/franchise/ --> The TX franchise tax should be applied to margin but is included in income tax here as an approximation property_tax_rate: 1.47 # average effective real property tax rate in Texas https://taxfoundation.org/data/all/state/property-taxes-by-state-county-2024/ - insurance_rate: 1.0 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf + insurance_rate: 1.0 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf debt_percent: 75.3 # based on 2024 ATB for utility-scale pv solar term_int_rate: 4.4 # based on 2024 ATB real interest rate for utility-scale pv solar months_working_reserve: 1 @@ -171,7 +171,7 @@ technologies: federal_tax_rate: 21.0 # https://taxsummaries.pwc.com/quick-charts/corporate-income-tax-cit-rates state_tax_rate: 4.74 # 0.75 # https://comptroller.texas.gov/taxes/franchise/ --> The TX franchise tax should be applied to margin but is included in income tax here as an approximation property_tax_rate: 1.47 # average effective real property tax rate in Texas https://taxfoundation.org/data/all/state/property-taxes-by-state-county-2024/ - insurance_rate: 1.0 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf + insurance_rate: 1.0 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf debt_percent: 75.4 # based on 2024 ATB for utility-scale pv plus battery term_int_rate: 4.4 # based on 2024 ATB real interest rate for utility-scale battery months_working_reserve: 1 @@ -213,7 +213,7 @@ technologies: federal_tax_rate: 21.0 # https://taxsummaries.pwc.com/quick-charts/corporate-income-tax-cit-rates state_tax_rate: 4.74 # 0.75 # https://comptroller.texas.gov/taxes/franchise/ --> The TX franchise tax should be applied to margin but is included in income tax here as an approximation property_tax_rate: 1.47 # average effective real property tax rate in Texas https://taxfoundation.org/data/all/state/property-taxes-by-state-county-2024/ - insurance_rate: 1.0 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf + insurance_rate: 1.0 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf debt_percent: 72.4 # based on 2024 ATB for land-based wind term_int_rate: 4.4 # based on 2024 ATB real interest rate for land-based onshore wind months_working_reserve: 1 @@ -243,10 +243,10 @@ config: pv_charging_only: false include_lifecycle_count: false cost_info: - wind_installed_cost_mw: 1380000 # (2022USD) 2025 costs in 2022 USD from NREL 2024 ATB for land-based wind. 2025 used as an overnight-capex lock-in date for 2030 operation - solar_installed_cost_mw: 1323000 # (2022USD) 2025 costs in 2022 USD from NREL 2024 ATB for utility-scale pv. 2025 used as an overnight-capex lock-in date for 2030 operation - storage_installed_cost_mwh: 310000 # (2022USD) 2025 battery costs in 2022 USD from NREL 2024 ATB for utility-scale battery storage. 2025 used as an overnight-capex lock-in date for 2030 operation - storage_installed_cost_mw: 311000 # (2022USD) 2025 battery costs in 2022 USD from NREL 2024 ATB for utility-scale battery storage. 2025 used as an overnight-capex lock-in date for 2030 operation + wind_installed_cost_mw: 1380000 # (2022USD) 2025 costs in 2022 USD from NLR 2024 ATB for land-based wind. 2025 used as an overnight-capex lock-in date for 2030 operation + solar_installed_cost_mw: 1323000 # (2022USD) 2025 costs in 2022 USD from NLR 2024 ATB for utility-scale pv. 2025 used as an overnight-capex lock-in date for 2030 operation + storage_installed_cost_mwh: 310000 # (2022USD) 2025 battery costs in 2022 USD from NLR 2024 ATB for utility-scale battery storage. 2025 used as an overnight-capex lock-in date for 2030 operation + storage_installed_cost_mw: 311000 # (2022USD) 2025 battery costs in 2022 USD from NLR 2024 ATB for utility-scale battery storage. 2025 used as an overnight-capex lock-in date for 2030 operation wind_om_per_kw: 29 # (2022USD) 2030 costs in 2022 USD from 2024 ATB for land-based wind - pv_om_per_kw: 18 # (2022USD) 2030 costs in 2022 USD from NREL 2024 ATB for utility-scale PV + pv_om_per_kw: 18 # (2022USD) 2030 costs in 2022 USD from NLR 2024 ATB for utility-scale PV battery_om_per_kw: 15.525 # (2022USD) based on 2.5 percent of battery capex/kW for a 1-hour battery using both power and energy costs above diff --git a/examples/29_wind_ard/h2i_inputs/plant_config.yaml b/examples/29_wind_ard/h2i_inputs/plant_config.yaml index b1caecada..7508be3a9 100644 --- a/examples/29_wind_ard/h2i_inputs/plant_config.yaml +++ b/examples/29_wind_ard/h2i_inputs/plant_config.yaml @@ -34,7 +34,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for real analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/29_wind_ard/h2i_inputs/tech_config.yaml b/examples/29_wind_ard/h2i_inputs/tech_config.yaml index a396dc94c..dcb07a6bf 100644 --- a/examples/29_wind_ard/h2i_inputs/tech_config.yaml +++ b/examples/29_wind_ard/h2i_inputs/tech_config.yaml @@ -42,18 +42,18 @@ technologies: rated_power: 5000000.0 # W num_blades: 3 rated_thrust_N: 823484.4216152605 # from NREL 5MW definition - gust_velocity_m_per_s: 70.0 # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + gust_velocity_m_per_s: 70.0 # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml blade_surface_area: 69.7974979 tower_mass: 620.4407337521 nacelle_mass: 101.98582836439 hub_mass: 8.38407517646 blade_mass: 14.56341339641 foundation_height: 0.0 - commissioning_cost_kW: 44.0 # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml - decommissioning_cost_kW: 58.0 # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + commissioning_cost_kW: 44.0 # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + decommissioning_cost_kW: 58.0 # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml trench_len_to_substation_km: 50.0 distance_to_interconnect_mi: 4.97096954 - interconnect_voltage_kV: 130.0 # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + interconnect_voltage_kV: 130.0 # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml tcc_per_kW: 1300.00 # (USD/kW) opex_per_kW: 44.00 # (USD/kWh) analysis_options: null diff --git a/examples/30_pyomo_optimized_dispatch/plant_config.yaml b/examples/30_pyomo_optimized_dispatch/plant_config.yaml index ad929fbfb..8ae998215 100644 --- a/examples/30_pyomo_optimized_dispatch/plant_config.yaml +++ b/examples/30_pyomo_optimized_dispatch/plant_config.yaml @@ -38,7 +38,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # p-tax https://www.house.mn.gov/hrd/issinfo/clsrates.aspx # insurance percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf + property_tax_and_insurance: 0.03 # p-tax https://www.house.mn.gov/hrd/issinfo/clsrates.aspx # insurance percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf total_income_tax_rate: 0.257 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/examples/31_tidal/plant_config.yaml b/examples/31_tidal/plant_config.yaml index 4528d6483..e6b501d2a 100644 --- a/examples/31_tidal/plant_config.yaml +++ b/examples/31_tidal/plant_config.yaml @@ -35,7 +35,7 @@ finance_parameters: inflation_rate: 0.0 # 0 for nominal analysis discount_rate: 0.09 # nominal return based on 2024 ATB baseline workbook for land-based wind debt_equity_ratio: 2.62 # 2024 ATB uses 72.4% debt for land-based wind - property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nrel.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx + property_tax_and_insurance: 0.03 # percent of CAPEX estimated based on https://www.nlr.gov/docs/fy25osti/91775.pdf https://www.house.mn.gov/hrd/issinfo/clsrates.aspx total_income_tax_rate: 0.308 # 0.257 tax rate in 2024 atb baseline workbook, value here is based on federal (21%) and state in MN (9.8) capital_gains_tax_rate: 0.15 # H2FAST default sales_tax_rate: 0.07375 # total state and local sales tax in St. Louis County https://taxmaps.state.mn.us/salestax/ diff --git a/h2integrate/converters/solar/atb_res_com_pv_cost.py b/h2integrate/converters/solar/atb_res_com_pv_cost.py index b5e8540b7..a29f69e9e 100644 --- a/h2integrate/converters/solar/atb_res_com_pv_cost.py +++ b/h2integrate/converters/solar/atb_res_com_pv_cost.py @@ -10,12 +10,11 @@ class ATBResComPVCostModelConfig(CostModelBaseConfig): """Configuration class for the ATBResComPVCostModel with costs based on DC capacity. Recommended to use with commercial or residential PV models. More information on ATB methodology and representative PV technologies can be found - `here for commercial PV `_ and - `here for residential PV `_. + `here for commercial PV `_ and + `here for residential PV `_. Reference cost values can be found on the `Solar - PV Dist. Comm` or `Solar - PV Dist. Res` sheets of the - `NREL ATB workbook `_. - + `NLR ATB workbook `_. Attributes: capex_per_kWdc (float|int): capital cost of solar-PV system in $/kW-DC opex_per_kWdc_per_year (float|int): annual operating cost of solar-PV diff --git a/h2integrate/converters/solar/atb_utility_pv_cost.py b/h2integrate/converters/solar/atb_utility_pv_cost.py index 25a223dd1..aa00eb0ba 100644 --- a/h2integrate/converters/solar/atb_utility_pv_cost.py +++ b/h2integrate/converters/solar/atb_utility_pv_cost.py @@ -10,9 +10,9 @@ class ATBUtilityPVCostModelConfig(CostModelBaseConfig): """Configuration class for the ATBUtilityPVCostModel with costs based on AC capacity. Recommended to use with utility-scale PV models. More information on ATB methodology and representative utility-scale PV technologies can be found - `here `_ + `here `_ Reference cost values can be found on the `Solar - Utility PV` sheet of the - `NREL ATB workbook `_. + `NLR ATB workbook `_. Attributes: capex_per_kWac (float|int): capital cost of solar-PV system in $/kW-AC diff --git a/h2integrate/converters/water/desal/desalination.py b/h2integrate/converters/water/desal/desalination.py index 7f2bff123..230be70ed 100644 --- a/h2integrate/converters/water/desal/desalination.py +++ b/h2integrate/converters/water/desal/desalination.py @@ -140,7 +140,7 @@ def setup(self): super().setup() def compute(self, inputs, outputs, discrete_inputs, discrete_outputs): - """Cost reference: Table 3 of https://www.nrel.gov/docs/fy16osti/66073.pdf. + """Cost reference: Table 3 of https://www.nlr.gov/docs/fy16osti/66073.pdf. CapEx includes 2.55% financing factor, numbers based on INL report https://doi.org/10.2172/1236837 (in Table 10) which came from this report https://www-pub.iaea.org/MTCD/Publications/PDF/te_1561_web.pdf diff --git a/h2integrate/converters/water_power/pysam_marine_cost.py b/h2integrate/converters/water_power/pysam_marine_cost.py index 58614afcd..4e9553f1a 100644 --- a/h2integrate/converters/water_power/pysam_marine_cost.py +++ b/h2integrate/converters/water_power/pysam_marine_cost.py @@ -41,7 +41,7 @@ class PySAMMarineCostConfig(CostModelBaseConfig): - Reference Model 6: Oscillating Water Column Additional MHK cost model information can be found - through the [System Advisor Model](https://sam.nrel.gov/) + through the [System Advisor Model](https://sam.nlr.gov/) """ device_rating_kw: float = field(validator=gt_zero) @@ -147,7 +147,7 @@ class PySAMMarineCostModel(CostModelBaseClass): input as well as the Department of Energy [Reference Model Project](https://energy.sandia.gov/programs/renewable-energy/water-power/projects/reference-model-project-rmp/). Additional MHK cost model information can be found - through the [System Advisor Model](https://sam.nrel.gov/). + through the [System Advisor Model](https://sam.nlr.gov/). Note: The supported reference models in this cost model are: diff --git a/h2integrate/converters/wind/atb_wind_cost.py b/h2integrate/converters/wind/atb_wind_cost.py index 7aaf35edf..6065ce155 100644 --- a/h2integrate/converters/wind/atb_wind_cost.py +++ b/h2integrate/converters/wind/atb_wind_cost.py @@ -10,10 +10,10 @@ class ATBWindPlantCostModelConfig(CostModelBaseConfig): """Configuration class for the ATBWindCostModel. Recommended to use with wind models (Land-Based, Offshore and Distributed More information on ATB methodology and representative wind technologies can - be found `here `_ + be found `here `_ Reference cost values can be found on the `Land-Based Wind`, `Fixed-Bottom Offshore Wind`, `Floating Offshore Wind` or `Distributed Wind` - sheet of the `NREL ATB workbook `_. + sheet of the `NLR ATB workbook `_. Attributes: capex_per_kW (float|int): capital cost of wind system in $/kW diff --git a/h2integrate/converters/wind/test/test_ard_wind.py b/h2integrate/converters/wind/test/test_ard_wind.py index 0fbf47dd6..6afcbf8be 100644 --- a/h2integrate/converters/wind/test/test_ard_wind.py +++ b/h2integrate/converters/wind/test/test_ard_wind.py @@ -55,18 +55,18 @@ def ard_config(): "rated_power": 5000000.0, # W "num_blades": 3, "rated_thrust_N": 823484.4216152605, # from NREL 5MW definition - "gust_velocity_m_per_s": 70.0, # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + "gust_velocity_m_per_s": 70.0, # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml "blade_surface_area": 69.7974979, "tower_mass": 620.4407337521, "nacelle_mass": 101.98582836439, "hub_mass": 8.38407517646, "blade_mass": 14.56341339641, "foundation_height": 0.0, - "commissioning_cost_kW": 44.0, # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml - "decommissioning_cost_kW": 58.0, # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + "commissioning_cost_kW": 44.0, # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + "decommissioning_cost_kW": 58.0, # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml "trench_len_to_substation_km": 50.0, "distance_to_interconnect_mi": 4.97096954, - "interconnect_voltage_kV": 130.0, # from https://github.com/WISDEM/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml + "interconnect_voltage_kV": 130.0, # from https://github.com/NLRWindSystems/WISDEM/blob/master/examples/02_reference_turbines/nrel5mw.yaml "tcc_per_kW": 1300.00, # (USD/kW) "opex_per_kW": 44.00, # (USD/kWh) }, diff --git a/h2integrate/core/inputs/validation.py b/h2integrate/core/inputs/validation.py index d9cc6f90d..eaec69a51 100644 --- a/h2integrate/core/inputs/validation.py +++ b/h2integrate/core/inputs/validation.py @@ -1,5 +1,5 @@ """ -Code adapted from NREL's WISDEM tool. +Code adapted from NLR's WISDEM tool. """ from pathlib import Path diff --git a/h2integrate/core/pose_optimization.py b/h2integrate/core/pose_optimization.py index 323d06842..b139f5d5b 100644 --- a/h2integrate/core/pose_optimization.py +++ b/h2integrate/core/pose_optimization.py @@ -1,5 +1,5 @@ """ -This file is based on the WISDEM file of the same name: https://github.com/WISDEM/WISDEM +This file is based on the WISDEM file of the same name: https://github.com/NLRWindSystems/WISDEM and also based off of the H2Integrate file of the same name originally adapted by Jared Thomas. """ diff --git a/h2integrate/finances/profast_base.py b/h2integrate/finances/profast_base.py index fe0e0ea4b..3bccca45d 100644 --- a/h2integrate/finances/profast_base.py +++ b/h2integrate/finances/profast_base.py @@ -447,7 +447,7 @@ class ProFastBase(om.ExplicitComponent): Reference: ProFAST Documentation: - https://www.nrel.gov/hydrogen/profast-access + https://www.nlr.gov/hydrogen/profast-access Attributes: diff --git a/h2integrate/resource/solar/test/test_resource_models.py b/h2integrate/resource/solar/test/test_resource_models.py index c04bebda4..b064593fa 100644 --- a/h2integrate/resource/solar/test/test_resource_models.py +++ b/h2integrate/resource/solar/test/test_resource_models.py @@ -30,7 +30,7 @@ ] ) # fmt: on -def test_nrel_solar_resource_file_downloads( +def test_nlr_solar_resource_file_downloads( subtests, plant_simulation, site_config, diff --git a/h2integrate/storage/battery/atb_battery_cost.py b/h2integrate/storage/battery/atb_battery_cost.py index 97b81215c..aeb15c598 100644 --- a/h2integrate/storage/battery/atb_battery_cost.py +++ b/h2integrate/storage/battery/atb_battery_cost.py @@ -11,10 +11,10 @@ class ATBBatteryCostConfig(CostModelBaseConfig): """Configuration class for the ATBBatteryCostModel with costs based on storage capacity and charge rate. More information on ATB methodology and representative battery technologies can be found - `here `_ + `here `_ Reference cost values can be found on the `Utility-Scale Battery Storage`, `Commercial Battery Storage`, and `Residential Battery Storage` sheets of the - `NREL ATB workbook `_. + `NLR ATB workbook `_. Attributes: energy_capex (float|int): battery energy capital cost in $/kWh diff --git a/h2integrate/storage/battery/pysam_battery.py b/h2integrate/storage/battery/pysam_battery.py index 27df6e436..c20bc7b32 100644 --- a/h2integrate/storage/battery/pysam_battery.py +++ b/h2integrate/storage/battery/pysam_battery.py @@ -72,7 +72,7 @@ class PySAMBatteryPerformanceModelConfig(StoragePerformanceBaseConfig): class PySAMBatteryPerformanceModel(StoragePerformanceBase): """OpenMDAO component wrapping the PySAM Battery Performance model. - This class integrates the NREL PySAM ``BatteryStateful`` model into + This class integrates the NLR PySAM ``BatteryStateful`` model into an OpenMDAO component. It provides inputs and outputs for battery capacity, charge/discharge power, state of charge, and unmet or unused demand. diff --git a/pyproject.toml b/pyproject.toml index d6f57d0fb..07972d7e9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -28,8 +28,8 @@ authors = [ {name = "Jennifer King"}, ] maintainers = [ - {name = "John Jasa", email = "john.jasa@nrel.gov"}, - {name = "Christopher Bay", email = "christopher.bay@nrel.gov"}, + {name = "John Jasa", email = "john.jasa@nlr.gov"}, + {name = "Christopher Bay", email = "christopher.bay@nlr.gov"}, ] readme = {file = "README.md", content-type = "text/markdown"} description = "Holistic Hybrids Optimization and Design Tool" @@ -86,10 +86,10 @@ classifiers = [ # https://pypi.org/classifiers/ ] [project.urls] -source = "https://github.com/NREL/H2Integrate" +source = "https://github.com/NatLabRockies/H2Integrate" documentation = "https://h2integrate.readthedocs.io/" -issues = "https://github.com/NREL/H2Integrate/issues" -changelog = "https://github.com/NREL/H2Integrate/blob/main/CHANGELOG.md" +issues = "https://github.com/NatLabRockies/H2Integrate/issues" +changelog = "https://github.com/NatLabRockies/H2Integrate/blob/main/CHANGELOG.md" [project.optional-dependencies] develop = [