Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentations for the latest ngen #742

Merged
merged 8 commits into from
Apr 8, 2024

Conversation

stcui007
Copy link
Contributor

@stcui007 stcui007 commented Feb 16, 2024

This PR updates several documentations so that the build of module libraries, test modules, and ngen build options and environment reflect the most recent refactoring in the CMake build structure of ngen. In addition, it updates the routing_config.yaml so that it works with the current t-route. The previous version no longer works. It also add a few tips for building the nwm-routing module.

Additions

Removals

Changes

data/gauge_01073000/routing_config.yaml
doc/BMI_MODELS.md
doc/DEPENDENCIES.md
doc/DISTRIBUTED_PROCESSING.md
doc/MPI_REMOTE_NEXUS.md
doc/REALIZATION_CONFIGURATION.md
doc/PYTHON_ROUTING.md
test/README.md
./README.md
./INSTALL.md

Testing

  1. Browser

Screenshots

Notes

Work in progress

Todos

Checklist

  • [x ] PR has an informative and human-readable title
  • [x ] Changes are limited to a single goal (no scope creep)
  • [x ] Code can be automatically merged (no conflicts)
  • [x ] Code follows project standards (link if applicable)
  • [x ] Passes all existing automated tests
  • [x ] Any change in functionality is tested
  • [x ] New functions are documented (with a description, list of inputs, and expected output)
  • [x ] Placeholder code is flagged / future todos are captured in comments
  • [x ] Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • [x ] Reviewers requested with the Reviewers tool ➡️

Testing checklist (automated report can be put here)

Target Environment support

  • [x ] Linux

@stcui007 stcui007 marked this pull request as ready for review February 26, 2024 16:30
program--
program-- previously approved these changes Feb 28, 2024
doc/DEPENDENCIES.md Outdated Show resolved Hide resolved
@stcui007
Copy link
Contributor Author

stcui007 commented Mar 1, 2024 via email

@program-- program-- merged commit be8e347 into NOAA-OWP:master Apr 8, 2024
19 checks passed
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