README.rst 2.69 KB
Newer Older
Peterson, Peter's avatar
Peterson, Peter committed
1
========
2
3
4
drt-sans
========

5
6
7
Data Reduction Toolkit for Small Angle Neutron Scattering

This packages is a collection of functionality for reducing SANS data developed in collaboration with the instrument scientists at the High Flux Isotope Reactor (HFIR) and Spallation Neutron Source (SNS) at Oak Ridge National Laboratory.
8

9
10
While much of the functionality is generic, this implementation is aimed at reducing data from BIOSANS, EQSANS, and GPSANS.
As appropriate, this work is an abstraction layer on top of the mantid project.
11
12
13

**This is a python3 only package.**

Peterson, Peter's avatar
Peterson, Peter committed
14
------------------------------
15
16
17
Usage from provided front-ends
------------------------------

18
For end users go to
19
20
21
22
23
`QA version <http://scse-ui.ornl.gov:8080/>`_

Use `jupyter <https://jupyter.sns.gov/>`_ to have a play with the code.
The kernel to select is ``sans at ...``.

Savici, Andrei T's avatar
Savici, Andrei T committed
24
25
26
27
28
29
30
One can run scripts directly on `analysis <https://analysis.sns.gov/>`_ cluster.
To do that, open a terminal and activate the desired conda environment. The options are:

* ``sans`` the latest stable release
* ``sans-qa`` the future stable release (to be tested right before the next iteration)
* ``sans-dev`` the latest development version

31
The easiest way to start an interactive ipython session is by running
Savici, Andrei T's avatar
Savici, Andrei T committed
32
33
34

.. code-block:: shell

35
   $ drtsans
Savici, Andrei T's avatar
Savici, Andrei T committed
36

37
38
adding ``--qa`` or ``--dev`` will start the qa or development version respectively.
The ``drtsans`` wrapper script launches ipython with the selected conda environment located in ``/opt/anaconda/envs/` and deactivates the conda environment when the session ends.
Savici, Andrei T's avatar
Savici, Andrei T committed
39
40


41
One must have an XCAMS account to use either the jupyter kernel provided above.
42

Peterson, Peter's avatar
Peterson, Peter committed
43
-------------------------------------
44
45
46
47
48
49
50
51
52
Using the Docker packaged environment
-------------------------------------

This the instructions for someone who wants to use the Docker container
created through the automated build pipeline to develop drt-sans, use
drt-sans to develop reduction scripts, or test existing drt-sans
functionality. The SNS analysis cluster does not have Docker installed
and Docker is required to follow these instructions.

53
1. (If not installed) `Install Docker <https://docs.docker.com/install/>`_
Peterson, Peter's avatar
Peterson, Peter committed
54
2. Download the latest ``sans-backend-run.sh`` `script <scripts/sans-backend-run.sh>`_ from the feature, release, or master branch for which you are testing:
55
56
57
3. Run the script with ``sudo bash sans-backend-run.sh -h`` to see the help menu.

Current options include:
Savici, Andrei T's avatar
Savici, Andrei T committed
58

59
60
61
* ``-i`` launches a bash shell
* ``-u`` forces an update of the application
* ``-h`` prints the help message
62
63
64

You must download the wrapper script from the above link as the build process modifies the copy in version control.

Peterson, Peter's avatar
Peterson, Peter committed
65
-----------------------------------------------
66
Set-up for development in a virtual environment