Introduction Tutorial (#281)

* update intro tutorial part 1 Co-authored-by: Ryan Abernathey <[email protected]>
pangeo-forge · Feb 18, 2022 · bc773e4 · bc773e4
1 parent 6bc66f7
commit bc773e4
Show file tree

Hide file tree

Showing 5 changed files with 572 additions and 226 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,7 +25,11 @@
 
 # we always have to manually run the notebooks because they are slow / expensive
 jupyter_execute_notebooks = "auto"
-execution_excludepatterns = ["tutorials/xarray_zarr/*", "tutorials/hdf_reference/*"]
+execution_excludepatterns = [
+    "tutorials/xarray_zarr/*",
+    "tutorials/hdf_reference/*",
+    "introduction_tutorial/*",
+]
 
 # -- Options for HTML output -------------------------------------------------
 

diff --git a/docs/index.md b/docs/index.md
@@ -54,7 +54,7 @@ If you are new to Pangeo Forge and looking to get involved, we suggest getting s
 :maxdepth: 2
 
 what_is_pangeo_forge
-intro_tutorial
+introduction_tutorial/index
 recipe_user_guide/index
 cloud_automation_user_guide/index
 tutorials/index

diff --git a/docs/intro_tutorial.md b/docs/intro_tutorial.md
diff --git a/docs/introduction_tutorial/index.md b/docs/introduction_tutorial/index.md
@@ -0,0 +1,21 @@
+# Introduction Tutorial
+
+Welcome to the Pangeo Forge introduction tutorial!
+
+This tutorial is split into three parts:
+1. Defining a recipe
+1. Running a recipe locally
+2. Setting up a recipe to run in the cloud
+
+Throughout this tutorial we are going to convert NOAA OISST stored in netCDF to Zarr. OISST is a global, gridded ocean sea surface temperature dataset at 1/4 degree resolution. By the end of this tutorial sequence you will have converted some OISST data to zarr, be able to access a sample on your computer, and see how to propose the recipe for cloud deployment!
+
+The introduction tutorial assumes that you already have `pangeo-forge-recipes` installed.
+
+## Index
+
+```{toctree}
+:maxdepth: 1
+:glob:
+
+intro_tutorial_part1
+```