Skip to content

Expand model and configuration documentation coverage - #918

Open
johnjasa wants to merge 2 commits into
update_top_docsfrom
new_docs_pages
Open

johnjasa wants to merge 2 commits into
update_top_docsfrom
new_docs_pages

Conversation

@johnjasa

@johnjasa johnjasa commented Oct 8, 2026 •

Copy link
Copy Markdown
Collaborator

Expand model and configuration documentation coverage

  1. Add reference pages for PEM electrolysis, transport components, FLORIS wind, and plant, driver, and technology configuration.
  2. Expand model coverage for methanol, simple ammonia, simple steel, iron transport, nitrogen ASU, desalination, storage sizing, and ATB battery cost.
  3. Document optimized Pyomo dispatch rules, correct the storage compatibility note, and link the listed model/control examples (retaining the existing Example 34 link).
  4. Add preprocessing and postprocessing packages to the API reference, and document result reporting, flow plots, and ProFAST helpers.
  5. Explain multi-year resource selection and note plant configuration fields currently read by code but omitted from the plant schema.

Section 1: Type of Contribution

  • Documentation Update

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)

Section 3: General PR Checklist

  • PR description thoroughly describes the documentation changes.
  • Added tests for new functionality or bug fixes
  • Tests pass. The documentation build and targeted pre-commit checks passed.
  • Documentation
    • Docstrings are up-to-date; two existing docstrings were corrected for Sphinx parsing.
    • Related docs/ files are up-to-date.
    • Documentation has been rebuilt successfully.
    • Examples have been updated (not applicable)
  • CHANGELOG.md
    • At least one complete sentence has been provided to describe the changes made in this PR
    • A PR hyperlink is included as PR TBD pending the PR number.

Section 4: Related Issues

Section 5: Impacted Areas of the Software

Section 5.1: New Files

N/A. New files in this change are documentation pages and are summarized above.

Section 5.2: Modified Files

  • docs/_toc.yml, docs/_templates/autosummary/module.rst
    • Register the new pages and keep pytest test modules out of the generated public API tree.
  • h2integrate/postprocess/mapping.py, h2integrate/preprocess/populate_tech_yaml.py
    • Correct existing docstring formatting so Sphinx can document the newly listed packages.

Section 6: Additional Supporting Information

The plant configuration reference documents tech_to_dispatch_connections and
system_level_control as code-supported fields that are not currently declared in
plant_schema.yaml; this PR does not change schema validation. The optimized dispatch note now
reflects the StoragePerformanceBase solver interface rather than claiming PySAM battery is the
only supported storage performance model. No runtime model behavior was changed.

Section 7: Test Results, if applicable

  • bash docs/build_book.sh: passed; Sphinx completed with warnings treated as errors.
  • Targeted pre-commit checks on changed files: passed.
  • git diff --check: passed.
  • No runtime pytest tests were run; this change adds documentation and adjusts docstring formatting only.

Section 8 (Optional): New Model Checklist

N/A

@johnjasa
johnjasa added this pull request to stack #916 October 8, 2026 18:58
@coveralls

Copy link
Copy Markdown

Coverage Status

Coverage is 81.071% — new_docs_pages into update_top_docs. No base build found for update_top_docs.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants