From 8e74c63656585a94a8b857e8f8ae46ad7f68ea89 Mon Sep 17 00:00:00 2001
From: JJDHooghiem <joramjd@gmail.com>
Date: Wed, 26 Oct 2022 10:01:10 +0200
Subject: [PATCH] updated readme with install instructions

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

diff --git a/README.md b/README.md
index 67cbd2dd..164eead2 100644
--- a/README.md
+++ b/README.md
@@ -124,3 +124,24 @@ script to start a new run, as follows:
 `./start_ctdas.sh /somedirectory/ name_of_your_run`
 This will create a new folder for your run, and makes a copy of the da folder. Furthermore, the main ctdas.py will be created, named name_of_your_run.py, along with the main jb and rc file. These are based on the templates in the template folder. In this way, you will always have the current version of the code with your run. For further information, please refer to: https://www.carbontracker.eu/ctdas/
 
+#### Installation as a site-package 
+
+In principle no installation is needed in order to do CTDAS runs. However, for testing purposes it may be desirable to be able to import this from another location in the filesystem, for example your project or anlysis folders. The following files
+```sh
+pyproject.toml
+setup.cfg
+```
+allow you to do 
+```sh
+cd CTDAS
+pip install --user . 
+```
+Which will do an install of the current repository. Note the installed version is not updated automatically, so if you make changes in you CTDAS project, it will not be updated in the site-packages. 
+
+Which version does my CTDAS-run use, the pip installed version or the version coppied to the run directory `start_ctdas.sh` script?
+It will run the coppied version. Python traverses the PYTHONPATH searching for imports, and the current working directory comes first. This may look somewhat inefficient from a software perspective; and inconvinient as updating this directroy from the CTDAS repository needs to be done manually, but it is actually by design: the CTDAS code used by the run is automatically archived with the run. This means that the data-assimiliation expiriment performed is fully transparant and traceble. This is desired from a scientific reproducibility perspective. 
+
+
+ 
+
+
-- 
GitLab