README.md

DevOps	Release

ADDIE

ADDIE stands for ADvandced DIffraction Environment, 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).

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 is the mantid-total-scattering project.

Installation

Anaconda

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 (or Update)

conda install -c addie-diffraction addie 

If there are issues with mantid-workbench or mantid-total-scattering dependencies (broken, errors, etc.), then you can delete the environment and re-install addie in a new environment ("turn it off and back on again")

Go here for how to delete an environment or use:

conda remove --name addie_env --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 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:

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

Building

Before doing the normal python setup.py ... things you must convert the designer/*.ui files to addie*.py. This is done with python setup.py pyuic. After that, all the normal setuptools magic applies.

To run from source (step 1 only needs to be done if the .ui file changes):

$ addiedevel.sh

If you are want to specify a different mantidpython, then add it as a command line argument

$ addiedevel.sh /opt/mantid37/bin/mantidpython

Similarly, there is a script for windows (experimental)

addiedevel.bat

The test suite can be run using pytest with the pytest-qt plugin.

$ pytest tests

Developing using virtual environments

If you normally develop using virtualenv or friends, you can develop addie that way as well. After creating the virtual environment, run

<MANTIDBUILDDIR>/bin/AddPythonPath.py

which will add a file, mantid.pth to your environment with the location of mantid. Then you need to setup for development:

python setup.py develop

will put the rest of addie into your environment so you only need to edit files and type addie.

As an extra reference, use direnv to manange your virtual environments. For a python2 virtual environment the .envrc file should contain

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:

cd addie
pipenv --two
echo layout_pipenv > .envrc
direnv allow

Creating RPMs

Python generated srpm are not as flexible as they should be. To generate one that is run buildrpm and look for the files in the dist directory.

$ ./buildrpm

The rpms are available on copr.