cellects 0.3.0

Cell Expansion Computer Tracking Software.

Cellects: Cell Expansion Computer Tracking Software

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.

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

• Usage example (video)