From dca017b0e1ebe96c158148eceb5024cb56cc8a71 Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Fri, 8 Nov 2024 09:20:12 -0800 Subject: [PATCH 1/2] README.md: add link to gh-pages documentation --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fa2c1df63..33d8f2cc0 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,25 @@ # The WAVEWATCH III Framework -WAVEWATCH III® is a community wave modeling framework that includes the +WAVEWATCH III® is a community wave modeling framework that includes the latest scientific advancements in the field of wind-wave modeling and dynamics. ## General Features -WAVEWATCH III® solves the random phase spectral action density -balance equation for wavenumber-direction spectra. The model includes options -for shallow-water (surf zone) applications, as well as wetting and drying of -grid points. Propagation of a wave spectrum can be solved using regular -(rectilinear or curvilinear) and unstructured (triangular) grids. See -[About WW3](https://github.com/NOAA-EMC/WW3/wiki/About-WW3) for a -detailed description of WAVEWATCH III® . +WAVEWATCH III® solves the random phase spectral action density +balance equation for wavenumber-direction spectra. The model includes options +for shallow-water (surf zone) applications, as well as wetting and drying of +grid points. Propagation of a wave spectrum can be solved using regular +(rectilinear or curvilinear) and unstructured (triangular) grids. See +[About WW3](https://github.com/NOAA-EMC/WW3/wiki/About-WW3) for a +detailed description of WAVEWATCH III®. For a web-based +view of the WAVEWATCH III® source code documentation +refer to the [WW3 doxygen documentation](https://noaa-emc.github.io/WW3). ## Installation -The WAVEWATCH III® framework package has two parts that need to be combined so -all runs smoothly: the GitHub repo itself, and a binary data file bundle that -needs to be obtained from our ftp site. Steps to successfully acquire and install +The WAVEWATCH III® framework package has two parts that need to be combined so +all runs smoothly: the GitHub repo itself, and a binary data file bundle that +needs to be obtained from our ftp site. Steps to successfully acquire and install the framework are outlined in our [Quick Start](https://github.com/NOAA-EMC/WW3/wiki/Quick-Start) guide. @@ -35,4 +37,3 @@ endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government. - From e541fa17eca791d7cd3cc3e3b90f6ddff923d49a Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Fri, 8 Nov 2024 09:23:36 -0800 Subject: [PATCH 2/2] README.md: grammar --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 33d8f2cc0..42ac91178 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ grid points. Propagation of a wave spectrum can be solved using regular (rectilinear or curvilinear) and unstructured (triangular) grids. See [About WW3](https://github.com/NOAA-EMC/WW3/wiki/About-WW3) for a detailed description of WAVEWATCH III®. For a web-based -view of the WAVEWATCH III® source code documentation +view of the WAVEWATCH III® source code refer to the [WW3 doxygen documentation](https://noaa-emc.github.io/WW3). ## Installation