Developement Guide

This guide provides instructions for setting up an environment for developing nmrglue and an overview of the project layout and contribution process.

Requirements

To create an environment for developing nmrglue the following must be installed and available.

• Numpy
• SciPy
• nose
• Sphinx
• git

In addition the following Python packages are highly recommended.

• matplotlib
• IPython

A easy way of obtaining and installing these packages is to use a Python distribution which provides these packages, such as EPD. Detailed information on installing a Scipy stack is available.

Finally, other NMR software packages must be installed to process and convert the test and example data. These are not required for using nmrglue, but are needed to verify its functionality and to run some of the examples.

• NMRPipe
• Sparky
• The Rowland NMR Toolkit
• SIMPSON