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:

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.5.tar.gz (729.6 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.5-py3-none-any.whl (685.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cellects-0.3.5.tar.gz
  • Upload date:
  • Size: 729.6 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.5.tar.gz
Algorithm Hash digest
SHA256 e36a9ae87175127e3a540987d00fc5dcb1a0bf0266527c43afea48971ffe7efa
MD5 16ab74bdf2e957399b639f8c612178de
BLAKE2b-256 da73f7eaeefe19489d15ad0b5bd7e4eaabf7ff767ed3eab686a729e1567551b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellects-0.3.5.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.5-py3-none-any.whl.

File metadata

  • Download URL: cellects-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 685.0 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 434481fa610f859d48135dff9c67c686fcfac097591371689ba3260a38e1a918
MD5 21898b73389664b0db93e917a64c92a0
BLAKE2b-256 52805e1bb831ffad2bbbce05a7335a5b3699680ac350a6e5e74c4df510f97d66

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellects-0.3.5-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