Notebook Gallery

These notebooks contain examples of various use cases for mantaray.

Each example is in its own folder. Many folders have more than one notebook, and some will require you to run a notebook that generates data first before running the ray tracing notebook.

To run the example notebooks, follow installation instructions in the readme to install pixi and clone the repo. Then, install the examples environment using pixi run -e examples develop.

After that there are multiple options:

1. Follow our development instructions for using jupyter lab.

2. Start a shell with the environment using the command pixi shell -e examples.

3. Find the installation inside the .pixi folder and run the examples your own way.

Any additional instructions, such as order of running notebooks or needing data files, will be located in the readme for that example in the notebooks folder of the repository.

Constructing Canonical Forcing Fields

idealized_fields.html

Ray Tracing Canonical Examples

canonical_ray_tracing.html

Homepage Animation Tutorial

homepage_animation.html

Generate Bathymetry and Current Data for Analytical Comparisons

data_generation.html

Comparison of Mantaray Ray Tracing to Analytical Solutions

snells_law_verification.html

Ray tracing in the Agulhas current

agulhas_example.html

Ray tracing in a Realistic Context: Nazares Canyon

nazare_example.html

How to Add Your Jupyter Notebook Example

tutorial.html