Skip to content
jdissetPublic

About

Flow cytometry calibration

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

115 Commits

Folders and files

Repository files navigation

Calibrie Logo

Calibrie is a modular Python library for the analysis, unmixing, and calibration of fluorescence flow cytometry data, particularly tailored for synthetic biology applications.

Documentation License: MIT

It implements multiple algorithms to turn raw fluorescence measurements into standardized, quantitative protein abundance units (like Molecules of Equivalent Fluorophore - MEF), along with numerous diagnostics and quality assessment tools. Calibrie is designed to promote reproducible, modular, and sharable cytometry analysis workflows.

!!! warning "Alpha Stage" Calibrie is currently in alpha. While functional, the API might undergo changes, and documentation is actively being developed. Feedback and contributions are welcome!

Installation

pip install -U git+https://github.com/jdisset/dracon.git
pip install -U git+https://github.com/jdisset/calibrie.git

Documentation

Full documentation, including tutorials, concept explanations, and API references, is available at:

https://jdisset.github.io/calibrie

The documentation provides detailed guides on:

  • Getting started with calibration pipelines.
  • Using the Python API vs. YAML configuration.
  • Understanding the theory behind compensation, mapping, and MEF calibration.
  • Detailed API reference for all tasks and utilities.

Quick Example (Python API)

import calibrie as cal
import pandas as pd

# Define controls and bead file paths
controls_dict = {'EBFP2': 'path/to/ebfp2.fcs', ... , 'BLANK': 'path/to/blank.fcs'}
beads_file = 'path/to/beads.fcs'

# Define pipeline tasks (example)
pipeline = cal.Pipeline(tasks={
    "controls": cal.LoadControls(color_controls=controls_dict, ...),
    "lincomp": cal.LinearCompensation(...),
    "protmap": cal.ProteinMapping(reference_protein='EBFP2', ...),
    "beads": cal.MEFBeadsTransform(beads_data=beads_file, ...), # Provides context for protmap
    "export": cal.PandasExport(context_field_to_export='abundances_MEF')
})

# Initialize and run
pipeline.initialize()
sample_data = cal.load_to_df("path/to/sample.fcs")
results = pipeline.apply_all(sample_data)
calibrated_df = results.output_df

print(calibrated_df.head())

(See the full documentation for details on task parameters and YAML usage)

Contributing

Contributions are welcome! Please feel free to open an issue or submit a pull request.

License

Calibrie is distributed under the MIT License. See LICENSE file for details.

About

Flow cytometry calibration

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages