Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander-Barth committed Dec 14, 2018
1 parent 89b74fa commit fac9863
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
2 changes: 0 additions & 2 deletions README.md
Expand Up @@ -8,8 +8,6 @@

<!--[![documentation stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://alexander-barth.github.io/DataAssim.jl/stable/)-->
[![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:
Expand Down
3 changes: 1 addition & 2 deletions docs/make.jl
Expand Up @@ -2,7 +2,7 @@ using Documenter
using DataAssim

makedocs(
format = :html,
format = Documenter.HTML(),
modules = [DataAssim],
sitename = "DataAssim",
pages = [
Expand All @@ -16,7 +16,6 @@ makedocs(
deploydocs(
repo = "github.com/Alexander-Barth/DataAssim.jl.git",
target = "build",
julia = "0.6",
deps = nothing,
make = nothing,
)
19 changes: 15 additions & 4 deletions 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

Expand All @@ -11,7 +11,7 @@ KalmanFilter
fourDVar
```

## Assimilation methods
## Ensemble methods

```@docs
ETKF
Expand All @@ -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
```

0 comments on commit fac9863

Please sign in to comment.