commit 0901e18f68b53a5a62de247cc5b9b1c31e4f4df0
parent 740d3e48afbcdeed3cb3de3a694608c9a556f8d2
Author: Anders Damsgaard <andersd@riseup.net>
Date: Sat, 9 Sep 2017 10:08:54 -0400
add preliminary documentation through Documenter.jl
Diffstat:
3 files changed, 68 insertions(+), 0 deletions(-)
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,23 @@
+using Documenter, SeaIce
+
+makedocs(
+ modules = [SeaIce],
+ clean = false,
+ format = :html,
+ sitename = "SeaIce.jl",
+ authors = "Anders Damsgaard",
+ pages = Any[ # Compat: `Any` for 0.4 compat
+ "Home" => "index.md",
+ "Manual" => Any[
+ "installation.md"
+ ]
+ ]
+)
+
+deploydocs(
+ repo = "github.com/anders-dc/SeaIce.jl.git",
+ julia = "0.6",
+ deps = nothing,
+ make = nothing,
+ target = "build"
+)
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,21 @@
+# SeaIce.jl
+
+*Package for particle-based simulation of sea-ice dynamics*
+
+## Package features
+
+Flexible and computationally efficient 2d implementation of the discrete element method. The particles represent sea-ice floes, which can be forced by ocean and velocity fields. The ice floes can interact through elasto-viscous-frictional contact rheologies and obtain time-dependent tensile strength.
+
+## Manual Outline
+
+```@contents
+Pages = [
+ "installation.md"
+]
+Depth = 1
+```
+
+## Index
+
+```@index
+```
diff --git a/docs/src/installation.md b/docs/src/installation.md
@@ -0,0 +1,24 @@
+# Installation
+SeaIce.jl can be installed directly from the Julia shell by:
+
+ Pkg.clone("git://github.com/anders-dc/SeaIce.jl.git")
+
+This will install the contents of this repository in the folder
+`~/.julia/v$(JULIA_VERSION)/SeaIce`, and install the packages specified as
+[requirements](REQUIRE). The package [JLD](https://github.com/JuliaIO/JLD.jl)
+is used for model restarts and is recommended but not required, and thus is not
+automatically installed.
+
+Import the package contents into the current Julia session or script with:
+
+ import SeaIce
+
+This will import all functions and data types in the `SeaIce` namespace. You
+can run the package tests, which are contained in the [test/ directory](test/),
+with the following command:
+
+ Pkg.test("SeaIce")
+
+The package can be updated from this repository using:
+
+ Pkg.update("SeaIce")
