PySAM Marine Models

[kbrunik]

PySAM Marine Models

In this PR I add:

• A tidal resource model to be able to read in a tidal resource CSV file
• A tidal performance model that wraps the PySAM MhkTidal module
• A MHK cost model that wraps the PySAM MhkCosts module
  • This can simulate costs for the Reference Model Project devices for all devices except RM4

Section 1: Type of Contribution

• Feature Enhancement
  • Framework
  • New Model
  • Updated Model
  • Tools/Utilities
  • Other (please describe):
• Bug Fix
• Documentation Update
• CI Changes
• Other (please describe):

Section 2: Draft PR Checklist

• Open draft PR
• Describe the feature that will be added
• Fill out TODO list steps
• Describe requested feedback from reviewers on draft PR
• Complete Section 7: New Model Checklist (if applicable)

TODO:

• Step 1
• Step 2

Type of Reviewer Feedback Requested (on Draft PR)

Structural feedback:

Implementation feedback:

Other feedback:

Section 3: General PR Checklist

• PR description thoroughly describes the new feature, bug fix, etc.
• Added tests for new functionality or bug fixes
• Tests pass (If not, and this is expected, please elaborate in the Section 6: Test Results)
• Documentation
  • Docstrings are up-to-date
  • Related docs/ files are up-to-date, or added when necessary
  • Documentation has been rebuilt successfully
  • Examples have been updated (if applicable)
• CHANGELOG.md
  • At least one complete sentence has been provided to describe the changes made in this PR
  • After the above, a hyperlink has been provided to the PR using the following format:
    "A complete thought. [PR XYZ]((https://github.com/NatLabRockies/H2Integrate/pull/XYZ)", where
    XYZ should be replaced with the actual number.

Section 3: Related Issues

#611 created a new issue for getting the cost year correctly updated.

Section 4: Impacted Areas of the Software

Section 4.1: New Files

• docs

  • tidal_resource.md: Added doc page about what the tidal resource is (essentially a file reader and interpolator).
  • marine_hydrokinetic.md: An overview page for all the MHK models including hydro, tidal, and mhk costs.
  • tidal.md: Describes PySAM tidal model, how to use pysam_options and the power curve refit calculation.

• examples/31_tidal/

  • Typical example format. Showcases how to use the tidal model.
  • Tidal_resource_timeseries.csv: Example tidal resource timeseries. Used in example and tests.

• `h2integrate/converters/water_power/tidal_pysam.py

  • PySAMTidalPerformanceConfig: Required inputs from the user for tidal performance modeling. __attrs_post_init__ checks pysam_options and sets the input dictionary for instantiating the PySAM tidal module.
  • PySAMTidalPerformanceModel: Typical H2I format initialize, setup, compute. In the setup it creates the MhkTidal PySAM model.
    • recalculate_power_curve(): Method to resample an existing power curve based on an updated device rating.

• `h2integrate/converters/water_power/pysam_marine_cost.py

  • PySAMMarineCostConfig: Required inputs from the user for MHK cost modeling. __attrs_post_init__ checks pysam_options and sets the input dictionary for instantiating the PySAM MhkCosts module. The default behavior is to use the internal cost models for all components. A user can set their own costs via the pysam_options dictionary. One issue is it's unclear the cost year for the model and there is an issue about it Update cost year for MHKCosts #611.
  • PySAMMarineCostModel: Typical H2I format initialize, setup, compute. In the setup it creates the MhkCosts PySAM model. Outputs CapEx and OpEx, it does not have an output of VarOpEx.

• h2integrate/converters/water_power/test/

  • test_marine_pysam_cost.py: Tests capex and opex values from all reference models available in the model.
  • test_tidal_pysam.py: Subtests for outputs, test actual values, test the recalculate_power_curve is working correctly, test instantiating from a Default.

Section 4.2: Modified Files

• docs
  • run_of_river.md: Added reference to call in marine_hydrokinetic.md doc page
  • _toc.md: updated with new files.
  • resource_index.md: Added tidal to the overview.
• examples/test/test_all_examples.py
  • test_tidal_example: Integration test for tidal. Tests AEP, Capex, Opex, LCOE.
• supported_models.py
  • Added tidal resource
  • Added pysam tidal performance model (and added it to electricity producing tech)
  • Added pysam marine cost model

Section 5: Additional Supporting Information

Section 6: Test Results, if applicable

Section 7 (Optional): New Model Checklist

• Model Structure:
  • Follows established naming conventions outlined in docs/developer_guide/coding_guidelines.md
  • Used attrs class to define the Config to load in attributes for the model
    • If applicable: inherit from BaseConfig or CostModelBaseConfig
  • Added: initialize() method, setup() method, compute() method
    • If applicable: inherit from CostModelBaseClass
• Integration: Model has been properly integrated into H2Integrate
  • Added to supported_models.py
  • If a new commodity_type is added, update create_financial_model in h2integrate_model.py
• Tests: Unit tests have been added for the new model
  • Pytest-style unit tests
  • Unit tests are in a "test" folder within the folder a new model was added to
  • If applicable add integration tests
• Example: If applicable, a working example demonstrating the new model has been created
  • Input file comments
  • Run file comments
  • Example has been tested and runs successfully in test_all_examples.py
• Documentation:
  • Write docstrings using the Google style
  • Model added to the main models list in docs/user_guide/model_overview.md
    • Model documentation page added to the appropriate docs/ section
    • <model_name>.md is added to the _toc.yml

[elenya-grant]

This is looking good! I added a few suggestions and noted a possible edge-case that may result in an error. But - I think this is really clean and is looking awesome!

[elenya-grant]

A couple thoughts on the filename/loading file.

I think that the function check_resource_dir could be useful, this would be best if resource_dir was an optional config input. If you look at the get_data() method in ResourceBaseAPIModel, you'll see the logic there for finding/loading files.

from h2integrate.resource.utilities.file_tools import check_resource_dir
resource_dir = Path(self.config.filename).parent
resource_dir = check_resource_dir(resource_dir=Path(self.config.resource_dir))

And/or, I think that the find_file function in file_utils.py may be useful here :)

[kbrunik]

I've attempted to add this in but seem to have some file path stuff. so maybe find_file is the way to go?

[kbrunik]

Fixed (assuming the tests pass!)

[elenya-grant]

maybe we could put this in resource_files/tidal/?

[kbrunik]

done! I might need a bit of help to make sure I can still use it in the example correctly (filepath stuff...)

[elenya-grant]

it doesn't seem like latitude and longitude are used as inputs, right? But maybe this has to be here since the site's lat/lon are connected to resource models?

[kbrunik]

Looks like they can't be removed because of h2integrate_model and how the site is promoted

[elenya-grant]

why extract the outputs if they're not needed? I think the logic towards the end here could be simplified to:

if len(hours) < 8760:
   ... # code that makes/modifies data_df
   data_df = data_df.reset_index()
   outputs["tidal_velocity"] = data_df["tidal_velocity"]
   return

if len(hours) == 8760:
   outputs["tidal_velocity"] = tidalfile_model.Outputs.tidal_velocity
   return

raise ValueError("Resource time-series cannot be subhourly.")

[kbrunik]

I was lazy and it was hold over from how HOPP needed the data, thanks for calling me on it and writing simpler code :)

[elenya-grant]

Thanks for making those changes! Looks good!