Skip to content

Commit 8c7e61a

Browse files
Update README for conda install
1 parent dedeac5 commit 8c7e61a

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,48 @@ Installation
1515
------------
1616

1717
### Anaconda
18-
(coming soon)
18+
19+
**Setup**
20+
21+
Add channels with dependencies, create a conda environment with `python_version` set to either `2.7.14` or `3.6`, and activate the environment
22+
23+
```
24+
conda config --add channels conda-forge --add channels marshallmcdonnell --add channels mantid --add channels mantid/label/nightly
25+
conda create -n addie_env python=${python_version}
26+
source activate addie_env
27+
```
28+
29+
**Install**
30+
31+
```
32+
conda install -c addie-diffraction addie
33+
```
34+
35+
**Notes**
36+
37+
If you have an error (see below for example) related to the `libGL` library, you may not have it installed for the Mantid Framework to work. See instructions [here](https://github.com/mantidproject/conda-recipes/#gl-and-glu-libs) for installing the necessary libraries for different OS
38+
39+
Example error:
40+
`ImportError: First import of "._api" failed with "libGL.so.1: cannot open shared object file...`
41+
42+
If you have an error that another version of Mantid is installed on the machine and being imported via `PYTHONPATH`, you can use the following as a workaround for CLI tool:
43+
44+
```
45+
PYTHONPATH="" addie
46+
```
47+
48+
# Usage (CLI reduction tool)
49+
50+
To launch ADDIE, run the following from the command line:
51+
52+
```bash
53+
addie
54+
```
55+
56+
If you need to specify the path to Mantid build, use:
57+
```
58+
MANTIDPATH=/path/to/mantid/build/bin PATH=$MANTIDPATH:$PATH PYTHONPATH=$MANTIDPATH:$PATH addie
59+
```
1960

2061

2162
Development

0 commit comments

Comments
 (0)