Merge pull request #99 from JuliaOcean/v0p2p5d

update actions, docs

.github/workflows/ci.yml

@@ -23,7 +23,7 @@ jobs:
           - x64
     steps:
       - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
@@ -41,9 +41,10 @@ jobs:
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v4
+        env:
+          token: ${{ secrets.CODECOV_TOKEN }}
         with:
           file: lcov.info
-          token: ${{ secrets.CODECOV_TOKEN }}
   docs:
     name: Documentation
     runs-on: ubuntu-latest

docs/src/examples.md

@@ -7,21 +7,21 @@
 
 ## Included Notebooks
 
-- [OceanOPS.jl](OceanOPS.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/OceanOPS.jl)) : global ocean observing systems
-- [ShipCruise\_CCHDO.jl](ShipCruise_CCHDO.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/ShipCruise_CCHDO.jl)) : [ship](https://cchdo.ucsd.edu) CTD and other data
-- [Float\_Argo.jl](Float_Argo.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Float_Argo.jl)) : Argo profiling [float](https://argo.ucsd.edu) data
-- [Drifter\_GDP.jl](Drifter_GDP.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Drifter_GDP.jl)) : [drifter](https://www.aoml.noaa.gov/phod/gdp/hourly_data.php) time series
-- [Drifter\_CloudDrift.jl](Drifter_CloudDrift.html) (➭ [code link](https://github.com/JuliaOcean/OceanRobots.jl/blob/master/examples/Drifter_CloudDrift.jl)) : drifter statistics
-- [Glider\_Spray.jl](Glider_Spray.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Glider_Spray.jl)) : underwater [glider](http://spraydata.ucsd.edu/projects/) data
-- [Buoy\_NWP\_NOAA.jl](Buoy_NWP_NOAA.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Buoy_NWP_NOAA.jl)) : NOAA [station](https://www.ndbc.noaa.gov/) data (a few days)
-- [Buoy\_NWP\_NOAA\_monthly.jl](Buoy_NWP_NOAA_monthly.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Buoy_NWP_NOAA_monthly.jl)) : NOAA [station](https://www.ndbc.noaa.gov/) data (monthly means) 
-- [Mooring\_WHOTS.jl](Mooring_WHOTS.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Mooring_WHOTS.jl)) : WHOTS [mooring](http://www.soest.hawaii.edu/whots/wh_data.html) data
+- [OceanOPS.html](OceanOPS.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/OceanOPS.jl)) : global ocean observing systems
+- [ShipCruise\_CCHDO.html](ShipCruise_CCHDO.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/ShipCruise_CCHDO.jl)) : [ship](https://cchdo.ucsd.edu) CTD and other data
+- [Float\_Argo.html](Float_Argo.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Float_Argo.jl)) : Argo profiling [float](https://argo.ucsd.edu) data
+- [Drifter\_GDP.html](Drifter_GDP.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Drifter_GDP.jl)) : [drifter](https://www.aoml.noaa.gov/phod/gdp/hourly_data.php) time series
+- [Drifter\_CloudDrift.html](Drifter_CloudDrift.html) (➭ [code link](https://github.com/JuliaOcean/OceanRobots.jl/blob/master/examples/Drifter_CloudDrift.jl)) : drifter statistics
+- [Glider\_Spray.html](Glider_Spray.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Glider_Spray.jl)) : underwater [glider](http://spraydata.ucsd.edu/projects/) data
+- [Buoy\_NWP\_NOAA.html](Buoy_NWP_NOAA.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Buoy_NWP_NOAA.jl)) : NOAA [station](https://www.ndbc.noaa.gov/) data (a few days)
+- [Buoy\_NWP\_NOAA\_monthly.html](Buoy_NWP_NOAA_monthly.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Buoy_NWP_NOAA_monthly.jl)) : NOAA [station](https://www.ndbc.noaa.gov/) data (monthly means) 
+- [Mooring\_WHOTS.html](Mooring_WHOTS.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/Mooring_WHOTS.jl)) : WHOTS [mooring](http://www.soest.hawaii.edu/whots/wh_data.html) data
 
 ## More Notebooks
 
 - For Argo and state estimates, see [ArgoData.jl](https://github.com/JuliaOcean/ArgoData.jl)
 - For simulations of drifter data, see [IndividualDisplacements.jl](https://github.com/JuliaClimate/IndividualDisplacements.jl)
-- [SatelliteAltimetry.jl](SatelliteAltimetry.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/SatelliteAltimetry.jl)) : gridded satellite data
+- [SatelliteAltimetry.html](SatelliteAltimetry.html) (➭ [code link](https://raw.githubusercontent.com/JuliaOcean/OceanRobots.jl/master/examples/SatelliteAltimetry.jl)) : gridded satellite data
 
 ## How-To
 
@@ -31,7 +31,16 @@ To run a notebook interactively (`.jl` files) you want to use [Pluto.jl](https:/
 
 All you need to do beforehand is to install [julia](https://julialang.org) 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 and run them as normal Julia programs. We recommend runing each notebook in its own environment as shown below. 
+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)`)
+```
 
 ```@example 1
 using Pkg; Pkg.add("Pluto"); using Pluto
@@ -44,12 +53,3 @@ Pkg.instantiate()
 include(notebook)
 Pkg.activate("..") #hide
 ```
-
-!!! note
-    To download OceanRobots.jl folder, which includes the notebook, you can use `Git.jl`.
-
-```
-using Pkg; Pkg.add("Git"); using Git
-url="https://github.com/JuliaOcean/OceanRobots.jl"
-run(`$(git()) clone $(url)`)
-```

docs/src/reference.md

@@ -2,9 +2,23 @@
 
 Each type of ocean data gets :
 
-- a simple `read` function that downloads data if needed. 
+- a simple `read` function that downloads data if needed.
 - a default `plot` function that depicts some of the data.
 
+# Functionalities
+
+## read
+
+```@docs
+read
+```
+
+## plot
+
+```@docs
+plot
+```
+
 # Supported Datasets
 
 ```@setup ex1
@@ -88,16 +102,3 @@ sla=read(SeaLevelAnomaly(),:sla_podaac)
 plot(sla)
 ```
 
-# Functionalities
-
-## read
-
-```@docs
-read
-```
-
-## plot
-
-```@docs
-plot
-```