Merge pull request #330 from neutrons/328-migration-addie-conda

Fixes badges for addie conda migration

README.md

@@ -1,26 +1,55 @@
 | CI     | Release | Other |
 |--------|---------|-------|
-| [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fneutrons%2Faddie%2Fbadge&style=plastic)](https://actions-badge.atrox.dev/neutrons/addie/goto)  | [![Anaconda-Server Badge](https://anaconda.org/addie-diffraction/addie/badges/version.svg)](https://anaconda.org/addie-diffraction/addie) | [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT) |
-|  | [![Anaconda-Server Badge](https://anaconda.org/addie-diffraction/addie/badges/platforms.svg)](https://anaconda.org/addie-diffraction/addie) | |
+| [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fneutrons%2Faddie%2Fbadge&style=plastic)](https://actions-badge.atrox.dev/neutrons/addie/goto)  | [![Anaconda-Server Badge](https://anaconda.org/neutrons/addie/badges/version.svg)](https://anaconda.org/neutrons/addie) | [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT) |
+|  | [![Anaconda-Server Badge](https://anaconda.org/neutrons/addie/badges/platforms.svg)](https://anaconda.org/neutrons/addie) | |
 
 # ADDIE
 
-**ADDIE** stands for **AD**vandced **DI**ffraction **E**nvironment, a data reduction application for total scattering powder diffraction data. 
+**ADDIE** stands for **AD**vandced **DI**ffraction **E**nvironment,
+a data reduction application for total scattering powder diffraction data.
 
-The name came about from being developed for the Diffraction Group at SNS located at ORNL (and previously known as the Advanced Diffraction Group).
+The name came about from being developed for the Diffraction Group
+at SNS located at ORNL (and previously known as the Advanced Diffraction Group).
 
-This "reduction" entails taking raw neutron counts from detectors in the diffraction experiment and turning them into the reciprocal-space structure factor patterns, F(Q) or S(Q), and applying a Fourier Transform to real-space to give the pair distribution fuction, PDF.
+This "reduction" entails taking raw neutron counts from detectors
+in the diffraction experiment and turning them into the
+reciprocal-space structure factor patterns, F(Q) or S(Q),
+and applying a Fourier Transform to real-space to give
+the pair distribution fuction, PDF.
 
-ADDIE is a front-end GUI for total scattering that hopes to support multiple diffractometers performing total scattering measurements. The back-end that uses the [Mantid Framework](https://docs.mantidproject.org/nightly/) is the [`mantid-total-scattering`](https://github.com/neutrons/mantid_total_scattering) project.
+ADDIE is a front-end GUI for total scattering that hopes to support
+multiple diffractometers performing total scattering measurements.
+The back-end that uses the
+[Mantid Framework](https://docs.mantidproject.org/nightly/)
+is the [`mantid-total-scattering`](https://github.com/neutrons/mantid_total_scattering)
+project.
 
 ## Install
 
+Setup conda environment to install ADDIE into:
 ```
-conda config --add channels conda-forge --add channels neutrons --add channels mantid --add channels mantid/label/nightly
-conda create -n addie_env python=${python_version}
-source activate addie_env
+conda config --add channels neutrons
+conda config --add channels mantid
+conda config --add channels conda-forge
+conda create -n addie-env
+source activate addie-env
 ```
 
+Install ADDIE in the conda environment:
+```
+conda install -q -y -c conda-forge nexus==4.4.3
+conda install -q -y -c mantid poco==1.7.3
+conda install -q -y -c mantid mantid-workbench==5.0.20200504.1630
+conda install -q -y -c neutrons mantid-total-scattering-python-wrapper
+conda install -q -y -c neutrons addie==${ADDIE_VERSION}
+```
+
+The install steps above have been found to create a reproducible install.
+If not done in this order, conda can identify different configurations that are NOT in a working state.
+
+NOTE: You may need to ensure some packages are not imported from the `defaults` channel. 
+As above, add them prior to installing ADDIE where the channel is set explicitly
+
 ## Uninstall
 
 ```
@@ -51,6 +80,7 @@ conda env create
 source activate addie
 python setup.py install
 ```
+
 ### Uninstall
 
 ```
@@ -60,15 +90,18 @@ conda remove -n addie --all
 
 **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
+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...
 ```
 
-
 ### Testing
 
 The test suite can be run using [pytest](https://docs.pytest.org/en/latest/)
@@ -77,7 +110,6 @@ with the [pytest-qt](https://pytest-qt.readthedocs.io/en/latest/) plugin.
 $ pytest tests
 ```
 
-
 ### Developing using a local Mantid install
 
 If you normally develop using `virtualenv` or friends, you can develop
@@ -105,7 +137,8 @@ layout python2 -- --system-site-packages
 ```
 so the system wide packages installed for mantid are found.
 
-or with `pipenv` (which will use Pipfile), first setup the directory and then add the `.envrc` file:
+or with `pipenv` (which will use Pipfile),
+first setup the directory and then add the `.envrc` file:
 ```
 cd addie
 pipenv --two