Skip to content

Latest commit

 

History

History
112 lines (77 loc) · 5.14 KB

README.md

File metadata and controls

112 lines (77 loc) · 5.14 KB

singularity-cellorganizer

Hosted Release GitHub issues GitHub forks GitHub stars GitHub license

About CellOrganizer

CellOrganizer Logo

The CellOrganizer project provides tools for

  • learning generative models of cell organization directly from images
  • storing and retrieving those models
  • synthesizing cell images (or other representations) from one or more models

Model learning captures variation among cells in a collection of images. Images used for model learning and instances synthesized from models can be two- or three-dimensional static images or movies.

CellOrganizer can learn models of

  • cell shape
  • nuclear shape
  • chromatin texture
  • vesicular organelle size, shape and position
  • microtubule distribution.

These models can be conditional upon each other. For example, for a given synthesized cell instance, organelle position is dependent upon the cell and nuclear shape of that instance.

Cell types for which generative models for at least some organelles have been built include human HeLa cells, mouse NIH 3T3 cells, and Arabidopsis protoplasts. Planned projects include mouse T lymphocytes and rat PC12 cells.

Pre-requisites

CellOrganizer v2.8.1

Fixes

  • Display shape space when dataset field is not present or empty.
  • Generation of watertight SBML Spatial output has been corrected for translation errors.

Other

  • The following models have been rebuilt using this version of CellOrganizer. Updated models can be found in the model repository.

    • 2D HeLa diffeomorphic framework
    • 2D HeLa PCA framework
    • 2D HeLa classic framework
  • CellOrganizer for Galaxy now supports Galaxy server v19.05.

CellOrganizer v2.8.0

Features

  • Added improved model for generating protein distributions during T cell synapse formation that only requires annotation of cell couples at a single time point model and improves synapse alignment. Includes training, synthesis and info demos.
  • Added outline PCA model for 2D cell and nuclear shapes. Includes training, synthesis and info demos.
  • Added SPHARM-RPDM model for 3D cell and nuclear shapes (see https://doi.org/10.1093/bioinformatics/bty983). Includes training, synthesis and info demos.

Fixes

  • Fixed issues with options.train.flag. Valid options should be nuclear, cell, framework, and protein.

Enhancements

  • Modularized and cleaned up img2slml.

Running on Singularity

CellOrganizer v2.8.*

Creating the container

To create the container, run this command

> bash ./build.sh

Accessing the container

To access the container, run the command

> singularity shell cellorganizer.sif

Singularity: Invoking an interactive shell within container...

To list the possible apps, run

Singularity cellorganizer.img:~/singularity-cellorganizer> ls -lt /opt/cellorganizer-binaries/

total 111821
-rwxr-xr-x 1 14246 users 12699470 Mar 29 14:25 slml2report
-rwxr-xr-x 1 14246 users 12471747 Mar 29 14:25 slml2info
-rwxr-xr-x 1 14246 users 40728639 Mar 29 14:25 slml2img
-rwxr-xr-x 1 14246 users 48604048 Mar 29 14:25 img2slml

Running Demos

To run a specific demo

> cd demos/2D/demo2D**/
> singularity run ~/path/to/cellorganizer.simg demo2D**.sh

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.


Support for CellOrganizer has been provided by grants GM075205, GM090033 and GM103712 from the National Institute of General Medical Sciences, grants MCB1121919 and MCB1121793 from the U.S. National Science Foundation, by a Forschungspreis from the Alexander von Humboldt Foundation, and by the Freiburg Institute for Advanced Studies.

MMBioS

Copyright (c) 2007-2020 by the Murphy Lab at the Computational Biology Department in Carnegie Mellon University