Skip to main content

Toolbox for the analysis of smFISH images.

Project description

Big-FISH

PyPI version Build Status Documentation Status codecov License Python version

Big-FISH is a python package for the analysis of smFISH images. It includes various methods to analyze microscopy images, such spot detection and segmentation of cells and nuclei. The package allows the user represent the extract properties of a cell as coordinates (see figure below). The ultimate goal is to simplify large scale statistical analysis and quantification.

Cell image (smFISH channel) and its coordinates representation

Installation

Dependencies

Big-FISH requires Python 3.6 or newer. Additionally, it has the following dependencies:

  • numpy (>= 1.16.0)
  • scipy (>= 1.4.1)
  • scikit-learn (>= 0.24.0)
  • scikit-image (>= 0.14.2)
  • matplotlib (>= 3.0.2)
  • pandas (>= 0.24.0)
  • mrc (>= 0.1.5)

For segmentation purpose, two additional dependencies can be requested:

  • tensorflow (== 2.3.0)
  • tensorflow-addons (== 0.12.1)

Virtual environment

To avoid dependency conflicts, we recommend the the use of a dedicated virtual or conda environment. In a terminal run the command:

conda create -n bigfish_env python=3.6
source activate bigfish_env

We recommend two options to then install Big-FISH in your virtual environment.

Download the package from PyPi

Use the package manager pip to install Big-FISH. In a terminal run the command:

pip install big-fish

Clone package from Github

Clone the project's Github repository and install it manually with the following commands:

git clone git@github.com:fish-quant/big-fish.git
cd big-fish
pip install .

Usage

Big-FISH provides a toolbox for the full analysis pipeline of smFISH images. A complete documentation is available online.

This package is part of the FISH-Quant framework and several examples are also available as Jupyter notebooks.

Support

If you have any question relative to the repository, please open an issue. You can also contact Arthur Imbert or Florian Mueller.

Roadmap (suggestion)

Version 1.0.0:

  • Complete code coverage.
  • Unpin deep learning dependencies
  • Add a pretrained pattern recognition model

Development

Source code

You can access the latest sources with the commands:

git clone git@github.com:fish-quant/big-fish.git
cd big-fish
git checkout develop

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Testing

Please make sure to update tests as appropriate if you open a pull request. You can install exacts dependencies and specific version of pytest by running the following command:

pip install -r requirements_dev.txt

To perform unit tests, run :

pytest bigfish

Citation

If you exploit this package for your work, please cite:

Arthur Imbert, Wei Ouyang, Adham Safieddine, Emeline Coleno, Christophe Zimmer, Edouard Bertrand, Thomas Walter, Florian Mueller. FISH-quant v2: a scalable and modular analysis tool for smFISH image analysis. bioRxiv (2021) https://doi.org/10.1101/2021.07.20.453024

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

big-fish-0.6.2.tar.gz (416.6 kB view details)

Uploaded Source

Built Distribution

big_fish-0.6.2-py3-none-any.whl (123.2 kB view details)

Uploaded Python 3

File details

Details for the file big-fish-0.6.2.tar.gz.

File metadata

  • Download URL: big-fish-0.6.2.tar.gz
  • Upload date:
  • Size: 416.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/26.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.46.0 importlib-metadata/4.2.0 keyring/21.2.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.8

File hashes

Hashes for big-fish-0.6.2.tar.gz
Algorithm Hash digest
SHA256 60b91655d32b683e51d138940a0ec0c1bdfa9f063b65854fdbceae7edd52c527
MD5 85a4d23390ed3bdabc7235aea03ad625
BLAKE2b-256 f9854873354f3d9081db90813ece2b8ef236fe72f074763e2ad39eb62fc804bc

See more details on using hashes here.

File details

Details for the file big_fish-0.6.2-py3-none-any.whl.

File metadata

  • Download URL: big_fish-0.6.2-py3-none-any.whl
  • Upload date:
  • Size: 123.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/26.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.46.0 importlib-metadata/4.2.0 keyring/21.2.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.8

File hashes

Hashes for big_fish-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d94e389fff27b8d166b8695a7b63040b8e46b5625adbb3106687d80f4511f2c7
MD5 63554cf4733cc8715804605a0328abbf
BLAKE2b-256 859108eb3ecd23b38e9078fadf6180d3a03362b893eba632731695e4e216b2a6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page