Skip to content

Commit

Permalink
update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ashjbarnes committed Nov 15, 2023
1 parent 2fcf7f6 commit 69b3511
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions demos/reanalysis-forced.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,6 @@
"## Step 3: Make experiment object\n",
"This object keeps track of your domain basics, as well as generating the hgrid, vgrid and setting up the folder structures. \n",
"\n",
"After running you can have a look at your grids by calling `expt.hgrid` and `expt.vgrid`\n",
"\n",
"Plotting vgrid with marker = '.' option lets you see the spacing, or plotting \n",
"```python\n",
"np.diff(expt.hgrid.zl).plot(marker = '.')\n",
"```\n",
" shows you the vertical spacing profile.\n",
"\n"
]
},
Expand All @@ -137,6 +130,19 @@
")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"After running you can have a look at your grids by calling `expt.hgrid` and `expt.vgrid`\n",
"\n",
"Plotting vgrid with marker = '.' option lets you see the spacing, or plotting \n",
"```python\n",
"np.diff(expt.vgrid.zl).plot(marker = '.')\n",
"```\n",
" shows you the vertical spacing profile."
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand All @@ -153,7 +159,7 @@
"```python\n",
"expt.hgrid = new_hgrid\n",
"\n",
"expt.hgrid.to_netcdf(f\"{inputdir}/hgrid.nc\")\n",
"expt.hgrid.to_netcdf(inputdir / \"hgrid.nc\")\n",
"```"
]
},
Expand All @@ -173,7 +179,7 @@
"outputs": [],
"source": [
"expt.bathymetry(\n",
" 'PATH_TO_GEBCO_FILE', \n",
" 'PATH_TO_GEBCO_FILE/gebco2022.nc', \n",
" {\"xh\":\"lon\",\n",
" \"yh\":\"lat\",\n",
" \"elevation\":\"elevation\"}, ## Again this dictionary just maps mom6 variable names to what they are in your topog.\n",
Expand Down Expand Up @@ -249,7 +255,7 @@
"metadata": {},
"outputs": [],
"source": [
"expt.FRE_tools((10,10))\n"
"expt.FRE_tools((10,10)) ## Here the tuple defines the processor layout\n"
]
},
{
Expand Down

0 comments on commit 69b3511

Please sign in to comment.