From b1d6e82cde978b5ecd6e4752929351aba3028911 Mon Sep 17 00:00:00 2001 From: Nora Loose Date: Wed, 21 Aug 2024 09:10:23 -0600 Subject: [PATCH] Remove vertical coordinate notebook from index --- docs/index.rst | 1 - docs/methods.rst | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 785b8b37..05891c6e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,7 +26,6 @@ This python package is strongly inspired by the `UCLA MATLAB tools Creating tidal forcing Creating surface forcing - Creating a vertical coordinate Creating initial conditions Creating boundary forcing diff --git a/docs/methods.rst b/docs/methods.rst index 9a21fb23..b88b0d4d 100644 --- a/docs/methods.rst +++ b/docs/methods.rst @@ -64,7 +64,7 @@ The :meth:`roms_tools.Grid.add_topography_and_mask` method completes five steps: 1. The mask is defined using a dealiased version of the interpolated topography from step 0. In this step, the topography is evaluated at each grid point: values smaller than 0.11 meters are classified as land, and values larger than 0.11 meters are classified as ocean. 2. The interpolated topography from step 0 is smoothed over the entire domain with a smoothing factor of 8. This step ensures that the topography is smooth at the grid scale, a prerequisite for avoiding grid-scale instabilities at runtime. 3. The mask is modified by filling enclosed basins with land. -4. Regions where the ocean depth is shallower than ``hmin`` are set to ``hmin``. The topography is then smoothed locally in such a way that the maximum slope parameter ``r_max`` is smaller than 0.2. The maximum slope parameter is given by +4. Regions where the ocean depth is shallower than ``hmin`` are set to ``hmin``. The topography is then smoothed locally in such a way that the maximum slope parameter ``r`` is smaller than 0.2. The maximum slope parameter is given by .. math:: r = \max \left( \frac{|\Delta_x h|}{2h}, \frac{|\Delta_y h|}{2h} \right).