Table of Contents

  1. 1. Option 1
    1. Windows Installer (Recommended)
  2. 2. Option 2
    1. Run Tool Server Manager
    2. Run the Web App
  3. 3. Option 3
    1. Galago Tools
    2. Web App

Getting Started

This guide will help you get up and running with Galago. Galago consists of two main components that work together:

  • Tools Manager: A Python-based interface that manages the tool drivers.
  • Web App: A web interface that encapsulates the database, scheduler, and tool command execution. For a complete Galago installation, you’ll need to set up both components as described below.

1. Option 1

The easiest way to get started is with our Windows installer:
Windows Download Galago

Note: The Galago shortcut will be added to the desktop folder.

2. Option 2

Build from published packages.

Run Tool Server Manager

Tools manager can also be installed with pip on a Python >3.9 environment:

#Install via pip
pip install galago-tools
#Launch tools servers
galago

To see other galago tools commands:

#Help
galago --help
#Run headless (console only) 
galago --console
#Discover active servers
galago --discover

Run the Web App

You can run the galago web interface using docker and docker compose in any operating system.

  1. Download and install Docker Desktop
  2. Download Galago’s compose file
  3. Save docker-compose.yml to a desired folder, cd to that folder and run:
docker-compose up --build -d
  1. After build is complete, navigate to http://localhost:3010/

3. Option 3

Build from source code (Development Mode).

Galago Tools

Tools manager can also be installed with pip on a Python >3.9 environment:

  1. Fork on GitHub: Click the “Fork” button at the top right of the repository page, or use this direct link:

    Fork Galago Tools →

  2. Clone your fork (replace your-username with your GitHub username): 
    git clone https://github.com/your-username/galago-tools.git
cd galago-tools
  3. Add upstream remote (to keep your fork updated): 
    git remote add upstream https://github.com/sciencecorp/galago-tools.git
  4. Install in dev mode and dev deps 
    pip install -e .
pip install -r requirements-dev.txt
  5. Launch Galago Tools Manager (The server used by Galago Core) 
    galago

Web App

You can run the galago web interface using docker and docker compose in any operating system.

  1. Fork on GitHub: Click the “Fork” button at the top right of the repository page, or use this direct link:

    Fork Galago →

  2. Clone your fork (replace your-username with your GitHub username): 
    git clone https://github.com/your-username/galago-core.git
cd galago-core
  3. Add upstream remote (to keep your fork updated): 
    git remote add upstream https://github.com/your-org/galago-core.git
  4. Install grpcio dependencies on a local environment (for proto files, testing, linting, etc) 
    bin/make deps

  5. Launch development environment

    docker-compose -f docker-compose.dev.yml up --build
  6. Access the application
    • Web Interface: http://localhost:3010
    • Tools Manager: http://localhost:8080