tadd notes on updating - Granular.jl - Julia package for granular dynamics simu… | |
git clone git://src.adamsgaard.dk/Granular.jl | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit d3f684c37fa457c4e2afd7abf783993509bf5a33 | |
parent 3ddfb848626100230bbabd79a1669a62ae45f94b | |
Author: Anders Damsgaard <[email protected]> | |
Date: Tue, 7 Nov 2017 10:42:50 -0500 | |
add notes on updating | |
Diffstat: | |
M docs/make.jl | 1 + | |
M docs/src/index.md | 13 +++++++------ | |
M docs/src/man/getting_started.md | 5 ++++- | |
M docs/src/man/installation.md | 11 +++++++++-- | |
A docs/src/methods.md | 1 + | |
5 files changed, 22 insertions(+), 9 deletions(-) | |
--- | |
diff --git a/docs/make.jl b/docs/make.jl | |
t@@ -11,6 +11,7 @@ makedocs( | |
"Manual" => Any[ | |
"man/installation.md", | |
"man/package_contents.md", | |
+ "man/methods.md", | |
"man/getting_started.md", | |
], | |
"Library" => Any[ | |
diff --git a/docs/src/index.md b/docs/src/index.md | |
t@@ -1,13 +1,13 @@ | |
# Granular.jl | |
-*A [Julia](https://julialang.org) package for particle-based simulation of sea… | |
+*A [Julia](https://julialang.org) package for particle-based simulation of | |
+granular dynamics.* | |
`Granular.jl` is a flexible and computationally efficient 2d implementation of | |
-the discrete element method, made for simulating sea ice in a Lagrangian | |
-manner. Grains are represented as particles, which can be forced by drag in | |
-grids, such as ocean and atmospheric velocity fields. The grains interact | |
-through elasto-viscous-frictional contact rheologies and can obtain | |
-time-dependent tensile strength. | |
+the discrete element method. Grains are represented as particles, which can b… | |
+forced by drag in fluid grids. The grains interact through | |
+elasto-viscous-frictional contact rheologies and can obtain time-dependent | |
+tensile strength. | |
The source code for Granular.jl is hosted on [Github](https://github.com/ander… | |
t@@ -27,6 +27,7 @@ Granular.jl is licensed under the GPLv3; see [LICENSE](https… | |
Pages = [ | |
"man/installation.md", | |
"man/package_contents.md", | |
+ "man/methods.md", | |
"man/getting_started.md", | |
] | |
Depth = 1 | |
diff --git a/docs/src/man/getting_started.md b/docs/src/man/getting_started.md | |
t@@ -1,2 +1,5 @@ | |
-# A simple example | |
+# Getting started | |
+ | |
+ | |
+## Collision between two particles | |
diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md | |
t@@ -1,4 +1,6 @@ | |
# Installation | |
+Julia includes a very useful package manager which makes it easy to install | |
+packages and their requirements, as well as convenient updating features. | |
## Stable installation (recommended) | |
The latest stable release of Granular.jl can be installed directly from the | |
t@@ -13,6 +15,7 @@ This will install the contents of this repository in the fol… | |
package [JLD](https://github.com/JuliaIO/JLD.jl) is used for model restarts an… | |
is recommended but not required, and is thus not automatically installed. | |
+## Development installation | |
If desired, the current developmental version of the [Granular.jl Github | |
repository](https://github.com/anders-dc/Granular.jl) can be installed with th… | |
command: | |
t@@ -24,6 +27,10 @@ julia> Pkg.clone("git://github.com/anders-dc/Granular.jl") | |
*Please note:* The developmental version is considered unstable and should onl… | |
be used over the stable version if there is a compelling reason to do so. | |
+## Keeping the package up to date | |
+With the `Pkg.update()` command, Julia checks and updates all installed | |
+packages to their newest versions. | |
+ | |
## Package tests | |
The Granular.jl package contains many tests that verify that the functionality | |
works as intended. The extent of test coverage of the source code is monitore… | |
t@@ -42,5 +49,5 @@ julia> Pkg.test("Granular") | |
``` | |
In case any of these tests fail, please open a [Github | |
-Issue](https://github.com/anders-dc/Granular.jl/issues) so it can be | |
-investigated and diagnosed further. | |
+Issue](https://github.com/anders-dc/Granular.jl/issues) describing the problem… | |
+so further investigation and diagnosis can follow. | |
diff --git a/docs/src/methods.md b/docs/src/methods.md | |
t@@ -0,0 +1 @@ | |
+# Computational methods |