Installation#

These instructions will show you how to install Gnomon on your system. Gnomon is supported on Linux and Mac systems natively, yet we provide experimental instructions for Windows users. The guidelines provided on this page rely essentially on the Conda package management software, which is the solution we recommend for the best experience.

Installing Gnomon using conda#

Prerequisites

  • Installing gnomon requires around 4 GB of free disk space, environment included.

  • Make sure you have conda installed on your system. To check, simply open a new terminal window and type:

conda
  • If conda is installed, you should get a long return value describing how to use the command, otherwise you will get a command not found message.

  • If conda is not installed, we recommend that you install Miniconda by picking the latest installer suitable for your system.

About Conda and Miniconda

Conda is an open source package management system and environment management system that runs on Windows, macOS and Linux. Conda quickly installs, runs and updates packages and their dependencies. Conda easily creates, saves, loads and switches between environments on your local computer. Find out more on the official documentation

Miniconda is a free minimal installer for conda. It is a small, bootstrap version of Anaconda that includes only conda, Python, the packages they depend on, and a small number of other useful packages, including pip, zlib and a few others.

Install Gnomon

  • Step 1: (Optional) Install Mamba in your (base) environment

conda install -n base -c conda-forge mamba
  • Step 2: Create a conda environment with the right python version. Then activate this environment

conda create -n gnomon python=3.9
conda activate gnomon
  • Step 3: Install gnomon and its dependencies

mamba install -c dtk-forge6 -c gnomon -c mosaic -c morpheme -c conda-forge gnomon
  • Step 4: Congrats, you can now launch the application

gnomon

Prerequisites

  • Installing gnomon requires around 4 GB of free disk space, environment included.

  • Gnomon requires Mac OS 11 (Big Sur) or later

  • Make sure you have conda installed on your system. To check, simply open a new terminal window and type:

conda
  • If conda is installed, you should get a long return value describing how to use the command, otherwise you will get a command not found message.

  • If conda is not installed, we recommend that you install Miniconda by picking the latest installer suitable for your system.

About Conda and Miniconda

Conda is an open source package management system and environment management system that runs on Windows, macOS and Linux. Conda quickly installs, runs and updates packages and their dependencies. Conda easily creates, saves, loads and switches between environments on your local computer. Find out more on the official documentation

Miniconda is a free minimal installer for conda. It is a small, bootstrap version of Anaconda that includes only conda, Python, the packages they depend on, and a small number of other useful packages, including pip, zlib and a few others.

Install Gnomon

  • Step 1: (Optional) Install Mamba in your (base) environment

conda install -n base -c conda-forge mamba
  • Step 2: Create a conda environment with the right python version. Then activate this environment

conda create -n gnomon python=3.9
conda activate gnomon
  • Step 3: Install gnomon and its dependencies

mamba install -c dtk-forge6 -c gnomon -c mosaic -c morpheme -c conda-forge gnomon
  • Step 4: Congrats, you can now launch the application

gnomon
Mac ARM support

For Mac ARM architectures, you need to tell conda to use x86 architecture like this:

CONDA_SUBDIR=osx-64 conda create -n gnomon python=3.9
conda activate gnomon
conda config --env --set subdir osx-64

Install Gnomon via WSL

Warning

Some of the dependencies required by Gnomon are not packaged for Windows, but it is possible to use Linux packages via the Windows Subsystem for Linux (WSL).

Installation guidelines for Windows

Important

At this stage the gnomon application is installed but “empty” since no Plugins are installed by default. To actually make it usable, you will have to

Install Plugin Packages

Updating Gnomon#

  • Step 1: Activate your (gnomon) environment

conda activate gnomon
  • Step 2: Update gnomon and its dependencies

gnomon-utils package update
Alternative command
mamba update -c dtk-forge6 -c gnomon -c mosaic -c morpheme -c conda-forge gnomon