Commit 7b3b59e1 authored by Owen Arnold's avatar Owen Arnold
Browse files

Add documentation

parent c7cfd00f
# WFM Stitching module
This module uses Mantid to process neutron data recorded in wavelength
This package uses [Mantid](http://www.mantidproject.org/Main_Page) to process neutron data recorded in wavelength
frame multiplication (WFM) mode. This library is based on a previous
script written by Jon Taylor, Owen Arnold and Robin Woracek.
**Please note that this script is still under development.**
**Please note that this package is still under development.**
## Installation
1. Install Mantid from [here](http://download.mantidproject.org/) ensure that you take the official latest release.
2. Check that Mantid is in the python path. Official releases should automatically add themselves. i.e.
`echo $PYTHONPATH`
3. [Optional Step] We strongly recomment the use of `virtualenv` to install and use `wfm-stitching`, see [here](https://pypi.python.org/pypi/virtualenv) for information on installing and activating a virtual environment
4. Download and install the binary distribution
`pip install {path to *.whl}`
5. You can verify that this has installed correctly using:
`pip show wfm-stitching`
Yields for example if installed correctly:
```
---
Name: wfm-stitching
Version: 0.1.0
Location: ~/virtualenvironments/v20/lib/python2.7/site-packages
Requires: pyfits
```
6. You are done, you should be able to import from `wfm_stitching`, i.e.
```python
from wfm_stitching import WFMProcessor
```
# Processing Data
The processing is done using the class `WFMProcessor`, which can be
imported from the `wfm_stitching` module and requires a few arguments
......@@ -125,3 +158,7 @@ The size of the image is guessed by taking the square root of the number of spec
be overridden by supplying the `pixels`-parameter as an integer. The base filename will get
numbers appended to it, and each file contains it's position in the image stack in terms of
physical units (microseconds or Angstroms) in the header.
### Development
See development.md for important maintenance and development topics
# Packaging
```
python setup.py -v bdist_wheel --universal
```
`-v` option give verbose output and is optional. This creates a wheel in a newly created `dist` directory. For example:
```
dist/wfm_stitching-0.1.0-py2.py3-non-any.whl
```
These should be versioned against releases.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment