Skip to main content

Cell Expansion Computer Tracking Software.

Project description

Cellects: Cell Expansion Computer Tracking Software

PyPI version PyPI - Downloads Python versions License Stars GitHub Actions Workflow Status Coverage

Description

Cellects is a tracking software for organisms whose shape and size change over time. Cellects’ main strengths are its broad scope of action, automated computation of a variety of geometrical descriptors, easy installation and user-friendly interface.

Cellects first window
Figure 1: Cellects first window

Installation (Short version)

Install using our Windows installer: Cellects_installer.exe

Or, install via pip:

pip install cellects

Any difficulties? follow our complete installation tutorial


Quick Start

Run in terminal:

cellects

Documentation

Cellects' workflow is described in a complete documentation. It includes:

  • What is Cellects: Purpose of the software, usable data and introduction of its user manual
  • Setting up a first analysis: Step-by-step workflows for data localization, image analysis and video tracking
  • Improving the analysis: Customization options, batch processing, parameter tuning.
  • Use cases: Real-world cases using the GUI (interface) and the API (scripts).
  • Contributing: Report bugs and feature requests; contribute; testing and documentation processes.
  • API Reference: Auto-generated from source code docstrings (see [Build Documentation]).

Use Cases

See use cases for real-world examples:

  • Automated Physarum polycephalum tracking using GUI
  • Automated Physarum polycephalum tracking using API
  • Colony growth tracking

Contributing

We welcome contributions!

  1. Fork the repository and create a new branch.
  2. Submit issues/PRs via GitHub.

For developer workflows, see Contributing.


License & Citation

GNU GPL3 License (see LICENSE).

To cite Cellects, use:

@article{boussard2024cellects,
  title={Cellects, a software to quantify cell expansion and motion},
  author={Boussard, Aur{\`e}le and Arrufat, Patrick and Dussutour, Audrey and P{\'e}rez-Escudero, Alfonso},
  journal={bioRxiv},
  pages={2024--03},
  year={2024},
  publisher={Cold Spring Harbor Laboratory}
}

Testing

Run unit tests with:

pip install -e ".[test]"
pytest

Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cellects-0.3.7.tar.gz (729.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cellects-0.3.7-py3-none-any.whl (685.1 kB view details)

Uploaded Python 3

File details

Details for the file cellects-0.3.7.tar.gz.

File metadata

  • Download URL: cellects-0.3.7.tar.gz
  • Upload date:
  • Size: 729.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cellects-0.3.7.tar.gz
Algorithm Hash digest
SHA256 d6206b74193f7fad1b44b4d6945f16a520e41ecde03617f8287c79c2ecb610b3
MD5 71e8ad65d1cac2b90f94e5e8cc3d46ea
BLAKE2b-256 c7ebf18fed8c1beea42c86b9ea86b22e2798e967518d5770c671e37d9849f0cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellects-0.3.7.tar.gz:

Publisher: release.yml on Aurele-B/Cellects

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cellects-0.3.7-py3-none-any.whl.

File metadata

  • Download URL: cellects-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 685.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cellects-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ac5232f4710e6e1ae1cb73c028a56adc6b38aa1dd21550d9646a08779cefe309
MD5 8133e618b43ccef8fd7179e270c14078
BLAKE2b-256 f0e05f72e8fc0352e7e9bee9cc4c18615bce3bd1ca9b82b23267ee52c8ab479a

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellects-0.3.7-py3-none-any.whl:

Publisher: release.yml on Aurele-B/Cellects

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page