1. Installation¶
PyCellID can be installed using pip from PyPI.
$ pip install pycellid
1.1. Development¶
We welcome all kinds of contributions. You can build the development environment locally with the following commands:
$ git clone git@github.com:pyCellID/pyCellID.git
$ cd pyCellID
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -e .
$ pip install -r requirements/dev.txt
Run the tests with pytest:
$ pytest -v tests/
Or run the full checks with tox:
$ tox -r
1.2. Initialization¶
>>> import pycellid
>>> pycellid.__version__
'0.0.18'
>>> # Build or load your data, inspect your images and make plots.
>>> from pycellid.core import CellData, CellsPloter
>>> import pycellid.io as ld # Build or load data frame.
>>> from pycellid import images # Get a 2-D aray representing your images.