Create README.md

eefvandongen · Mar 18, 2018 · 5c82d34 · 5c82d34
1 parent 671246f
commit 5c82d34
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,12 @@
+# FS-SSAcouplingElmerIce
+This code performs the FS-SSA coupling described in https://doi.org/10.5194/gmd-2017-312
+The code uses the FEM software Elmer(/Ice), which is available at https://github.com/ElmerCSC/elmerfem
+and can be redistributed and/or modified under the terms of the GNU General Public License as published by the Free Software Foundation; 
+either version 2 of the License, or (at your option) any later version. 
+Documentation and installation instructions for Elmer/Ice are provided at http://elmerice.elmerfem.org/wiki/
+
+It is possible to access the version of Elmer/Ice including the coupling as discussed in the paper, 
+linked to a unique SHA, by using the following git command, after having cloned the Elmer repository:
+git checkout ba117583defafe98bb6fd1793c9c6f341c0c876 .
+or download the entire repository by
+https://github.com/ElmerCSC/elmerfem/archive/ba117583defafe98bb6fd1793c9c6f341c0c876.zip