README.rst

SpectroCrunch: spectroscopic imaging library (XRF/XAS)

Getting started

Install dependencies:

git clone https://github.com/woutdenolf/spectrocrunch
. spectrocrunch/tools/linux-install-deps.sh [-u]

Install from PyPi:

pip install [--user] spectrocrunch

Install from source:

git clone https://github.com/woutdenolf/spectrocrunch
cd spectrocrunch
pip install [--user] .

Test:

# Test source:
python setup.py test

# Test installation:
python -m spectrocrunch.tests.test_all

# Test with options:
python -m unittest -v spectrocrunch.tests.test_all.test_suite
pytest spectrocrunch
nose2 -v spectrocrunch

# Individual tests
python -m unittest spectrocrunch.align.tests.test_align.test_align.test_centroid
pytest spectrocrunch/align/tests/test_align.py::test_align::test_centroid

Documentation:

Release: http://pythonhosted.org/spectrocrunch

Latest: http://spectrocrunch.readthedocs.io/en/latest/

Developers

|Appveyor Status Master|

Main development website: https://github.com/woutdenolf/spectrocrunch

Distribution website: https://pypi.python.org/pypi/spectrocrunch

Guidelines for contributors and project managers can be found in the developers guide.

Use without installation

git clone https://github.com/woutdenolf/spectrocrunch
cd spectrocrunch

To import modules from a package without installing the package, add the directory of the package to the PYTHONPATH environment variable or add this to the top of your script

import sys
sys.path.insert(1,'.../spectrocrunch')

Import as follows:

from spectrocrunch.align.alignElastix import alignElastix as align