Skip to content

Feature 100 main v4.0 update doc#114

Merged
domingom merged 5 commits intomain_v4.0from
feature_100_main_v4.0_update_doc
Nov 17, 2025
Merged

Feature 100 main v4.0 update doc#114
domingom merged 5 commits intomain_v4.0from
feature_100_main_v4.0_update_doc

Conversation

@jprestop
Copy link
Collaborator

This PR includes:

  • An update to docs/Tutorials/cases/DISPERSION.rst to include the conda environment. Do we still want this here or should it be removed since the run script itself will be updated?
  • A minor typo fix in docs/Tutorials/cases_extensions.rst
  • In docs/build_run.rst, changes to the "module use" locations, and information about building with GAD, URBAN, and both in the NSF NCAR HPC Environments and AMD GPU Accelerated Platforms sections.

Note that I will cherry-pick these changes into the develop branch once they are merged for consistency with our next release.

Expected Differences

  • Do these changes introduce new tools, command line arguments, or configuration file options? [Yes or No]

    If yes, please describe:

Pull Request Testing

  • Describe testing already performed for these changes:

Reviewed the changes in RTD.

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

Review the files changed.

  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]

  • Do these changes include sufficient testing updates? [Yes]

  • Will this PR result in changes to the test suite? [No]

    If yes, describe the new output and/or changes to the existing output:

  • Please complete this pull request review by [At your convenience].

Pull Request Checklist

  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Select: Reviewer(s)
  • After submitting the PR, select the ⚙️ icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

@jprestop jprestop added this to the FastEddy 4.0.1 milestone Nov 17, 2025
@jprestop jprestop linked an issue Nov 17, 2025 that may be closed by this pull request
4 tasks
@domingom domingom merged commit 6630f45 into main_v4.0 Nov 17, 2025
2 checks passed
jprestop added a commit that referenced this pull request Nov 17, 2025
* Per #100, updating the Existing Builds modulefile locations

* Per 100, resolve typo

* Per #100, added language for building with model extensions

* Per #100, adding note with full path to cond environment

* Per #100, add note about turbines having to be within a single GPU
@jprestop jprestop deleted the feature_100_main_v4.0_update_doc branch November 18, 2025 23:16
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.

Update documentation

2 participants