Skip to content

Commit

Permalink
Update examples.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gaelforget authored Jan 19, 2022
1 parent 37d1ebb commit e48306b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/src/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Output is in [DataFrames](https://juliadata.github.io/DataFrames.jl/latest/) tab

To run an example, the recommended method is to copy the corresponding `notebook (code)` link, paste into the [Pluto.jl](https://github.com/fonsp/Pluto.jl/wiki/🔎-Basic-Commands-in-Pluto) prompt, and click `open`.

### Simple Two-Dimensional Flow
## Simple Two-Dimensional Flow

[notebook (html)](random_flow_field.html)[notebook (code)](https://github.com/JuliaClimate/IndividualDisplacements.jl/blob/master/examples/basics/random_flow_field.jl)

Expand All @@ -19,7 +19,7 @@ All that is left to do at this stage is to define initial conditions, put them t

Exercises include the non-periodic domain case, statistics made easy via `DataFrames.jl`, and replacing the flow field with your own.

### Simple Three-Dimensional Flow
## Simple Three-Dimensional Flow

[notebook (html)](solid_body_rotation.html)[notebook (code)](https://github.com/JuliaClimate/IndividualDisplacements.jl/blob/master/examples/basics/solid_body_rotation.jl)

Expand All @@ -29,23 +29,23 @@ Set up a three-dimensional flow field `u,v,w`, initialize a single particle at p

The flow field consists of [rigid body rotation](https://en.wikipedia.org/wiki/Rigid_body), plus a convergent term, plus a sinking term in the vertical direction. This flow field generates a downward, converging spiral -- a idealized version of a relevant case in the Ocean.

### Global Ocean Circulation
## Global Ocean Circulation

[notebook (html)](global_ocean_circulation.html)[notebook (code)](https://github.com/JuliaClimate/IndividualDisplacements.jl/blob/master/examples/worldwide/global_ocean_circulation.jl)

A simulation of floating particles over the Global Ocean which illustrates (1) using time variable velocity fields, (2) global connections, (3) particle re-seeding, and (4) output statistics.

The flow field is based on a data-constrained ocean model solution. The problem is configured in a way to mimic, albeit very crudely, the near-surface tranport of plastics or planktons.

### Three Dimensional Pathways
## Three Dimensional Pathways

[notebook (html)](three_dimensional_ocean.html)[notebook (code)](https://github.com/JuliaClimate/IndividualDisplacements.jl/blob/master/examples/worldwide/three_dimensional_ocean.jl)

A simulation of particles that follow the three-dimensional ocean circulation. This example illustrates (1) the 3D case in a relatistic configuration, (2) tracking the advent or origin of a water patch, and (3) multifacted visualizations in 3D.

The flow field is based on a data-constrained, realistic, ocean model. The problem configuration mimics, albeit very approximately, ocean tracers / coumpounds transported by water masses .

### Additional Examples
## Additional Examples

- Interactive UI (Pluto.jl) : [notebook (html)](interactive_UI.html)[notebook (code)](https://github.com/JuliaClimate/IndividualDisplacements.jl/blob/master/examples/worldwide/interactive_UI.jl)

Expand Down

0 comments on commit e48306b

Please sign in to comment.