updates docs first page [ci-skip]

FourierFlows · Apr 14, 2018 · c8c47dd · c8c47dd
1 parent 4b4dbd8
commit c8c47dd
Showing 1 changed file with 5 additions and 6 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -66,9 +66,8 @@ Here's an overview of the code structure:
         - `barotropicqg.jl`: Defines a `BarotropicQG` module that provides
                 several solvers for the barotropic QG model that permit beta,
                 topography, beta + topography, and forcing.
-        - `twomodeboussinesq.jl`: Defines a `TwoModeBoussinesq` module
-                that provides solvers for a two-mode truncation of the
-                rotating, stratified Boussinesq equation.
+        - `kuramotosivashinsky.jl`: Defines a `KuramotoSivashinsky` module that
+                solves the Kuramoto-Sivashinsky.
         - `traceradvdiff.jl`: Defines a `TracerAdvDiff` module that
                 provides a solver for a two-dimensional and periodic tracer
                 field in a given 2D flow (u, w), which can be an arbitrary
@@ -77,7 +76,7 @@ Here's an overview of the code structure:
 ## Writing fast solvers
 
 The performance-intensive part of the code involves just two functions: the
-timestepping scheme `stepforward!`, and the function `calcN!` that
+time-stepping scheme `stepforward!`, and the function `calcN!` that
 calculates the nonlinear part of the given equation's right-hand side.
 Optimization of these two functions for a given problem will produce the
 fastest possible code.
@@ -89,11 +88,11 @@ fastest possible code.
 
   > McWilliams, J. C. (1984). The emergence of isolated coherent vortices in turbulent flow. *J. Fluid Mech.*, **146**, 21-43
 
-- `examples/barotropicqg/decayingbetaturb.jl`: An example script that simulates decaying quasi-geostrophic flow on a beta-plane.
+- `examples/barotropicqg/decayingbetaturb.jl`: An example script that simulates decaying quasi-geostrophic flow on a beta-plane demonstrating zonation.
 
 - `examples/barotropicqg/ACConelayer.jl`: A script that simulates barotropic quasi-geostrophic flow above topography reproducing the results of the paper by
 
-  > Constantinou, N. C. (2018). A barotropic model of eddy saturation. *J. Phys. Oceanogr.*, in press, doi:10.1175/JPO-D-17-0182.1
+  > Constantinou, N. C. (2018). A barotropic model of eddy saturation. *J. Phys. Oceanogr.*, **48 (2)**, 397-411