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

Add NextGen CONUS Documentation #854

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

stcui007
Copy link
Contributor

@stcui007 stcui007 commented Jul 5, 2024

This PR update documentation to cover all aspect on computations at CONUS scale involving all submodules so far known to be suitable running within ngen framework. One of the purposes is to summarize previous piece meal documentations in one place.

Additions

Removals

Changes

Updates doc/NextGen_ON_CONUS.md

Testing

Visualization in browser

Screenshots

Notes

This is the final draft version for baseline computation on CONUS.

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)

  1. Running ngen jobs listed in the tables

Target Environment support

  • [x ] Linux

@stcui007 stcui007 marked this pull request as ready for review July 12, 2024 18:29
@@ -14,7 +14,7 @@
| [pybind11](#pybind11) | submodule | `v2.6.0` | Can be [excluded](#overriding-pybind11-dependency). |
| [dmod.subsetservice](#the-dmodsubsetservice-package) | external | `>= 0.3.0` | Only required to perform integrated [hydrofabric file subdividing](DISTRIBUTED_PROCESSING.md#subdivided-hydrofabric) for distributed processing . |
| [t-route](#t-route) | submodule | see below | Module required to enable channel-routing. Requires pybind11 to enable |
| [NetCDF Libraries](#netcdf-libraries) | external | \>= `4.7.4` | Enables NetCDF I/O support |
| [NetCDF Libraries](#netcdf-libraries) | external | NetCDF-C \>= `4.7.4`, CXX \>= `4.3.1`, Fortran \>= `4.5.4` | Enables NetCDF I/O support |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we require the NetCDF Fortran support for ngen itself? I can readily believe that it's necessary for some of the formulations in the set we give examples for. That may be reason enough to document it as required here, maybe with a note about why.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NetCDF Fortran is not necessary, at least for now, so I simply removed it.

@stcui007
Copy link
Contributor Author

stcui007 commented Sep 3, 2024 via email

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