Development & Demo Setup

Warning

This guide is based on a snapshot in time development/WIP version of NL-BIOMERO. User interfaces, features, and configurations shown in the BIOMERO 101 installation guide may have been updated and changed since this documentation was created. This content does not necessarily represent the final product and should be used as a general reference for development and demonstration purposes.

This guide provides detailed instructions for setting up NL-BIOMERO for development and demonstration purposes.

Note

For Linux deployments, see Linux/Ubuntu Deployment. For detailed technical architecture, see Architecture Overview. For advanced deployment scenarios, see Advanced Deployment Guide.

Windows Development Setup

For quick development setup on Windows with Docker Desktop:

Prerequisites

  • Docker Desktop

  • Git for Windows

  • SSH keypair (@ ~/.ssh/id_rsa)

  • PowerShell

Quick Setup Steps

  1. Clone: git clone --recursive https://github.com/NL-BioImaging/NL-BIOMERO.git

  2. Configure: Edit .env file with passwords and settings

  3. Deploy: docker-compose up -d

  4. Access: OMERO.web at http://localhost:4080

See also

πŸ“– Complete Setup Instructions: See the main README for detailed Windows setup steps, including SSH configuration and local SLURM cluster setup for testing.

Container Management

Basic container operations:

# Start/stop services
docker-compose up -d
docker-compose down

# View logs
docker-compose logs -f

# Rebuild single container
docker-compose up -d --build --force-recreate <container-name>

# Access container shell
docker-compose exec <container-name> bash

Key container names: omeroserver, omeroweb, biomeroworker

Configuration Overview

BIOMERO 101 Installation Guide

The BIOMERO 101 installation guide provides step-by-step instructions for setting up a development environment suitable for demonstrations and testing.

Key features of this setup:

  • Easy development/demo deployment

  • Uses Docker Desktop on Windows

  • Includes all necessary components for basic functionality

  • Suitable for learning and experimentation

For the complete BIOMERO 101 installation guide, see the PDF document in the deployment_scenarios folder: BIOMERO 101 - installation guide.pdf

This guide covers:

  • Installing Docker Desktop

  • Setting up WSL2 (Windows Subsystem for Linux)

  • Cloning the repository

  • Running the development setup

  • Basic usage and testing

The development setup uses simplified configurations that are ideal for:

  • First-time users

  • Training sessions

  • Feature demonstrations

  • Local development work