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.3.tar.gz (730.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.3-py3-none-any.whl (686.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cellects-0.3.3.tar.gz
  • Upload date:
  • Size: 730.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.3.tar.gz
Algorithm Hash digest
SHA256 4a681bc075a2b5bfe09bcd1108379ac4296af7880031412f7fc046fb19ffca34
MD5 f4f43beb5d541062890512d0640c5d00
BLAKE2b-256 ab9106587e1d076131b4fd20f77fec06a2be2ea82371d4a1eb97fd70c23623b2

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: cellects-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 686.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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 897007426ffa0813b757394a6e01e2f23cda3259c83d03584e1586e33fc75a4d
MD5 853b5d945c8b3e6ab22c1f306027b703
BLAKE2b-256 35b9c3f3ca3e3ea2230767be8b0245de074cb76094287ce6a7e4a72021bacfc7

See more details on using hashes here.

Provenance

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