Merge pull request #402 from blaylockbk/blaylockbk/issue198-add-CFS-m…

…odel

Examples for CFS

docs/gallery/noaa_models/cfs.ipynb

@@ -15,7 +15,42 @@
     "\n",
     "- [`product=\"time_series\"`](#time-series-product)\n",
     "- [`product=\"6_hourly\"`](#6-hourly-product)\n",
-    "- [`product=\"monthly\"`](#monthly-product)"
+    "- [`product=\"monthly\"`](#monthly-product)\n",
+    "\n",
+    "Some examples below\n",
+    "\n",
+    "```python\n",
+    "H = Herbie(\n",
+    "    date,\n",
+    "    model=\"cfs\",\n",
+    "    product=\"time_series\",\n",
+    "    member=1,          # {1, 2, 3, 4}\n",
+    "    variable=\"tmp2m\",  # the file's variable short name.\n",
+    ")\n",
+    "```\n",
+    "\n",
+    "```python\n",
+    "H = Herbie(\n",
+    "    date,\n",
+    "    model=\"cfs\",\n",
+    "    product=\"6_hourly\",\n",
+    "    kind=\"flxf\",  # {\"flxf\", \"pgbf\", \"ocnf\", \"ipvf\"}\n",
+    "    member=1,     # {1, 2, 3, 4}\n",
+    "    fxx=12,       # {0 ... (what's the max forecast hour??}\n",
+    ")\n",
+    "```\n",
+    "\n",
+    "```python\n",
+    "H = Herbie(\n",
+    "    date,\n",
+    "    model=\"cfs\",\n",
+    "    product=\"monthly_means\",\n",
+    "    kind=\"pgbf\",  # {\"flxf\", \"pgbf\", \"ocnh\", \"ocnf\", \"ipvf\"}\n",
+    "    member=1,     # {1, 2, 3, 4}\n",
+    "    month=1,      # {0 through 9 (I think)}\n",
+    "    hour=None,    # None for daily mean, or {0, 6, 12, 18}\n",
+    ")\n",
+    "```"
    ]
   },
   {