Tweak API docstrings/comments (#158)

* tweak API comments * few docstring enhancements * more verbose gridtype -> arakawa_grid * gridtype->arakawa_grid * format black * assert that orientation and arakawa_grid have allowed values * break ValueError messages in multiple lines for clarity * better error messages * add remark about unit conversion * units --------- Co-authored-by: Navid C. Constantinou <[email protected]>
COSIMA · Apr 22, 2024 · 264e4cd · 264e4cd
1 parent 986473e
commit 264e4cd
Show file tree

Hide file tree

Showing 5 changed files with 138 additions and 96 deletions.
diff --git a/demos/access_om2-forced.ipynb b/demos/access_om2-forced.ipynb
@@ -870,7 +870,7 @@
     "expt.initial_condition(\n",
     "    tmp_dir + '/ic_unprocessed.nc', # directory where the unprocessed initial condition is stored, as defined earlier\n",
     "    ocean_varnames,\n",
-    "    gridtype=\"B\"\n",
+    "    arakawa_grid=\"B\"\n",
     "    )\n",
     "\n",
     "# Now iterate through our four boundaries \n",

diff --git a/demos/reanalysis-forced.ipynb b/demos/reanalysis-forced.ipynb
@@ -237,7 +237,7 @@
     "expt.initial_condition(\n",
     "    glorys_path / \"ic_unprocessed.nc\", # directory where the unprocessed initial condition is stored, as defined earlier\n",
     "    ocean_varnames,\n",
-    "    gridtype=\"A\"\n",
+    "    arakawa_grid=\"A\"\n",
     "    )\n",
     "\n",
     "# Now iterate through our four boundaries \n",