Pyclaw

Installation:

pip install clawpack

To run an example, launch an IPython session and then:

from clawpack.pyclaw import examples
claw = examples.shock_bubble_interaction.setup()
claw.run()
claw.plot()

Features:

• A hyperbolic PDE solver in 1D, 2D, and 3D, including mapped grids and surfaces, built on Clawpack;
• Massively parallel – the same simple script that runs on your laptop will scale efficiently on the world’s biggest supercomputers (see Running in parallel);
• High order accurate, with WENO reconstruction and Runge-Kutta time integration (see Using PyClaw’s solvers: Classic and SharpClaw);
• Simple and intuitive thanks to its Python interface.

PyClaw makes use of the additional Clawpack packages, Riemann and VisClaw for Riemann solvers and visualization, respectively.

If you have any issues or need help using PyClaw, contact us.

PyClaw Documentation

System Message: WARNING/2 (/var/folders/_s/dx0xgftn3_x04rdx0_w5nq7w0000gn/T/tmplBPRI1sphinxcontrib_versioning/8b07e169f86998872fc1cf3755d1b7f4a8c40a33/doc/pyclaw/index.rst, line 39)

toctree contains reference to nonexisting document u’pyclaw/gallery/how-to-build’

• Testing a PyClaw installation and running an example
  • Running an example
• PyClaw Basics
  • Installing PyClaw
  • PyClaw tutorial: Solve the acoustics equations
  • Working with PyClaw’s built-in examples
  • Plotting PyClaw results
• Going Further
  • Setting up your own problem
  • Porting a problem from Clawpack 4.6.x to PyClaw
  • Using PyClaw’s solvers: Classic and SharpClaw
  • Running in parallel
  • PyClaw output
  • Logging
• Understanding Pyclaw Classes
  • Flow of a Pyclaw Simulation
  • Creation of a Pyclaw Solution
  • Creation of a Pyclaw Solver
  • Creating and Running a Simulation with Controller
  • Restarting a simulation
  • Outputting aux values
  • Outputting derived quantities
• Developers’ Guide
  • Guidelines for contributing
  • Installation instructions for developers
  • Modifying code
  • Catching errors with Pyflakes and Pylint
  • Checking test coverage
  • Trouble-Shooting Tips
• Troubleshooting
  • Compilation errors
  • Use Fortran-ordered arrays
  • Installation
• About PyClaw
  • Contributors
  • License
  • Funding
• Gallery of all PyClaw applications
  • 1-dimensional advection
  • 1-dimensional variable-velocity advection
  • 1-dimensional acoustics
  • 1-dimensional Burgers’ equation
  • 1-dimensional shallow water equation
  • 1-dimensional nonlinear elasticity
  • 1-dimensional Euler equations
  • 2-dimensional advection
  • 2-dimensional variable-coefficient advection
  • 2-dimensional acoustics
  • 2-dimensional variable-coefficient acoustics
  • 2-dimensional shallow water equations
  • 2-dimensional shallow water on the sphere
  • 2-dimensional Euler equations
  • 2-dimensional KPP equation
  • 2-dimensional p-system

PyClaw Modules reference documentation

• Pyclaw Controller Class
• Using PyClaw’s solvers: Classic and SharpClaw
• Pyclaw Limiters
• Pyclaw Input/Output Package
• PyClaw Solutions
• PyClaw State
• PyClaw Geometry
• Pyclaw Utility Module

Riemann Solvers reference documentation

The Riemann solvers now comprise a separate package. For convenience, documentation of the available pure python Riemann solvers is included here. Many other Fortran-based Riemann solvers are available.

• Riemann Solver Package
  • Acoustics
  • Advection
  • Burgers Equation
  • Euler Equations
  • Shallow Water Equations

Indices and tables

• Index
• Module Index
• Search Page

Citing

If you use PyClaw in work that will be published, please cite the Clawpack software:

@misc{clawpack,
    title={Clawpack software},
    author={Clawpack Development Team},
    url={http://www.clawpack.org},
    note={Version x.y},
    year={2014}}

and the paper:

@article{pyclaw-sisc,
        Author = {Ketcheson, David I. and Mandli, Kyle T. and Ahmadia, Aron J. and Alghamdi, Amal and {Quezada de Luna}, Manuel and Parsani, Matteo and Knepley, Matthew G. and Emmett, Matthew},
        Journal = {SIAM Journal on Scientific Computing},
        Month = nov,
        Number = {4},
        Pages = {C210--C231},
        Title = {{PyClaw: Accessible, Extensible, Scalable Tools for Wave Propagation Problems}},
        Volume = {34},
        Year = {2012}}

Please fill in the version number that you used.

If you use the Classic (2nd-order) solver, you may also wish to cite:

@article{leveque1997,
        Author = {LeVeque, Randall J.},
        Journal = {Journal of Computational Physics},
        Pages = {327--353},
        Title = {{Wave Propagation Algorithms for Multidimensional Hyperbolic Systems}},
        Volume = {131},
        Year = {1997}}

If you use the SharpClaw (high order WENO) solver, you may also wish to cite:

@article{KetParLev13,
        Author = {Ketcheson, David I. and Parsani, Matteo and LeVeque,
        Randall J.},
        Journal = {SIAM Journal on Scientific Computing},
        Number = {1},
        Pages = {A351--A377},
        Title = {{High-order Wave Propagation Algorithms for Hyperbolic Systems}},
        Volume = {35},
        Year = {2013}}