Skip to main content

Cell cycle analysis plugin.

Project description

fucciphase

License PyPI Python Version CI codecov pre-commit.ci status

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.

(SOON) 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

fucciphase-0.0.1.tar.gz (62.5 kB view details)

Uploaded Source

Built Distribution

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

fucciphase-0.0.1-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

Details for the file fucciphase-0.0.1.tar.gz.

File metadata

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

File hashes

Hashes for fucciphase-0.0.1.tar.gz
Algorithm Hash digest
SHA256 ea83d74a2a8aa2c7e69183462e19a2174232beabd45fa56bdfb5e4ca48380318
MD5 8af4a1d3ef97422e6eaa15726a2a31f7
BLAKE2b-256 9185de68746dec5efb6b026fafc35074615c42c5bcaae726c371e623a71edab6

See more details on using hashes here.

Provenance

The following attestation bundles were made for fucciphase-0.0.1.tar.gz:

Publisher: ci.yml on Synthetic-Physiology-Lab/fucciphase

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

File details

Details for the file fucciphase-0.0.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for fucciphase-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e2957f2c9ced8c639d2df53b36c181d9bdbdc43e196c64109ca8f2504e6024ac
MD5 7e54d2418d32672c8e40f255eeee0581
BLAKE2b-256 9b1ca33d12236552cf843e17d2d23c389979ace26a9900b320f2835bec236f41

See more details on using hashes here.

Provenance

The following attestation bundles were made for fucciphase-0.0.1-py3-none-any.whl:

Publisher: ci.yml on Synthetic-Physiology-Lab/fucciphase

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