GeoH2: Arps decline curve

[kbrunik]

Arps Decline Curve Modeling

This feature add is to make it so it's possible to use the Arps decline curves described in Tang et al. when simulating natural geologic hydrogen production.

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:

• Plot h2 output and verify it makes sense
• Verify decline method makes sense with H2I paradigm (Arps decline curve modeling is per unit volume not mass)
• Consider how to look at lifetime decline since simulation length is 8760 (currently just taking the first 8760)
• Testing
• Documentation

Type of Reviewer Feedback Requested (on Draft PR)

Structural feedback:

Implementation feedback:

Other feedback:
@jmartin4nrel it would be great to get your initial feedback on the method and implementation. I've added the arps_decline_curve_fit method directly to the NaturalGeoH2PerformanceModel class. Users are able to use the decline curve with predefined fits from data ("Permian", "Eagle_Ford", "Bakken"), select their own "Di" and "b", or not select anything and it will decline linearly.

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 has been updated to describe the changes made in this PR

Section 3: Related Issues

Section 4: Impacted Areas of the Software

Section 4.1: New Files

• path/to/file.extension
  • method1: What and why something was changed in one sentence or less.

Section 4.2: Modified Files

• path/to/file.extension
  • method1: What and why something was changed in one sentence or less.

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

[jmartin4nrel]

Everything LOOKs right at first glance... however, when I add a couple lines to the example script to look at the hydrogen_out profile, it looks like this...

Not the curve we're looking for, but idk why. It would be good to add a couple lines on the example script (04_geo_h2) to show both this plot and the year-of-year decline curve and make sure they're what we expect

[jmartin4nrel]

Maybe a terminology discussion that should happen in a standup meeting: when I say something is a "percent", then 5 percent goes in as 5., it doesn't go in as 0.05 - I would call it a "fraction" in that case

[jmartin4nrel]

May be coming in the final PR, but I would put in first author name and brief description of what they did, plus page/equation number of the equations we used and mention of tables/SI we used to make the fits.