Skip to main content

Small Fish is a python application for the analysis of smFish images. It provides a ready to use graphical interface to combine famous python packages for cell analysis without any need for coding.

Project description

Small Fish - A User-Friendly Graphical Interface for smFISH Image Quantification

License: BSD-2-Clause GitHub stars Python 3.12+

Small Fish is a python application for smFish image analysis. It provides a ready to use graphical interface to synthetize state-of-the-art scientific packages into an automated workflow. Small Fish is designed to simplify images quantification and analysis for people without coding skills.

Cell segmentation is peformed in 2D and 3D throught cellpose 4.0+(published work) : https://github.com/MouseLand/cellpose; compatible with your own cellpose models.

Spot detection is performed via big-fish a python implementation of FishQuant (published work) : https://github.com/fish-quant/big-fish.

The workflow is fully explained in the wiki ! Make sure to check it out.

What can you do with small fish ?

✅ Single molecule quantification
✅ Transcriptomics
✅ Foci quantification
✅ Transcription sites quantification
✅ Nuclear signal quantification
✅ Signal to noise analysis
✅ Cell segmentation
✅ Multichannel colocalisation

Fish signal

Raw 3D fish signal with dapi

Segmentation

2D segmentation

Detection_signal

3D Spot detection

detection

Cluster detection

Analysis can be performed either fully interactively throught a Napari interface or performed automatically through a batch processing allowing for reproducible quantifications.

Installation

General setup

If you don't have a python installation yet I would recommend the miniconda distribution; but any distribution should work.

It is higly recommanded to create a specific conda or virtual environnement to install small fish.

As of version 2.1.0 Small Fish runs on python 3.12.

If you are using conda or miniconda

conda create -n small_fish python=3.12
conda activate small_fish

If you are using venv, after installing the official python 3.12, python-venv and python-tk .

python3.12 -m venv python_env/small_fish
source python_env/small_fish/bin/activate

Then download and install the small_fish package with :

pip install small_fish_gui

Setting up GPU

As of Small Fish 2.0.1 it is highly recommanded to set up GPU with cellpose since its new model, CellposeSAM, is very heavy computationally even more when attempting 3D segmentation.
First of all, try to run small fish gpu without additional commands depending on your configuration it could work straight out of the box. If encoutering any issue try first the following :

pip install --index-url https://download.pytorch.org/whl/cu124 torch torchvision torchaudio

If running into additional problems please look at cellpose documentation.

Run Small fish

First activate your python environnement :

conda activate small_fish

Then launch Small fish :

python -m small_fish_gui

You are all set! Try it yourself or check the get started section in the wiki.

Developement

Bugs to fix :

  • Use of load button during co-localization quantification yields diffrent results than when testing from memory : --> Shown results are correct and consistent with results from memory --> But background (i.e cell_id = 0) is treated as a cell instead of being filtered --> But cells on edges are NOT removed from quantification (they are if test is performed from memory) --> But Cluster related metrics are not computed when test is performed from save

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

small_fish_gui-2.1.5.tar.gz (4.5 MB view details)

Uploaded Source

Built Distribution

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

small_fish_gui-2.1.5-py3-none-any.whl (197.2 kB view details)

Uploaded Python 3

File details

Details for the file small_fish_gui-2.1.5.tar.gz.

File metadata

  • Download URL: small_fish_gui-2.1.5.tar.gz
  • Upload date:
  • Size: 4.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for small_fish_gui-2.1.5.tar.gz
Algorithm Hash digest
SHA256 9b554a84ab5228f8cf7e276fc119cb002184a5bcdcfe3b4f1d62582365e3c566
MD5 e02babe9610a03efb381b9606807aeef
BLAKE2b-256 713f315a7a0e83ad00eca6e04568c9518d7fa3f499a1829b8c59605d18197186

See more details on using hashes here.

File details

Details for the file small_fish_gui-2.1.5-py3-none-any.whl.

File metadata

  • Download URL: small_fish_gui-2.1.5-py3-none-any.whl
  • Upload date:
  • Size: 197.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for small_fish_gui-2.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b6200af95407459a187e8504a0f4b0171fc76de21d87427ad82a2f65f917585d
MD5 3fa11d96958e3f5542bb0a83bcc7ee8d
BLAKE2b-256 2997dc93f480f6d1064c82520a3131aaff3443d0aba741ee4acc100c456fc435

See more details on using hashes here.

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