commit 3866de603b8d9a2d354078dc8ca8e7075be16b3f
parent 96d098a3e61a7d36e12b64b90ce3234fe3e55338
Author: Anders Damsgaard <andersd@riseup.net>
Date: Mon, 11 Sep 2017 13:37:43 -0400
add empty file for simple example
Diffstat:
3 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/docs/make.jl b/docs/make.jl
@@ -10,6 +10,7 @@ makedocs(
"Home" => "index.md",
"Manual" => Any[
"man/installation.md",
+ "man/simple_example.md",
],
"Library" => Any[
"Public API" => "lib/public.md",
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -2,9 +2,9 @@
*A [Julia](https://julialang.org) package for particle-based simulation of sea-ice dynamics.*
-## Package features
+A flexible and computationally efficient 2d implementation of the discrete element method. Sea-ice floes are represented as particles, which can be forced by ocean and atmospheric velocity fields. The ice floes interact through elasto-viscous-frictional contact rheologies and obtain time-dependent tensile strength.
-Flexible and computationally efficient 2d implementation of the discrete element method. The particles represent sea-ice floes, which can be forced by ocean and atmospheric velocity fields. The ice floes can interact through elasto-viscous-frictional contact rheologies and obtain time-dependent tensile strength.
+The source code for SeaIce.jl is hosted on [Github](https://github.com/anders-dc/SeaIce.jl).
See the [Public API Index](@ref main-index) for the complete list of documented functions and types.
@@ -21,6 +21,7 @@ SeaIce.jl is licensed under the GPLv3; see [LICENSE](https://github.com/anders-d
```@contents
Pages = [
"man/installation.md",
+ "man/simple_example.md",
]
Depth = 1
```
diff --git a/docs/src/man/simple_example.md b/docs/src/man/simple_example.md
@@ -0,0 +1,2 @@
+# A simple example
+
