Notebooks
=========

.. _notebooks:

Some examples coming from our `publications <biblio>`_ are available in `jupyter notebook <https://jupyter.org/>`__ format inside the ``notebooks`` folder in ``examples``.

Install jupyter
---------------

To begin with, you'll need to install jupyter.

It can be done in the scrimp environment with:

1. `conda activate scrimp`
2. `conda install jupyter ipykernel`
3. `python -m ipykernel install --user --name scrimp --display-name "Python (scrimp)"`

Run jupyter
-----------

Then, run in the ``notebooks`` folder:

`jupyter notebook &`

And choose a notebook to launch.

If you aim at learning **SCRIMP**, the preferred order to study the notebooks is:

* Wave_1D
* Wave_2D
* Heat_2D
* Wave_2D_CoEnergy
* Heat_Wave_2D
* Shallow_water_2D