https://github.com/woutdenolf/spectrocrunch

Spectroscopic imaging library (XRF/XAS)
https://github.com/woutdenolf/spectrocrunch

imaging synchrotron x-ray-spectroscopy

Last synced: 23 days ago
JSON representation

Spectroscopic imaging library (XRF/XAS)

• Host: GitHub
• URL: https://github.com/woutdenolf/spectrocrunch
• Owner: woutdenolf
• License: mit
• Created: 2017-01-17T11:16:57.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-10T08:26:53.000Z (4 months ago)
• Last Synced: 2024-10-13T01:42:56.097Z (about 1 month ago)
• Topics: imaging, synchrotron, x-ray-spectroscopy
• Language: Python
• Homepage:
• Size: 15.3 MB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
SpectroCrunch: spectroscopic imaging library (XRF/XAS)

======================================================

Getting started

---------------

Install dependencies:

.. code-block:: bash

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

    . spectrocrunch/tools/linux-install-deps.sh [-u]

Install from PyPi:

.. code-block:: bash

    pip install [--user] spectrocrunch

Install from source:

.. code-block:: bash

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

    cd spectrocrunch

    pip install [--user] .

Test:

.. code-block:: bash

    # 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

----------

|Travis Status Master| |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

------------------------

.. code-block:: bash

    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

.. code-block::

    import sys

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

Import as follows:

.. code-block:: 

    from spectrocrunch.align.alignElastix import alignElastix as align

.. |Travis Status Master| image:: https://travis-ci.org/woutdenolf/spectrocrunch.svg?branch=master

   :target: https://travis-ci.org/woutdenolf/spectrocrunch?branch=master

.. |Appveyor Status| image:: https://ci.appveyor.com/api/projects/status/1txj75w5hjpmjfl3/branch/master?svg=true

   :target: https://ci.appveyor.com/project/woutdenolf/spectrocrunch/branch/master