Metadata-Version: 2.0
Name: dclab
Version: 0.2.9
Summary: Library for real-time deformability cytometry (RT-DC)
Home-page: https://github.com/ZELLMECHANIK-DRESDEN/dclab
Author: Paul Müller
Author-email: dev@craban.de
License: GPL v2
Keywords: RT-DC,deformation,cytometry,zellmechanik
Platform: ALL
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Intended Audience :: Science/Research
Requires-Dist: NumPy (>=1.5.1)
Requires-Dist: fcswrite
Requires-Dist: imageio
Requires-Dist: nptdms
Requires-Dist: scipy (>=0.12.0)
Requires-Dist: statsmodels (>=0.5.0)

dclab
=====

|PyPI Version| |Build Status| |Coverage Status|


This is a Python library for the post-measurement analysis of
real-time deformability cytometry (RT-DC) data sets; an essential part of
`ShapeOut <https://github.com/ZELLMECHANIK-DRESDEN/ShapeOut>`__.


Installation
------------
To install the latest release, simply run

::

	pip install dclab


If you want to get the bleeding edge from GitHub, run

::

	pip install git+git://github.com/ZELLMECHANIK-DRESDEN/dclab.git


Information for developers
--------------------------


Contributing
~~~~~~~~~~~~
The main branch for developing dclab is master.
If you want to make small changes like one-liners,
documentation, or default values in the configuration,
you may work on the master branch. If you want to change
more, please (fork dclab and) create a separate branch,
e.g. ``my_new_feature_dev``, and create a pull-request
once you are done making your changes.
Please make sure to edit the 
`Changelog <https://github.com/ZELLMECHANIK-DRESDEN/dclab/blob/master/CHANGELOG>`__. 

**Very important:** Please always try to use 

::

	git pull --rebase

instead of

::

	git pull

to prevent confusions in the commit history.

Tests
~~~~~
dclab is tested using pytest. If you have the time, please write test
methods for your code and put them in the ``tests`` directory.


Incrementing version
~~~~~~~~~~~~~~~~~~~~
dclab currently gets its version from the latest git tag.
If you think that a new version should be published,
create a tag on the master branch (if you have the necessary
permissions to do so):

::

	git tag -a "0.1.3"
	git push --tags origin


Uploading to PyPI
~~~~~~~~~~~~~~~~~
If this is not automated yet, only @paulmueller can upload
a new version of dclab to the Python Package Index.


Notes on `ShapeOut <https://github.com/ZELLMECHANIK-DRESDEN/ShapeOut/>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The `appveyor ShapeOut build <https://ci.appveyor.com/project/paulmueller/ShapeOut>`__
is automatically triggered after each commit to the ShapeOut repository. At each build,
the master branch of dclab is checked out and the ShapeOut installer is built with it.
Therefore, it is not necessary to bump the version of dclab or to upload the latest
version of dclab to PyPI in order to get your new code into ShapeOut.


.. |PyPI Version| image:: http://img.shields.io/pypi/v/dclab.svg
   :target: https://pypi.python.org/pypi/dclab
.. |Build Status| image:: http://img.shields.io/travis/ZELLMECHANIK-DRESDEN/dclab.svg
   :target: https://travis-ci.org/ZELLMECHANIK-DRESDEN/dclab
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/ZELLMECHANIK-DRESDEN/dclab/master.svg
   :target: https://codecov.io/gh/ZELLMECHANIK-DRESDEN/dclab


