Add templates for ZG to add pylib

schism-dev · Sep 12, 2023 · 49b6563 · 49b6563
1 parent 11be792
commit 49b6563
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/docs/getting-started/pre-processing-with-pylib/overview.md b/docs/getting-started/pre-processing-with-pylib/overview.md
@@ -0,0 +1,2 @@
+PySCHISM is a python based package for preparing most inputs required of 3D baroclinic SCHISM run, driven by [TPXO](https://richdem.readthedocs.io/en/latest/using_it.html), [HYCOM](https://www.hycom.org/), [NWM](https://water.noaa.gov/about/nwm), and
+ a few pre-selected atmospheric models ([ERA5](https://www.ecmwf.int/en/forecasts/datasets/reanalysis-datasets/era5), [GFS](https://registry.opendata.aws/noaa-gfs-bdp-pds/), and [HRRR](https://registry.opendata.aws/noaa-hrrr-pds/)). PySCHISM has its own [repository](https://github.com/schism-dev/pyschism). The syntax of classes and methods in the library are subject to change in future releases, which will also significantly optimize performace and speed of some functionalities.
diff --git a/docs/getting-started/visualization.md b/docs/getting-started/visualization.md
@@ -3,8 +3,8 @@ The directory Utility/Vis_Matlab/ has matlab scripts that can visualize outputs
  z level or at a sigma level) or vertical transects. In particular, `SCHISM_SLAB2.m`  and `SCHISM_TRANSECT2.m` for for 
  the new scribed outputs, while `SCHISM_SLAB.m` and `SCHISM_TRANSECT.m` are for the old outputs (schout*.nc).
 
-## Visualization with Python
-[more coming] You can also find several packages on the [Forum site](http://ccrm.vims.edu/w/index.php/Share_your_tools)
+## Visualization with pylib
+
 
 ## Visualization with VisIt
 The most comprehensive way to visualize SCHISM nc4 outputs is via VisIt.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -58,6 +58,8 @@ nav:
     - Typical workflow (a cheat sheet): getting-started/typical-workflow.md
     - Mesh generation: getting-started/grid-generation.md
     - Preprocessing: getting-started/pre-processing.md
+    - Preprocessing with pylib:
+      - Overview: getting-started/pre-processing-with-pylib/overview.md 
     - Preprocessing with PySCHISM:
       - Overview: getting-started/pre-processing-with-pyschism/overview.md
       - Installation: getting-started/pre-processing-with-pyschism/installation.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		PySCHISM is a python based package for preparing most inputs required of 3D baroclinic SCHISM run, driven by [TPXO](https://richdem.readthedocs.io/en/latest/using_it.html), [HYCOM](https://www.hycom.org/), [NWM](https://water.noaa.gov/about/nwm), and
		a few pre-selected atmospheric models ([ERA5](https://www.ecmwf.int/en/forecasts/datasets/reanalysis-datasets/era5), [GFS](https://registry.opendata.aws/noaa-gfs-bdp-pds/), and [HRRR](https://registry.opendata.aws/noaa-hrrr-pds/)). PySCHISM has its own [repository](https://github.com/schism-dev/pyschism). The syntax of classes and methods in the library are subject to change in future releases, which will also significantly optimize performace and speed of some functionalities.