From 27ae8543edfcb399ef14844c48e3fc98acefe994 Mon Sep 17 00:00:00 2001
From: Stefan Mauerberger <mauerber@gfz-potsdam.de>
Date: Fri, 15 Nov 2019 12:33:44 +0100
Subject: [PATCH] Update README.md

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/README.md b/README.md
index c31d9a8..d4ddbe4 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,52 @@
 
 ### CORrelation Based Archeomagnetic SnapShot model
 # Installation
+For the following `<corbass>` refers to the path you cloned the `CORBASS` repository into.
 
+1. Download and install [Miniconda] for Python 3.
+   Typically, the installation directory `<conda>` is `~/miniconda3/`.
+
+2. Build and install [FieldTools]
+
+   1. Install `conda-build` (not within a certain env but to base)
+   ```console
+   $ <conda>/bin/conda install conda-build
+   ```
+
+   2. Navigate to `<corbass>` and build [FieldTools]
+   ```console
+   $ <conda>/bin/conda build FieldTools
+   ```
+
+3. To create the virtual environment `CORBASS` and its dependencies run
+   ```console
+   $ <conda>/bin/conda env create -f corbass.yml
+   ```
+
+4. Activate virtual environment
+   ```console
+   $ source <conda>/bin/activate CORBASS
+   ```
+
+   Careful with tcshell. You have to use activate.csh.
+   In case you are don, deactivate the env by entering
+   ```console
+   (CORBASS)$ conda deactivate`.
+
+   ```
+
+5. Install optional packages e.g.
+   ```console
+   (CORBASS)$ conda install ipython jupyter
+   ```
+
+6. If the [corbass.yml](corbass.yml) changes, you are recommended to update your environment.
+   ```console
+   $ <conda>/bin/conda env update ???
+   ```
+
+[Miniconda]: https://conda.io/miniconda.html
+[FieldTools]: https://gitup.uni-potsdam.de/matusche/fieldtools
 
 # Documentation
 The `CORBASS` model is described in TODO: #12. In  a way this
-- 
GitLab