added conda environment yml

README.md

@@ -75,12 +75,14 @@ Collection of utility functions and classes that are used throughout both of the
 
 ### Latest release version
 
+Note: Currently it is preferable to use the [current code from git](#current-code-from-git-repositories) instead of the latest release from conda.
+
 #### Installation
 
 The latest _slic_ release is available via [conda](https://docs.conda.io/en/latest/) from the PSI channel. You may **either** create a new dedicated environment
 
 ```bash
-conda create -c paulscherrerinstitute -n slic slic
+conda create --name slic -c paulscherrerinstitute slic
 ```
 
 **or** install it (and its dependencies) into your current conda environment
@@ -125,19 +127,22 @@ This assumes that the command is executed from the folder where the beamline scr
 
 All dependencies should be available via [conda](https://docs.conda.io/en/latest/).
 
-If need be, create a new conda environment:
+A new conda environment containing all dependencies can be created from [`conda-env.yml`](conda-env.yml):
 
 ```bash
-conda create -n slic
-conda activate slic
+conda env create --name slic --file conda-env.yml
 ```
 
-Some dependencies might need the PSI channel, thus:
+The dependencies are pulled from the PSI channel and conda-forge as needed.
+
+Similarly, the dependencies may also be added to an existing environment:
 
 ```bash
-conda install -c paulscherrerinstitute bsread cam_server_client colorama data_api detector_integration_api elog ipython jungfrau_utils pyepics tqdm
+conda activate the_target_env
+conda env update --file conda-env.yml
 ```
 
+
 #### Installation
 
 The library and the beamline codes are stored in separate git repositories within a [gitlab group](https://gitlab.psi.ch/slic). This allows to easily check out only the desired parts.

conda-env.yml

@@ -0,0 +1,33 @@
+# use via:
+# conda env create --name $NEW_ENV_NAME --file $THIS_FILE_NAME
+# e.g.
+# conda env create --name slic --file conda-env.yml
+# NOTE: $NEW_ENV_NAME is optional and defaults to slic
+
+name: slic
+dependencies:
+  - python >=3.9
+# defaults
+  - ipython
+  - numpy
+  - scipy
+  - matplotlib
+# DAQ
+  - paulscherrerinstitute::bsread
+  - paulscherrerinstitute::cam_server_client
+  - paulscherrerinstitute::data_api
+  - paulscherrerinstitute::detector_integration_api
+  - paulscherrerinstitute::elog
+  - paulscherrerinstitute::pyepics >=3.4.2
+# data
+  - paulscherrerinstitute::jungfrau_utils >=3
+  - paulscherrerinstitute::sfdata
+# GUI
+  - wxpython
+# terminal
+  - colorama
+  - tqdm
+  - conda-forge::fuzzywuzzy
+  - conda-forge::yaspin
+
+