Metadata-Version: 2.0
Name: scanalignment
Version: 0.0.3
Summary: Scan Alignment of STXM images.
Home-page: http://carlos.reis@gitlab.elettra.eu/carlos.reis/pickpeak.git
Author: Elettra SciComp
Author-email: carlos.reis@elettra.eu
License: MIT
Keywords: sample setuptools development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: h5py
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pyqtgraph
Requires-Dist: tifffile
Provides-Extra: dev
Requires-Dist: check-manifest; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'

Pick Peak
=======================

Scan Alignment is a PyQtGraph-based graphical user interface. It allows for horizontal line alignment of images
collected in the TwinMic beamline through Scanning transmission x-ray microscopy (STXM) imaging technique.


----

README
""""""""""""""""" 

**Introduction**

The file should use UTF-8 encoding and be written using `reStructuredText
<http://docutils.sourceforge.net/rst.html>`_. It
will be used to generate the project webpage on PyPI and will be displayed as
the project homepage on common code-hosting services, and should be written for
that purpose.

**Installation**

For standard Python installations, install pickpeak using pip:

.. code:: bash

    pip install -U pip setuptools
    pip install pickpeak

**Usage**

.. code:: python

	from pickpeak.pickpeak import PickPeak as pp
	peaks = pp(spectrum) #spectrum shoud be type numpy.ndarray
	peaks.gui_design() #calls the GUI 
	list_of_peaks = peaks.peak_list #returns the current list of peaks collected through the GUI

**Requirements**

* `Python 2.7 <https://www.python.org/downloads/>`_.
* `Setuptools <https://setuptools.readthedocs.io/en/latest/>`_.
* `Tifffile <https://github.com/blink1073/tifffile>`_.
* `H5Py <http://www.h5py.org/>`_.
* `Matplotlib <https://matplotlib.org/>`_.
* `NumPy <http://www.numpy.org/>`_.
* `PyQt4 <http://pyqt.sourceforge.net/Docs/PyQt4/installation.html>`_, `PyQt5 <http://pyqt.sourceforge.net/Docs/PyQt5/installation.html>`_ or `PySide <https://wiki.qt.io/PySide>`_.
* `PyQtGraph <http://www.pyqtgraph.org/>`_.
* `SIP <https://www.riverbankcomputing.com/software/sip/download>`_.




