Merge pull request #145 from gaelforget/v0p6p2a

V0p6p2a

Project.toml

@@ -1,7 +1,7 @@
 name = "Drifters"
 uuid = "bd752fb7-3f37-44cb-a8fb-f461137b623f"
 authors = ["gaelforget <[email protected]>"]
-version = "0.6.1"
+version = "0.6.2"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"

docs/Project.toml

@@ -1,4 +1,5 @@
 [deps]
+CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 Climatology = "9e9a4d37-2d2e-41e3-8b85-f7978328d9c7"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"

docs/src/workflow.md

@@ -10,6 +10,25 @@ As shown in the [Examples](@ref) section, the typical worflow is:
 
 The data structures for steps `1` and `2` are documented below. Steps `3` and `4` normally take place as part of `solve!` (i.e. `∫!`) which post-processes results, using 🔧, records them in 🔴, and finally updates the positions of individuals in 📌. Since 🔴 is a [DataFrame](https://juliadata.github.io/DataFrames.jl/latest/), it is easily manipulated, plotted, or saved in step `4` or after the fact.
 
+```@example ex1
+using Drifters, CairoMakie
+P=Drifters.Gulf_of_Mexico_setup()
+F=FlowFields(u=P.u,v=P.v,period=P.T)
+I=Individuals(F,P.x0,P.y0);
+[solve!(I,P.T .+P.dT*(n-1)) for n in 1:P.nt]
+summary(I.🔴)
+```
+
+Plotting functions are provided in the `Makie.jl` extension, and operated via `DriftersDataset`.
+
+```@example ex1
+#prefix="real "; gdf=Drifters.groupby(P.obs,:ID)
+prefix="virtual "; gdf=Drifters.groupby(I.🔴,:ID)
+options=(plot_type="jcon_drifters",prefix=prefix,xlims=(-98,-78),ylims=(18,31),pol=P.pol)
+LoopC=DriftersDataset(  data=(gdf=gdf,), options=options )
+plot(LoopC)
+```
+
 ## Overview
 
 A central goal of this package is to support scientific analysis of model simulations and observations of materials and particles within the Climate System. The package scope thus includes, for example, drifting plastics in the Ocean or chemical compounds in the Atmosphere.