Gigantum

Gigantum Documentation

You'll find comprehensive guides and documentation to help you start working with the Gigantum platform as quickly as possible. If you get stuck, then there is help for that too. Just reach out to the team or get help from the community using our our Spectrum channel.

Get Started    Changelog

Installation Overview

Some things to know before you begin.

Desktop Installation

We've automated the installation of Gigantum, and you can install it by just downloading the Gigantum Desktop application here.

Command Line Installation

If you prefer or need a command line interface, use the Gigantum CLI.

Why Docker?

Gigantum's only dependency is Docker, and this is what makes everything so portable and reproducible. The Client and Projects run in software containers rather than directly in your host OS.

This makes it easy to build, update, and share your work. We chose Docker CE because has good support and desktop clients on the major operating systems.

The Gigantum Desktop app helps you install and configure Docker, so you don't need to have it installed. If you would like to install it yourself, then consult our installation guide.

System Requirements

If you run Docker on Windows or MacOS, then there are some additional recommended configuration changes that can be found here.

Also, note that there are a few caveats for running Docker and Gigantum:

  • On Windows, you must use Windows 10 Professional, Education, or Enterprise editions
  • We recommend at least 8GB of RAM to satisfy both Docker and the host OS
  • You need sufficient disk space. Docker and Gigantum will use at least 6-10GB of disk space, but more is recommended.

Large Download Required

Gigantum uses Docker containers and thus needs to download data. When starting the Gigantum Client for the first time, it will download a ~300MB container, and when creating your first Project another 1-2GB of container data is downloaded by Docker.

Updated 24 days ago

Installation Overview


Some things to know before you begin.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.