riemann_book

(β˜… 293)

An interactive book about the Riemann problem for hyperbolic PDEs, using Jupyter notebooks.

  • .gitignore
  • .travis.yml
  • Acoustics.ipynb
  • Acoustics_heterogeneous.ipynb
  • Advection.ipynb
  • Approximate_solvers.ipynb
  • Burgers.ipynb
  • Burgers_approximate.ipynb
  • Docker.md
  • Dockerfile
  • Euler.ipynb
  • Euler_approximate.ipynb
  • Euler_Tammann.ipynb
  • FV_compare.ipynb
  • Index.ipynb
  • Index2.ipynb
  • Instructions_html.md
  • Instructions_pdf.md
  • Introduction.ipynb
  • Kitchen_sink_problem.ipynb
  • LICENSE-CODE
  • LICENSE-TEXT.md
  • make_html.py
  • Make_html_animations.ipynb
  • make_html_bib.sh
  • make_pdf.py
  • Nonconvex_scalar.ipynb
  • Nonlinear_elasticity.ipynb
  • Preface.ipynb
  • Pressureless_flow.ipynb
  • README.md
  • requirements.txt
  • riemann.bib
  • riemann.html
  • riemann_bib.html
  • rp1_traffic_with_ramps.f90
  • Shallow_tracer.ipynb
  • Shallow_water.ipynb
  • Shallow_water_approximate.ipynb
  • test.py
  • Traffic_flow.ipynb
  • Traffic_variable_speed.ipynb
  • Traffic_with_ramps.ipynb

# Installation Guide

1. Get the code
git clone https://github.com/clawpack/riemann_book

Downloads the entire project code from GitHub to your computer.

cd riemann_book

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install clawpack

Installs the package published on PyPI directly β€” no need to clone the source.

pip install jupyter_contrib_nbextensions

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
$ docker pull clawpack/rbook

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install clawpack

Installs the package published on PyPI directly β€” no need to clone the source.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

jupyter nbextension enable --py widgetsnbextension

Type this command into your terminal and run it.

pip install jupyter_contrib_nbextensions

Installs the package published on PyPI directly β€” no need to clone the source.

jupyter contrib nbextension install --user

Type this command into your terminal and run it.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation