.. _notebooks:

IPython notebook examples
=========================

The `IPython notebook <http://ipython.org/notebook.html>`_
is a very nice platform for illustrating Clawpack examples.

If you have used Clawpack with the IPython notebook, please send us a link
or submit a pull request to the `apps repository <http://github.com/clawpack/apps>`_.
The links below will take you to the nbviewer site, where you can view
the notebooks as html.  You can also play animations in them and interact
with some plots, but to actually run the code yourself you should click
the download link at the top-right of each nbviewer page.

You can find demonstrations of how to set up animated results in some of the
notebooks below.  Source for some of these notebooks can also be found
in `$CLAW/apps/notebooks`.  

**Warning:** The notebooks and tools to support them are being actively
developed, so these may change in the near future and the versions posted
here may not work with the current Clawpack.

**Examples using PyClaw:**

* `A quick introduction to PyClaw <http://nbviewer.ipython.org/8332861>`_
* `A 2D fluid dynamics example <http://nbviewer.ipython.org/8333043>`_
* `Stegotons: solitary waves arising in non-dispersive periodic media <http://nbviewer.ipython.org/gist/ketch/8554686>`_
* `Demonstration of different limiters for advection <http://nbviewer.ipython.org/gist/ketch/9508222>`_
* More to come 

**Examples illustrating Riemann solvers:**

* `The Riemann problem for the Euler equations <http://nbviewer.ipython.org/gist/ketch/08ce0845da0c8f3fa9ff>`_
* `Euler shock tube  <http://nbviewer.ipython.org/gist/ketch/d31fd8d2d7739e59b6c6>`_
* `Riemann solutions of the shallow water equations <http://nbviewer.ipython.org/gist/rjleveque/8994740>`_ 
* `Shallow water equations -- Riemann solver tests <http://nbviewer.ipython.org/url/faculty.washington.edu/rjl/notebooks/shallow/SW_riemann_tester.ipynb>`_
* `Acoustics equations and their Riemann solver in 1D and 2D
  <http://nbviewer.ipython.org/github/maojrs/ipynotebooks/blob/master/acoustics_riemann.ipynb>`_
* `Elasticity equations and their Riemann solver in 2D and 3D <http://nbviewer.ipython.org/github/maojrs/ipynotebooks/blob/master/elasticity_riemann.ipynb>`_

**Examples using the Fortran code:**

* `Demo of running the code and producing an animation of results <http://nbviewer.ipython.org/gist/rjleveque/8328720>`_
* `Demo of AMRClaw with adjustment of runtime and plotting parameters <http://nbviewer.ipython.org/gist/rjleveque/8642159>`_ 
* `Riemann solutions of the shallow water equations <http://nbviewer.ipython.org/gist/rjleveque/8994740>`_ 
* More to come 

**Examples for GeoClaw:**

* `IPython notebook illustrating topotools <http://nbviewer.ipython.org/url/clawpack.github.io/notebooks/topotools_examples.ipynb>`_

* `IPython notebook illustrating dtopotools <http://nbviewer.ipython.org/url/clawpack.github.io/notebooks/dtopotools_examples.ipynb>`_

* `IPython notebook illustrating the Okada model <http://nbviewer.ipython.org/url/clawpack.github.io/notebooks/Okada.ipynb>`_

**Examples illustrating methods:**

* `Advection Equation and the REA algorithm <http://nbviewer.ipython.org/github/maojrs/ipynotebooks/blob/master/advection_REA.ipynb>`_