spotiflow

(β˜… 140)

Accurate and efficient spot detection for microscopy data

  • .gitignore
  • .pre-commit-config.yaml
  • CITATION.cff
  • docker-env-config.yml
  • Dockerfile
  • LICENSE
  • MANIFEST.in
  • pyproject.toml
  • README.md
  • setup.cfg
  • setup.py
  • tox.ini

# Installation Guide

1. Get the code
git clone https://github.com/weigertlab/spotiflow

Downloads the entire project code from GitHub to your computer.

cd spotiflow

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install torch

Installs the package published on PyPI directly β€” no need to clone the source.

pip install spotiflow

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
Note that the current implementation of Spotiflow in Docker only supports CPU inference.

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install torch

Installs the package published on PyPI directly β€” no need to clone the source.

pip install spotiflow

Installs the package published on PyPI directly β€” no need to clone the source.

pip install -e ".[testing]"

Installs the Python libraries listed in requirements.txt (or similar).

pip install -e ".[docs]"

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation