8000 GitHub - eegk/MARQO · GitHub
[go: up one dir, main page]

Skip to content
8000
eegkPublic
forked from igorafsouza/MARQO

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

 
 

Latest commit

 

History

47 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

MARQO

Multiplex-imaging Analysis, Registration, Quantification, and Overlaying

Step-by-Step Instructions

If Docker is not installed, follow the instructions for your operating system:

1. Install Docker

For Windows and macOS

  1. Download Docker Desktop:

  2. Install Docker Desktop:

    • Run the installer and follow the on-screen instructions.
    • For macOS, if you have an ARM-based Mac (like Apple M series), ensure you download the version that supports ARM64.
  3. Start Docker Desktop:

    • Launch Docker Desktop from your applications menu.
    • Follow any initial setup prompts.

For Linux

  1. Install Docker Engine:

  2. Start Docker:

    • Start the Docker service using your system's service manager:

      sudo systemctl start docker

2. Enable QEMU Emulation (for ARM64 users)

If you are using an ARM64 architecture (e.g., Apple M series), enable QEMU emulation to run AMD64 Docker images:

docker run --rm --privileged tonistiigi/binfmt --install all

You may need to select "QEMU (Legacy)" as your Virtual Machine Manager (VMM) in the Docker Desktop application settings, if not defaulted already.

3. Download MARQO Docker

  1. Download directly:
  • Go to Releases
  • Download marqo-v1.0.0.tar.gz (This compact version contains only StarDist2D as segmentation method - Recommended for machines up to 16 GB of RAM)
  1. Pull Image from Docker Hub:
  • This image contains StarDist2D and Cellpose as segmentation methods

  • On Terminal/Command Prompt execute:

    docker pull igorafsouza/marqo:v1.0.0

! Attention: If you pull the image, you can skip to step 6. Run the Docker

  1. Or use Command Line from Terminal/Command Prompt:
wget https://github.com/igorafsouza/MARQO/releases/download/v1.0.0/marqo-v1.0.0.tar.gz

4. Extract the tar.gz file (Browsers such as Safari may decompress it automatically)

  1. Run Command Line in Terminal (Recommended for Linux and macOS):
gunzip marqo-v1.0.0.tar.gz
  1. Extract directly (Recommended for Windows):
    • Download 7-Zip
    • Go to the folder where you downloaded marqo-v1.0.0.tar.gz, right-click on it
    • On 7-Zip choose "Extract Here"

5. Load the Docker Image

  • Make sure Docker is running

  • Open Terminal or Command Prompt

  • Go to the directory where you extracted the docker using similar commands: Linux/macOS (Terminal)

    cd /path/to/folder/where/docker_tar_file_is

    Windows (Command Prompt)

    cd /d "C:\path\to\folder\where\docker_tar_file_is"
  • Load the Docker file

    docker load -i marqo-v1.0.0.tar

    If loading the Docker Image you encounter the error read-only file system, please refer to the Troubleshooting Guide for macOS, Windows, and Linux.

6. Run the Docker

To run the Docker container and allow the Jupyter Notebook to access the local files, you need to mount the directory containing your data/images. Replace /path/to/your/data with the full path of the directory on your local machine that contains the data/images you want to analyze.

  • Make sure Docker is running

  • From the Terminal (in Linux or macOS) run:

    If you pulled the image, use the fullname with the tag

    docker run --platform linux/amd64 -p 8888:8888 -v /path/to/your/data:/mnt/data igorafsouza/marqo:v1.0.0

    If you downloaded from Releases, and manually loaded the image, use

    docker run --platform linux/amd64 -p 8888:8888 -v /path/to/your/data:/mnt/data marqo-v1.0.0
  • From the Command Prompt (Windows) run:

    If you pulled the image, use the fullname with the tag

    docker run --platform linux/amd64 -p 8888:8888 -v "C:\path\to\your\data:/mnt/data" igorafsouza/marqo:v1.0.0

    If you downloaded from Releases, and manually loaded the image, use

    docker run --platform linux/amd64 -p 8888:8888 -v "C:\path\to\your\data:/mnt/data" marqo-v1.0.0

7. Access Jupyter Notebook

In your web browser, navigate to http://localhost:8888 to access Jupyter Notebook. Once opened you will see the notebook MARQO_master_application_v1.ipynb. Once you click on it, a new web page will open. Please, locate the Voila button on the top menu bar. Click on Voila button to start the Application, in a new web page.

When you run the Docker container with the -v /path/to/your/data:/mnt/data option, it creates a mapping between a directory on your host machine and a directory inside the container. This allows the Docker container to access files and folders within the specified directory on your host machine.

  • Host Directory: /path/to/your/data (replace with your actual directory)
  • Container Directory: /mnt/data

Using the Applications

There are two applications you can use: Launch and Review.

Launch Application

In the Launch Application, after you choose the technology, you must use the folder /mnt/data/ as the root directory (currently set as default) and complete the path to your images.

  • "Path to raw images": Specify the path to your raw images starting from /mnt/data. If your images are directly in the root /mnt/data, you only need to pass it.
  • "Path to output folder": Specify the path where you want to create the output folder starting from /mnt/data (the directory must already exist). If you want to create the output folder directly in the root /mnt/data, you only need to pass it.

Review Application

In the Review Application, use /mnt/data/ as the base path.

  • "Path to sample folder": Specify the path to your sample folder starting from /mnt/data until the sample output folder (e.g. /mnt/data/sample_name).

8. Demo Videos

Download the demo videos below on how to operate MARQO:

9. Sample Images

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

0