🚀 GALACTIC Installation Guide#

This document describes how to install GALACTIC.

Attention

While GALACTIC may work on other Linux distributions or operating systems, this guide officially supports Ubuntu 24.04 with Conda.

Setup#

We recommend Miniconda (lightweight and stable).

Download and install Miniconda from the official site: https://docs.conda.io/en/latest/miniconda.html

Choose an environment configuration based on your use case:

Use case

Filename

Default user installation

base.yml

Create the Conda environment (replace base.yml with your chosen file if needed):

$ conda env create -f base.yml

Activate the environment:

$ conda activate galactic

Tip

Optionally, to enable shell completion for the GALACTIC CLI in bash, run:

(galactic) $ eval "$(_GALACTIC_COMPLETE=bash_source galactic)"

For other shells, visit: https://click.palletsprojects.com/en/stable/shell-completion/

On Ubuntu 24.04 (including WSL on Windows), install the necessary dependencies and set up a virtual environment as follows.

Update package lists and upgrade installed packages:

$ sudo apt update && sudo apt upgrade -y

Install Python 3 and related packages:

$ sudo apt install python3 python3-venv python3-pip python-is-python3 -y

Install Graphviz for visualization:

$ sudo apt install graphviz -y

Create a virtual environment for GALACTIC:

$ python -m venv galactic

Activate the environment:

$ source galactic/bin/activate

Install the GALACTIC CLI package:

(galactic) $ pip install galactic

Tip

Optionally, to enable shell completion for the GALACTIC CLI in bash, run:

(galactic) $ eval "$(_GALACTIC_COMPLETE=bash_source galactic)"

For other shells, visit: https://click.palletsprojects.com/en/stable/shell-completion/

Verify installation#

Verify Graphviz installation:

(galactic) $ dot -V

Verify Python package installation:

(galactic) $ python -c "import galactic"

Verify Graphviz installation:

(galactic) $ dot -V

Verify Python package installation:

(galactic) $ python -c "import galactic"

Configure access#

Configure access to the GALACTIC public store:

(galactic) $ galactic config init

Configure access to the GALACTIC public store:

(galactic) $ galactic config init

Install some packages#

Install for testing the galactic-algebra-concept package with the docs feature:

(galactic) $ pip install "galactic-algebra-concept[docs]"

Install for testing the galactic-algebra-concept package with the docs feature:

(galactic) $ pip install "galactic-algebra-concept[docs]"

Run Jupyter Notebooks#

To explore tutorials and documentation, start the Jupyter notebook server:

(galactic) $ jupyter notebook $CONDA_PREFIX/share/galactic

Attention

Replace $CONDA_PREFIX with %CONDA_PREFIX% in the Windows Command Prompt and with $env:CONDA_PREFIX in Windows PowerShell.

To explore tutorials and documentation, start the Jupyter notebook server:

(galactic) $ jupyter notebook $VIRTUAL_ENV/share/galactic

Attention

Replace $VIRTUAL_ENV with %VIRTUAL_ENV% in the Windows Command Prompt and with $env:VIRTUAL_ENV in Windows PowerShell.

Deactivate#

To deactivate the Conda environment when you’re done:

(galactic) $ conda deactivate

To deactivate the virtual environment when you’re done:

(galactic) $ deactivate

Uninstall#

To uninstall the Conda environment if necessary:

$ conda remove -n galactic --all -y

To remove the virtual environment if necessary:

$ rm -rf galactic