Enhancement: Convert supported_models to enforce actual class names

[RHammond2]

Use model class names for supported_models to clarify model usage

This PR addresses #127's request to simplify the model naming conventions in supported_models allowing for a clear connection between what model is specified in the configuration files, and which model is actually being used without needing lookup the name connections in supported_models. An add-on benefit to this renaming is that generic naming conventions such as hopp can be cleanly separated from when they are a model versus when they are a technology.

The only caveat in this restructuring of model names is that "cable" and "pipe" transport models will not be changed due to how they are used within the code to still allow for a simplified connection configuration.

Section 1: Type of Contribution

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

Section 2: Draft PR Checklist - N/A

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

Section 3: Related Issues

#127

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.
  N/A

Section 4.2: Modified Files

I will not be outlining all the name changes from all of the 117 changed files for the sake of everyone's sanity, but below are a few changes that are not explicitly a find and replace style change.

• h2integrate/core/h2integrate_model.py
  • create_technology_models: Updates the "feedstock" generic name check to the actual model name being looked for.
  • connect_technologies: Updates the "feedstock" generic name check to the actual model name being looked for.

Section 5: Additional Supporting Information

N/A

Section 6: Test Results, if applicable

Tests pass

Section 7 (Optional): New Model Checklist - N/A

• 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

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB