Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 2.38 KB

README.rst

File metadata and controls

52 lines (34 loc) · 2.38 KB
Raw

suspect

CI build_status
Coveralls coverage_status
Code Climate code_climate

Suspect is a Python package for processing MR spectroscopy data. It supports reading data from most common formats (with more on the way) and many different algorithms for core processing steps. Suspect allows researchers to build custom data processing scripts from reliable, modular building blocks and easily share their techniques with other labs around the world.

Installation

Suspect itself is a pure Python package and is easy to install with pip. However it does depend on various other packages, some of which are not so easy to install.

  1. Obtain Python and the SciPy stack:

    Suspect requires Python 3 and makes heavy use of numpy and other parts of the Scientific Python stack. The easiest way to obtain this, along with a large number of other useful scientific packages, is to download the free Anaconda package. Alternatively check here for other ways to install these core packages.

  2. Install suspect

    pip install suspect will automatically download and install the latest version of suspect, along with all remaining other dependencies.

Getting Started

Suspect is still a young package and we are working hard to get useful examples out there. Documentation for the project is available at http://suspect.readthedocs.io/en/latest/

Contributing

If you are interested in helping out with any part of suspect or the OpenMRSLab project, we would love to hear from you.

License

Suspect is released under the MIT license