From babf81b66ee602c536014c8e0cbcb57c9cb5dae7 Mon Sep 17 00:00:00 2001 From: Nora Loose Date: Tue, 5 Nov 2024 15:20:46 -0800 Subject: [PATCH] Improve notebook text --- docs/boundary_forcing.ipynb | 12 ++++++++---- docs/initial_conditions.ipynb | 10 ++++++++-- docs/surface_forcing.ipynb | 10 ++++++++-- docs/tides.ipynb | 2 +- 4 files changed, 25 insertions(+), 9 deletions(-) diff --git a/docs/boundary_forcing.ipynb b/docs/boundary_forcing.ipynb index cf6a9d24..28e49007 100644 --- a/docs/boundary_forcing.ipynb +++ b/docs/boundary_forcing.ipynb @@ -25,9 +25,7 @@ "id": "a65f0b74-cf3d-4615-9fad-ed1687527f18", "metadata": {}, "source": [ - "\n", - "\n", - "As always, the first step is to create our grid. Note that it is important to use the same grid throughout all the steps (i.e., creating tidal forcing, surface forcing, initial conditions, etc.) to set up a consistent ROMS simulation. Here we use the following grid." + "As always, the first step is to create our grid." ] }, { @@ -126,7 +124,13 @@ "id": "795b828b-6a33-4804-a1f6-52eb85f5f373", "metadata": {}, "source": [ - "Note that we could have also specified the data location via a wildcard, e.g., `path='/glade/derecho/scratch/bachman/GLORYS/NA/2012/*.nc'`. But with this latter choice, `ROMS-Tools` will operate quite a bit slower. More specific filenames are better!" + "
\n", + "\n", + "Note\n", + "\n", + "We could have also specified the data location via a wildcard, e.g., `glorys_path=\"/global/cfs/projectdirs/m4746/Datasets/GLORYS/NA/2012/*.nc\"`. But with this latter choice, `ROMS-Tools` will operate quite a bit slower. More specific filenames are better!\n", + "\n", + "
" ] }, { diff --git a/docs/initial_conditions.ipynb b/docs/initial_conditions.ipynb index 70519792..1092ee23 100644 --- a/docs/initial_conditions.ipynb +++ b/docs/initial_conditions.ipynb @@ -25,7 +25,7 @@ "id": "3f881256-8f95-4fb1-9511-8a7dd773d420", "metadata": {}, "source": [ - "We start by creating a grid. Note that it is important to use the same grid throughout all the steps (i.e., creating tidal forcing, atmospheric forcing, initial conditions, etc.) to set up a consistent ROMS simulation. Here, we use the following grid with the default parameters for the vertical coordinate system." + "We start by creating a grid." ] }, { @@ -100,7 +100,13 @@ "id": "2ed27d93-95aa-4c82-8688-ddcdb6c75825", "metadata": {}, "source": [ - "Note that it would also be okay to provide a filename that contains data for more than just the day of interest. `ROMS-Tools` will pick out the correct day (and complain if the day of interest is not in the provided filename.) Or we can even use wildcards, such as `filename='/glade/derecho/scratch/bachman/GLORYS/NA/2012/*.nc'`. Note, however, that `ROMS-Tools` will operate more efficiently when the filename is as specific as possible." + "
\n", + "\n", + "Note\n", + "\n", + "It would also be okay to provide a filename that contains data for more than just the day of interest. `ROMS-Tools` will pick out the correct day (and complain if the day of interest is not in the provided filename.) Or we can even use wildcards, such as `path=\"/global/cfs/projectdirs/m4746/Datasets/GLORYS/NA/2012/*.nc\"`. Note, however, that `ROMS-Tools` will operate more efficiently when the filename is as specific as possible.\n", + " \n", + "
" ] }, { diff --git a/docs/surface_forcing.ipynb b/docs/surface_forcing.ipynb index e7194913..a0bd0b87 100644 --- a/docs/surface_forcing.ipynb +++ b/docs/surface_forcing.ipynb @@ -25,7 +25,7 @@ "id": "f6338e0b-7858-4121-a2ee-7550e639607b", "metadata": {}, "source": [ - "As always, the first step is to create our grid. Note that it is important to use the same grid throughout all the steps (i.e., creating tidal forcing, surface forcing, initial conditions, etc.) to set up a consistent ROMS simulation. Here we use the following grid." + "As always, the first step is to create our grid." ] }, { @@ -1854,7 +1854,13 @@ "id": "f47568cf-9595-4e3c-9349-6bd7ab4d2bdd", "metadata": {}, "source": [ - "The `time` variable shows relative time, i.e., days since the model reference date (here set to January 1, 2000 by default). The `abs_time` coordinate shows the absolute time. The ERA5 data provided to `ROMS-Tools` has hourly frequency; this temporal frequency is inherited by `surface_forcing`." + "
\n", + "\n", + "Note\n", + "\n", + "The `time` variable shows relative time, i.e., days since the model reference date (here set to January 1, 2000 by default). The `abs_time` coordinate shows the absolute time. The ERA5 data provided to `ROMS-Tools` has hourly frequency; this temporal frequency is inherited by `surface_forcing`.\n", + " \n", + "
" ] }, { diff --git a/docs/tides.ipynb b/docs/tides.ipynb index 94ccc491..7d69092c 100644 --- a/docs/tides.ipynb +++ b/docs/tides.ipynb @@ -25,7 +25,7 @@ "id": "0c3cd5fd-fbe0-42f9-acfe-1c227fd492ef", "metadata": {}, "source": [ - "We first create our grid object. Note that it is important to use the same grid throughout all the steps (i.e., creating tidal forcing, atmospheric forcing, initial conditions, etc.) to set up a consistent ROMS simulation. Here we use the following grid." + "We first create our grid object." ] }, {