Skip to content

Commit

Permalink
Update README for conda install
Browse files Browse the repository at this point in the history
  • Loading branch information
marshallmcdonnell authored May 14, 2019
1 parent dedeac5 commit 8c7e61a
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,48 @@ Installation
------------

### Anaconda
(coming soon)

**Setup**

Add channels with dependencies, create a conda environment with `python_version` set to either `2.7.14` or `3.6`, and activate the environment

```
conda config --add channels conda-forge --add channels marshallmcdonnell --add channels mantid --add channels mantid/label/nightly
conda create -n addie_env python=${python_version}
source activate addie_env
```

**Install**

```
conda install -c addie-diffraction addie
```

**Notes**

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

Example error:
`ImportError: First import of "._api" failed with "libGL.so.1: cannot open shared object file...`

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:

```
PYTHONPATH="" addie
```

# Usage (CLI reduction tool)

To launch ADDIE, run the following from the command line:

```bash
addie
```

If you need to specify the path to Mantid build, use:
```
MANTIDPATH=/path/to/mantid/build/bin PATH=$MANTIDPATH:$PATH PYTHONPATH=$MANTIDPATH:$PATH addie
```


Development
Expand Down

0 comments on commit 8c7e61a

Please sign in to comment.