diff --git a/README.md b/README.md index 4131edb..6dc1dfb 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,6 @@ [![documentation latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://alexander-barth.github.io/DataAssim.jl/latest/) -[![DataAssim](http://pkg.julialang.org/badges/DataAssim_0.6.svg)](http://pkg.julialang.org/?pkg=DataAssim) - The packages implements various ensemble Kalman Filter data assimilation methods: diff --git a/docs/make.jl b/docs/make.jl index 85d292b..556930c 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -2,7 +2,7 @@ using Documenter using DataAssim makedocs( - format = :html, + format = Documenter.HTML(), modules = [DataAssim], sitename = "DataAssim", pages = [ @@ -16,7 +16,6 @@ makedocs( deploydocs( repo = "github.com/Alexander-Barth/DataAssim.jl.git", target = "build", - julia = "0.6", deps = nothing, make = nothing, ) diff --git a/docs/src/index.md b/docs/src/index.md index ae85163..b684043 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,6 +1,6 @@ # DataAssim.jl -Documentation for DataAssim.jl +Documentation for [DataAssim.jl](https://github.com/Alexander-Barth/DataAssim.jl) ## Simulation driver @@ -11,7 +11,7 @@ KalmanFilter fourDVar ``` -## Assimilation methods +## Ensemble methods ```@docs ETKF @@ -22,15 +22,26 @@ SEIK ESTKF serialEnSRF local_ETKF +local_EnKF +local_EnSRF +local_EAKF +local_SEIK +local_ESTKF ``` -### Models +## Models -``` +```@docs AbstractModel ModelMatrix ModelFun LinShallowWater1DModel Lorenz63Model ``` + +## Utility functions + +```@docs +compact_locfun +```