Register models with a @register decorator instead of a hardcoded dictionary

[johnjasa]

Register models with a @register decorator instead of a hardcoded dictionary

Models are now registered by decorating the class, so adding a model no longer requires editing supported_models.py. Model modules are still imported lazily.

from h2integrate.core.supported_models import register


@register  # registered under the class name
class MyPerformanceModel(PerformanceModelBaseClass): ...


@register(name="cable", no_cost=True)  # optional name and flags
class CablePerformanceModel(om.ExplicitComponent): ...

1. Added a register marker decorator with optional name, no_cost, and no_replacement_schedule arguments.
2. supported_models.py now builds supported_models, no_cost_models, and no_replacement_schedule_models by scanning the package source for @register. Classes are imported on first lookup, and duplicate names raise a ValueError.
3. Decorated all 148 previously registered classes and removed the hardcoded dictionary. Names and resolved classes are unchanged.
4. Updated the developer guide, related docs, and the PR template checklist.

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 8: New Model Checklist (if applicable)

TODO:

N/A

Type of Reviewer Feedback Requested (on Draft PR)

Structural feedback: N/A

Implementation feedback: N/A

Other feedback: N/A

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 4: Related Issues

Resolves #901

Section 5: Impacted Areas of the Software

Section 5.1: New Files

• h2integrate/core/test/test_supported_models.py
  • Tests lazy lookup, the name argument, and the flag sets.

Section 5.2: Modified Files

• h2integrate/core/supported_models.py
  • Replaced the hardcoded dictionary with the register decorator and a source scan (275 to 72 lines).
• h2integrate/{control,converters,demand,feedstocks,finances,resource,storage,transporters}/**/*.py (103 files)
  • Added @register to each previously registered model class.
• docs/generate_model_overview.py
  • Updated the generated note on how to add or rename a model.
• pyproject.toml
  • Removed the E501 ignore for supported_models.py, which no longer has long lines.
• .github/PULL_REQUEST_TEMPLATE.md
  • Updated the new model checklist to use @register.

Section 6: Additional Supporting Information

• I had to do some special scanning logic to get the lazy imports working with the decorator. A normal decorator registry would require importing every model module up front, which takes about 10 s on Windows (pyomo, ard, rex, wombat, ProFAST). The text scan adds about 0.2 s to import h2integrate.
• Because the decorator is only a marker, @register must be at column 0, directly above the class line, with literal arguments.

Section 7: Test Results, if applicable

Runs locally well!

Section 8 (Optional): New Model Checklist

N/A

[RHammond2]

Really great riffing on #901! I failed to consider the lazy import style that supported_models uses when thinking through the solution, so your implementation felt bizarre until it finally clicked. Great stuff!

[RHammond2]

Love to see some slick Path logic!