Cell cycle analysis plugin.
Project description
fucciphase
FUCCI cell cycle analysis plugin. Obtain cell cycle information from FUCCI fluorescence intensities.
Installation
The best way to run fucciphase is to install it in a virtual conda environment. Make sure that git is installed and can be called from the command line.
To install from pip:
pip install fucciphase
If you wish to install it from source:
git clone https://github.com/Synthetic-Physiology-Lab/fucciphase
cd fucciphase
pip install -e .
The installation should not take longer than a few seconds (depending on your internet connection).
To use the notebooks, also install jupyter:
pip install jupyter
Usage
Fucci phase currently supports loading a TrackMate XML file:
from fucciphase import process_trackmate
from fucciphase.sensor import get_fuccisa_default_sensor
trackmate_xml = "path/to/trackmate.xml"
channel1 = "MEAN_INTENSITY_CH3"
channel2 = "MEAN_INTENSITY_CH4"
sensor = get_fuccisa_default_sensor()
df = process_trackmate(trackmate_xml,
channels=[channel1, channel2],
sensor=sensor,
thresholds=[0.1, 0.1])
print(df)
The TrackMate XML is converted to a Pandas DataFrame. Thus, in general data (e.g., stored in a CSV or XLSX file) that can be parsed into a DataFrame is supported.
Have a look at the examples in the example folder to get more information!
The runtime of the scripts depends on your datasize. 2D samples with a few hundred to a few thousand cells can be processed in a few minutes. Visualization in Napari can take a bit longer. Standard processing does not require a powerful computer. Make sure that you have sufficient RAM to load videos for visualization in Napari.
Development
To develop fucciphase, clone the repository, install fucciphase in your environment and install the pre-commit hooks:
git clone https://github.com/Synthetic-Physiology-Lab/fucciphase
cd fucciphase
pip install -e ".[test, dev]"
pre-commit install
If you want to build the documentation, replace the abovementioned pip install by:
pip install -e ".[test, dev, doc]"
Cite us
Di Sante, M., Pezzotti, M., Zimmermann, J., Enrico, A., Deschamps, J., Balmas, E., Becca, S., Solito, S., Reali, A., Bertero, A., Jug, F. and Pasqualini, F.S., 2025. CALIPERS: Cell cycle-aware live imaging for phenotyping experiments and regeneration studies. bioRxiv, https://doi.org/10.1101/2024.12.19.629259
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fucciphase-0.0.2.tar.gz.
File metadata
- Download URL: fucciphase-0.0.2.tar.gz
- Upload date:
- Size: 18.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ee8803e1ffb28b7bdc96b5fae6946d369f257a76946d95ec2477ff57b04bcf0a
|
|
| MD5 |
2c4e2ce5142d18163e17492385155a9f
|
|
| BLAKE2b-256 |
2f60ee1cb598896fb12f44a686f411b745d59793d7e037a6902b960e521d5cd9
|
Provenance
The following attestation bundles were made for fucciphase-0.0.2.tar.gz:
Publisher:
ci.yml on Synthetic-Physiology-Lab/fucciphase
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fucciphase-0.0.2.tar.gz -
Subject digest:
ee8803e1ffb28b7bdc96b5fae6946d369f257a76946d95ec2477ff57b04bcf0a - Sigstore transparency entry: 677371209
- Sigstore integration time:
-
Permalink:
Synthetic-Physiology-Lab/fucciphase@346110f1cd757861d7ad943d164acb29180b9093 -
Branch / Tag:
refs/tags/v0.0.2 - Owner: https://github.com/Synthetic-Physiology-Lab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@346110f1cd757861d7ad943d164acb29180b9093 -
Trigger Event:
push
-
Statement type:
File details
Details for the file fucciphase-0.0.2-py3-none-any.whl.
File metadata
- Download URL: fucciphase-0.0.2-py3-none-any.whl
- Upload date:
- Size: 36.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5b0ae1a6268018d6d2acb8c978cf2d36b13fed9e64efd3dbec13da160076af39
|
|
| MD5 |
c2171f7f0bd078bc1be8ee8effe48a85
|
|
| BLAKE2b-256 |
fdc7893df0fa34c1ffeccb5266c287368242eb1212948036df5d227234299363
|
Provenance
The following attestation bundles were made for fucciphase-0.0.2-py3-none-any.whl:
Publisher:
ci.yml on Synthetic-Physiology-Lab/fucciphase
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fucciphase-0.0.2-py3-none-any.whl -
Subject digest:
5b0ae1a6268018d6d2acb8c978cf2d36b13fed9e64efd3dbec13da160076af39 - Sigstore transparency entry: 677371244
- Sigstore integration time:
-
Permalink:
Synthetic-Physiology-Lab/fucciphase@346110f1cd757861d7ad943d164acb29180b9093 -
Branch / Tag:
refs/tags/v0.0.2 - Owner: https://github.com/Synthetic-Physiology-Lab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@346110f1cd757861d7ad943d164acb29180b9093 -
Trigger Event:
push
-
Statement type: