From dedeac50752ff8e5ddc4d4101ebdb5b50ad2587e Mon Sep 17 00:00:00 2001 From: Marshall McDonnell <mcdonnellmt@ornl.gov> Date: Mon, 13 May 2019 14:35:43 -0400 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index eacf15d4..81eefbe4 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,27 @@ [](https://travis-ci.org/neutrons/addie) -Addie +ADDIE ====== -Lots of wonderful text about this being a GUI to do a Fourier transform. +**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). -Building --------- +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/marshallmcdonnell/mantid_total_scattering) project. + +Installation +------------ + +### Anaconda +(coming soon) + + +Development +------------ + +### Building Before doing the normal `python setup.py ...` things you must convert the `designer/*.ui` files to `addie*.py`. This is done with