Skip to content

Commit

Permalink
Improve notebook text
Browse files Browse the repository at this point in the history
  • Loading branch information
NoraLoose committed Nov 5, 2024
1 parent 82b1046 commit babf81b
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 9 deletions.
12 changes: 8 additions & 4 deletions docs/boundary_forcing.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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."
]
},
{
Expand Down Expand Up @@ -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!"
"<div class=\"alert alert-info\">\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",
"</div>"
]
},
{
Expand Down
10 changes: 8 additions & 2 deletions docs/initial_conditions.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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."
]
},
{
Expand Down Expand Up @@ -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."
"<div class=\"alert alert-info\">\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",
"</div>"
]
},
{
Expand Down
10 changes: 8 additions & 2 deletions docs/surface_forcing.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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."
]
},
{
Expand Down Expand Up @@ -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`."
"<div class=\"alert alert-info\">\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",
"</div>"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/tides.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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."
]
},
{
Expand Down

0 comments on commit babf81b

Please sign in to comment.