setup instructions

Author: Daan van Vugt

README.md

@@ -7,7 +7,7 @@ Integrated Modelling & Analysis Suite (IMAS) Data Model.
 
 It provides:
 * An easy-to-install and easy-to-get started package by
-   * Not requiring an IMAS installation
+  * Not requiring an IMAS installation
   * Not strictly requiring matching a Data Dictionary (DD) version
 * An pythonic alternative to the IMAS Python High Level Interface (HLI)
 * Checking of correctness on assign time, instead of database write time
@@ -26,7 +26,7 @@ and can be found at the [ITER sharepoint](https://sharepoint.iter.org/department
 
 IMASPy is a standalone python package with optional dependencies. All needed
 python packages can be found in `requirements.txt`, and should all be publicly
-available. A simple `pip install` should take care of everything.
+available. A simple `pip install -r requirements.txt` should take care of everything.
 
 #### Being IMAS DD compatible
 

docs/source/installing.rst

@@ -10,7 +10,7 @@ IMASPy also needs the :al_lib:`IMAS Python helper functions <browse>`. Currently
 dependencies are pulled it using :std:doc:`GitPython <gitpython:index>`, until the
 :issue:`separate Python HLI parts are available as packages <IMAS-584>`.
 
-.. :std:doc:`Cython <cython:index>` of the 
+.. :std:doc:`Cython <cython:index>` of the
 
 
 Python is very flexible, and so is it's install procedure. This is a double-edged sword:
@@ -20,13 +20,12 @@ community. For an introduction to the topic, read the
 
 Installing on the ITER cluster
 ------------------------------
-We assume a clean system. To interact with the AL, we need the IMAS environment
+To interact with the AL, we need the IMAS environment
 activated. I'm assuming a bash shell for all these commands:
 
 .. code-block:: bash
 
-    module load AL-Python-lib
-    module load AL-Cython
+    module load IMAS-2020a/3.30.0-4.8.5-2020a
 
 This should give us all we need, namely at time of testing:
 
@@ -38,14 +37,18 @@ We are all developers, let's install in [pip editable](https://pip.pypa.io/en/st
 
 .. code-block:: bash
 
-    git clone git@gitlab.com:klimex/imaspy.git
-    pip install --user -e imaspy[backends_al,backends_xarray,test]
+    git clone git@git.iter.org/IMAS/imaspy.git
+    pip install --user -e imaspy
 
 
-We should now be able to run the examples
+We should now be able to run the tests
 
 .. code-block:: bash
-    python imaspy/examples/read_write_nbi.py
+    pip install --user -r requirements_test.txt
+    pytest imaspy/ --mini
+
+Note that at the time of writing access layer version 4.8.5 has an issue which causes
+several tests to fail.
 
 Develop install
 ^^^^^^^^^^^^^^^