Merge pull request #14 from ProjectPythia/ian-notebooks

Quickstart guide, keyframing, small updates

README.md

@@ -13,7 +13,7 @@ The Visualization and Analysis Platform for Ocean, Atmosphere, and Solar Researc
 
 ## Authors
 
-[Nihanth W. Cherukuru](https://github.com/NihanthCW), [Stanislaw 'Stas' Jarosynski](https://github.com/StasJ), [Philip Austin](https://github.com/phaustin)
+[Nihanth W. Cherukuru](https://github.com/NihanthCW), [Stanislaw 'Stas' Jarosynski](https://github.com/StasJ), [Philip Austin](https://github.com/phaustin), [Ian Franda](github.com/ifranda)
 
 ### Contributors
 
@@ -23,11 +23,12 @@ The Visualization and Analysis Platform for Ocean, Atmosphere, and Solar Researc
   <img src="https://github.com/shaomeng.png" width="8%" style="border-radius: 50%" />
   <img src="https://github.com/clyne.png" width="8%" style="border-radius: 50%" />
   <img src="https://github.com/NihanthCW.png" width="8%" style="border-radius: 50%" />
+  <img src="https://github.com/ifranda.png" width="8%" style="border-radius: 50%" />
 </a>
 
 ## Structure
 
-This cookbook is broken up into two main sections - "Foundations" and "Example Workflows". It is not necessary to go through these sections sequentially. Start with "Example Workflows" if you'd like to see VAPOR in action and get a broad overview of a workflow or start with "Foundations" if you'd like to explore the functionality/options in detail.
+This cookbook is divided into three main sections. The "Quickstart" section is a good starting point for a general overview of VAPOR's features and capabilities. The "Foundations" section gives more detailed examples for specific features in VAPOR. The "Example Workflows" section provides practical examples to see VAPOR in action and to gain an understanding of various workflows. Feel free to visit the sections that best fit your needs -- it's not necessary to follow them sequentially!
 
 ### VAPOR Foundations
 

_toc.yml

@@ -4,6 +4,9 @@ parts:
   - caption: Preamble
     chapters:
       - file: notebooks/how-to-cite
+  - caption: Quickstart Guide
+    chapters:
+      - file: notebooks/quickstart
 
   - caption: Foundations of VAPOR Python
     chapters:
@@ -14,6 +17,7 @@ parts:
       - file: notebooks/transfer_function_example
       - file: notebooks/annotation_example
       - file: notebooks/animation_example
+      - file: notebooks/keyframing_example
       - file: notebooks/flow_example
       - file: notebooks/visualizer_widget_example
 

notebooks/camera_example.ipynb

@@ -12,6 +12,14 @@
     "# Controlling the Camera\n"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "edc0386a",
+   "metadata": {},
+   "source": [
+    "Vapor provides several functions to control the camera position and direction. Here are a few examples."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,
@@ -79,6 +87,14 @@
     "cam = ses.GetCamera()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "a798e780",
+   "metadata": {},
+   "source": [
+    "### View All"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 3,
@@ -121,6 +137,14 @@
     "ses.Show()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "59f12f54",
+   "metadata": {},
+   "source": [
+    "### Align View"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 4,
@@ -163,6 +187,14 @@
     "ses.Show()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "d0f6032e",
+   "metadata": {},
+   "source": [
+    "### Zoom"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 5,
@@ -204,6 +236,14 @@
     "ses.Show()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "6abf0f67",
+   "metadata": {},
+   "source": [
+    "### Look At"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 6,