Skip to content

Commit 7705171

Browse files
README.md: update with link to doxygen documentation (#1316)
1 parent abc77b9 commit 7705171

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
# The WAVEWATCH III Framework
22

3-
WAVEWATCH III<sup>&reg;</sup> is a community wave modeling framework that includes the
3+
WAVEWATCH III<sup>&reg;</sup> is a community wave modeling framework that includes the
44
latest scientific advancements in the field of wind-wave modeling and dynamics.
55

66
## General Features
77

8-
WAVEWATCH III<sup>&reg;</sup> solves the random phase spectral action density
9-
balance equation for wavenumber-direction spectra. The model includes options
10-
for shallow-water (surf zone) applications, as well as wetting and drying of
11-
grid points. Propagation of a wave spectrum can be solved using regular
12-
(rectilinear or curvilinear) and unstructured (triangular) grids. See
13-
[About WW3](https://github.com/NOAA-EMC/WW3/wiki/About-WW3) for a
14-
detailed description of WAVEWATCH III<sup>&reg;</sup> .
8+
WAVEWATCH III<sup>&reg;</sup> solves the random phase spectral action density
9+
balance equation for wavenumber-direction spectra. The model includes options
10+
for shallow-water (surf zone) applications, as well as wetting and drying of
11+
grid points. Propagation of a wave spectrum can be solved using regular
12+
(rectilinear or curvilinear) and unstructured (triangular) grids. See
13+
[About WW3](https://github.com/NOAA-EMC/WW3/wiki/About-WW3) for a
14+
detailed description of WAVEWATCH III<sup>&reg;</sup>. For a web-based
15+
view of the WAVEWATCH III<sup>&reg;</sup> source code
16+
refer to the [WW3 doxygen documentation](https://noaa-emc.github.io/WW3).
1517

1618
## Installation
1719

18-
The WAVEWATCH III<sup>&reg;</sup> framework package has two parts that need to be combined so
19-
all runs smoothly: the GitHub repo itself, and a binary data file bundle that
20-
needs to be obtained from our ftp site. Steps to successfully acquire and install
20+
The WAVEWATCH III<sup>&reg;</sup> framework package has two parts that need to be combined so
21+
all runs smoothly: the GitHub repo itself, and a binary data file bundle that
22+
needs to be obtained from our ftp site. Steps to successfully acquire and install
2123
the framework are outlined in our [Quick Start](https://github.com/NOAA-EMC/WW3/wiki/Quick-Start)
2224
guide.
2325

@@ -35,4 +37,3 @@ endorsement, recommendation or favoring by the Department of Commerce. The
3537
Department of Commerce seal and logo, or the seal and logo of a DOC bureau,
3638
shall not be used in any manner to imply endorsement of any commercial product
3739
or activity by DOC or the United States Government.
38-

0 commit comments

Comments
 (0)