Tutorial Notebooks

Note
  • The version of the notebooks found in the online docs is static html rendering (this website).
  • The version found in the src folder is the underlying code of the notebooks (.jl files).
  • To run the notebooks interactively see How-To section.

Included Notebooks

More Notebooks

How-To

To install OceanRobots.jl in julia proceed as usual via the package manager (using Pkg; Pkg.add("OceanRobots")).

To run a notebook interactively (.jl files) you want to use Pluto.jl. For example, copy and paste one of the above code links in the Pluto.jl interface. This will let you spin up the notebook in a web browser from the copied URL.

All you need to do beforehand is to install julia and Pluto.jl. The installation of OceanRobots.jl and other Julia packages will then happen automatically when you run the notebook.

You can also download the notebooks folder and run them as normal Julia programs. We recommend runing each notebook in its own environment as shown below.

Note

To download OceanRobots.jl folder, which includes the notebooks folder, you can use Git.jl.

using Pkg; Pkg.add("Git"); using Git
url="https://github.com/JuliaOcean/OceanRobots.jl"
run(`$(git()) clone $(url)`)
using Pkg; Pkg.add("Pluto"); using Pluto

notebook="MITgcm.jl/examples/Float_Argo.jl"
Pluto.activate_notebook_environment(notebook)
Pkg.instantiate()
include(notebook)
    Updating registry at `~/.julia/registries/General.toml`
   Resolving package versions...
  No Changes to `~/work/OceanRobots.jl/OceanRobots.jl/docs/Project.toml`
  No Changes to `~/work/OceanRobots.jl/OceanRobots.jl/docs/Manifest.toml`

[ Info: New notebook package environment written to directory ✓



   Installed JpegTurbo_jll ───────── v3.0.3+0
   Installed Cairo_jll ───────────── v1.18.0+2
   Installed Hyperscript ─────────── v0.0.5
   Installed StatsFuns ───────────── v1.3.1
   Installed NearestNeighbors ────── v0.4.18
   Installed PlutoUI ─────────────── v0.7.60
   Installed AdaptivePredicates ──── v1.1.1
   Installed DataFrames ──────────── v1.6.1
   Installed SimpleBufferStream ──── v1.1.0
   Installed LZO_jll ─────────────── v2.10.2+0
   Installed Hwloc_jll ───────────── v2.11.1+0
   Installed SIMD ────────────────── v3.5.0
   Installed OceanRobots ─────────── v0.2.5
   Installed ArgoData ────────────── v0.1.21
   Installed JLD2 ────────────────── v0.4.53
   Installed TranscodingStreams ──── v0.11.2
   Installed libpng_jll ──────────── v1.6.43+1
   Installed MPICH_jll ───────────── v4.2.2+0
   Installed Zstd_jll ────────────── v1.5.6+0
   Installed Lz4_jll ─────────────── v1.10.0+0
   Installed Rmath_jll ───────────── v0.4.3+0
   Installed Shapefile ───────────── v0.13.0
   Installed PrettyTables ────────── v2.3.2
   Installed OpenSSL_jll ─────────── v3.0.15+0
   Installed FFTW_jll ────────────── v3.3.10+0
   Installed MeshArrays ──────────── v0.3.11
   Installed Rmath ───────────────── v0.7.1
   Installed ChainRulesCore ──────── v1.24.0
   Installed Climatology ─────────── v0.5.5
   Installed IntervalArithmetic ──── v0.22.15
   Installed LLVMOpenMP_jll ──────── v17.0.6+0
   Installed CairoMakie ──────────── v0.12.9
   Installed MakieCore ───────────── v0.8.6
   Installed Glib_jll ────────────── v2.80.2+0
   Installed libsixel_jll ────────── v1.10.3+0
   Installed QuadGK ──────────────── v2.11.0
   Installed MPItrampoline_jll ───── v5.4.0+0
   Installed StringManipulation ──── v0.3.4
   Installed GeoInterface ────────── v1.3.6
   Installed Distributions ───────── v0.25.111
   Installed Makie ───────────────── v0.21.9
   Installed DelaunayTriangulation ─ v1.2.0
Precompiling project...
  ✓ SimpleBufferStream
  ✓ TranscodingStreams
  ✓ Hyperscript
  ✓ AdaptivePredicates
  ✓ GeoInterface
  ✓ ChainRulesCore
  ✓ OpenSSL_jll
  ✓ LLVMOpenMP_jll
  ✓ Lz4_jll
  ✓ Rmath_jll
  ✓ Hwloc_jll
  ✓ libpng_jll
  ✓ StringManipulation
  ✓ MPItrampoline_jll
  ✓ JpegTurbo_jll
  ✓ LZO_jll
  ✓ Zstd_jll
  ✓ FFTW_jll
  ✓ Glib_jll
  ✓ QuadGK
  ✓ ChainRulesCore → ChainRulesCoreSparseArraysExt
  ✓ IntervalArithmetic
  ✓ Rmath
  ✓ MPICH_jll
  ✓ PlutoUI
  ✓ libsixel_jll
  ✓ JpegTurbo
  ✓ Cairo_jll
  ✓ SIMD
  ✓ IntervalArithmetic → IntervalArithmeticRecipesBaseExt
  ✓ IntervalArithmetic → IntervalArithmeticsIntervalSetsExt
  ✓ NearestNeighbors
  ✓ StatsFuns
  ✓ Sixel
  ✓ MakieCore
  ✓ MeshArrays
  ✓ StatsFuns → StatsFunsChainRulesCoreExt
  ✓ DelaunayTriangulation
  ✓ Shapefile
  ✓ PrettyTables
  ✓ Shapefile → ShapefileZipFileExt
  ✓ MeshArrays → MeshArraysShapefileExt
  ✓ Distributions
  ✓ Distributions → DistributionsTestExt
  ✓ Distributions → DistributionsChainRulesCoreExt
  ✓ MeshArrays → MeshArraysDataDepsExt
  ✓ JLD2
  ✓ MeshArrays → MeshArraysJLD2Ext
  ✓ TiffImages
  ✓ DataFrames
  ✓ OceanRobots
  ✓ Makie
  ✓ MeshArrays → MeshArraysMakieExt
  ✓ Shapefile → ShapefileMakieExt
  ✓ OceanRobots → OceanRobotsMakieExt
  ✓ Climatology
  ✓ Climatology → ClimatologyNCDatasetsExt
  ✓ Climatology → ClimatologyMakieExt
  ✓ ArgoData
  ✓ OceanRobots → OceanRobotsArgoDataExt
  ✓ ArgoData → ArgoDataMakieExt
  ✓ CairoMakie
  62 dependencies successfully precompiled in 250 seconds. 287 already precompiled.
  47 dependencies precompiled but different versions are currently loaded. Restart julia to access the new versions
19083×2 DataFrame
   Row │ folder  wmo
       │ Any     Any
───────┼─────────────────
     1 │ aoml    13857
     2 │ aoml    13858
     3 │ aoml    13859
     4 │ aoml    15819
     5 │ aoml    15820
     6 │ aoml    15851
     7 │ aoml    15852
     8 │ aoml    15853
   ⋮   │   ⋮        ⋮
 19077 │ nmdis   2901627
 19078 │ nmdis   2901628
 19079 │ nmdis   2901629
 19080 │ nmdis   2901630
 19081 │ nmdis   2901631
 19082 │ nmdis   2901632
 19083 │ nmdis   2901633
       19068 rows omitted┌──────────┬─────────┐
│   folder │     wmo │
├──────────┼─────────┤
│     aoml │   13857 │
│     aoml │ 3900473 │
│     aoml │ 4903034 │
│     aoml │ 5903269 │
│     aoml │ 5906167 │
│ coriolis │ 1900341 │
│ coriolis │ 6901590 │
│     csio │ 2902637 │
│   incois │ 7901125 │
│      kma │ 2900516 │
└──────────┴─────────┘
┌ Warning: specifycing files_list here is deprecated
└ @ ArgoData ~/.julia/packages/ArgoData/s0ZAd/src/data_structures.jl:164
downloading floats list via ArgoData.jl
  Activating project at `~/work/OceanRobots.jl/OceanRobots.jl/docs`