docs for 0.5

mperrin · Jun 10, 2016 · 0dbc09c · 0dbc09c
1 parent eb90e83
commit 0dbc09c
Show file tree

Hide file tree

Showing 5 changed files with 155 additions and 152 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -42,7 +42,7 @@ The WebbPSF software system is composed of two Python packages: a lower-level op
 
 .. admonition:: Quickstart IPython Notebook
 
-   This documentation is complemented by an `IPython Notebook format quickstart tutorial <http://nbviewer.ipython.org/github/mperrin/webbpsf/blob/master/notebooks/WebbPSF_tutorial.ipynb>`_. Downloading and running that notebook is a great way to get started using WebbPSF.
+   This documentation is complemented by an `Jupyter (IPython) Notebook format quickstart tutorial <http://nbviewer.jupyter.org/github/mperrin/webbpsf/blob/master/notebooks/WebbPSF_tutorial.ipynb>`_. Downloading and running that notebook is a great way to get started using WebbPSF.
 
 :ref:`What's new in the latest release? <whatsnew>`
 
@@ -59,17 +59,6 @@ The WebbPSF software system is composed of two Python packages: a lower-level op
    more_examples.rst
    poppy.rst
 
-
-.. admonition:: How to cite WebbPSF
-
-    In addition to this documentation, WebbPSF is described in the following references.  Users of WebbPSF are encouraged to cite one of these.
-
-    * Perrin et al. 2014, `"Updated point spread function simulations for JWST with WebbPSF" <http://adsabs.harvard.edu/abs/2014SPIE.9143E..3XP>`_,  Proc. SPIE. 9143, 
-    * Perrin et al. 2012, `"Simulating point spread functions for the James Webb Space Telescope with WebbPSF", <http://adsabs.harvard.edu/abs/2012SPIE.8442E..3DP>`_ Proc SPIE 8842, and 
-    * Perrin 2011, :download:`Improved PSF Simulations for JWST: Methods, Algorithms, and Validation <Improved_PSFs_for_Webb.pdf>`, JWST Technical report JWST-STScI-002469.
-
-    In particular, the 2012 SPIE paper gives a broad overview, the 2014 SPIE paper presents comparisons to instrument cryotest data, and the Technical Report document describes in more detail the relevant optical physics, explains design decisions and motivation for WebbPSF's architecture, and presents extensive validation tests demonstrating consistency between WebbPSF and other PSF simulation packages used throughout the JWST project.
-
 .. admonition:: Getting Help
 
    For help using or installing webbpsf, you can contact the STScI Help Desk, [email protected]. Note that WebbPSF is included in the `Ureka <http://ssb.stsci.edu/ureka>`_ python distribution, as well as being installable via :ref:`standard Python packaging tools <installation>`. For detailed aspects of the JWST models, contact Marshall Perrin at STScI; for WFIRST, contact Joseph Long at STScI. 
@@ -97,6 +86,18 @@ Appendices and Reference
    relnotes.rst
    release.rst
 
+
+.. admonition:: How to cite WebbPSF
+
+    In addition to this documentation, WebbPSF is described in the following references.  Users of WebbPSF are encouraged to cite one of these.
+
+    * Perrin et al. 2014, `"Updated point spread function simulations for JWST with WebbPSF" <http://adsabs.harvard.edu/abs/2014SPIE.9143E..3XP>`_,  Proc. SPIE. 9143, 
+    * Perrin et al. 2012, `"Simulating point spread functions for the James Webb Space Telescope with WebbPSF", <http://adsabs.harvard.edu/abs/2012SPIE.8442E..3DP>`_ Proc SPIE 8842, and 
+    * Perrin 2011, :download:`Improved PSF Simulations for JWST: Methods, Algorithms, and Validation <Improved_PSFs_for_Webb.pdf>`, JWST Technical report JWST-STScI-002469.
+
+    In particular, the 2012 SPIE paper gives a broad overview, the 2014 SPIE paper presents comparisons to instrument cryotest data, and the Technical Report document describes in more detail the relevant optical physics, explains design decisions and motivation for WebbPSF's architecture, and presents extensive validation tests demonstrating consistency between WebbPSF and other PSF simulation packages used throughout the JWST project.
+
+
 * :ref:`genindex`
 * :ref:`search`
 

diff --git a/docs/more_examples.rst b/docs/more_examples.rst
@@ -8,16 +8,19 @@ More Examples
 
 Any user of Webbpsf is invited to submit snippets of example code for sharing here. 
 
-This code is also available as a Jupyter notebook:
-<http://nbviewer.ipython.org/github/mperrin/webbpsf/blob/master/notebooks/more_examples.ipynb>`_.
+This code is also available as a
+`Jupyter notebook <http://nbviewer.jupyter.org/github/mperrin/webbpsf/blob/master/notebooks/more_examples.ipynb>`_. This version 
+of the page is kept for convenience but may be slightly out of date in a few places.
 
 Examples are organized by topic:
 
  * :ref:`more_examples_general`
  * :ref:`more_examples_spectroscopy`
  * :ref:`more_examples_coronagraphy`
 
-The notebook version includes a fourth section providing examples of all the
+The
+`notebook version of this page <http://nbviewer.jupyter.org/github/mperrin/webbpsf/blob/master/notebooks/more_examples.ipynb>`_
+includes a fourth section providing examples of all the
 major SI modes for each of the JWST instruments.
 
 

diff --git a/notebooks/WebbPSF-WFIRST_Tutorial.ipynb b/notebooks/WebbPSF-WFIRST_Tutorial.ipynb
diff --git a/notebooks/WebbPSF_tutorial.ipynb b/notebooks/WebbPSF_tutorial.ipynb
diff --git a/notebooks/more_examples.ipynb b/notebooks/more_examples.ipynb
@@ -50,6 +50,31 @@
     "* Additional examples of SI modes"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Notebook Interface"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "WebbPSF includes a Jupyter notebook widget interface which facilitates simple calculations."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 28,
+   "metadata": {
+    "collapsed": true
+   },
+   "outputs": [],
+   "source": [
+    "webbpsf.show_notebook_interface('nircam')"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},