Python library for the post-measurement analysis of real-time deformability cytometry (RT-DC) data sets
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.travis
dclab
docs
examples
tests
.gitignore
.readthedocs.yml
.travis.yml
CHANGELOG
LICENSE
MANIFEST.in
README.rst
appveyor.yml
setup.cfg
setup.py

README.rst

dclab

PyPI Version Build Status Unix Build Status Win Coverage Status Docs Status

This is a Python library for the post-measurement analysis of real-time deformability cytometry (RT-DC) datasets; an essential part of Shape-Out.

Documentation

The documentation, including the code reference and examples, is available at dclab.readthedocs.io.

Installation

To install the latest release, simply run

pip install dclab

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.

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

Appveyor and TravisCI will then automatically build source package and wheels and publish them on PyPI.

Notes on Shape-Out

The appveyor Shape-Out build is automatically triggered after each commit to the Shape-Out repository. At each build, the master branch of dclab is checked out and the Shape-Out 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 Shape-Out.