πŸš€ GALACTIC Installation Guide#

This document describes how to install GALACTIC.

Ubuntu 24.04#

On an Ubuntu 24.04 system (inluding WSL on Windows), you can install the necessary dependencies and set up a virtual environment as follows:

Update System and Install Dependencies#

Update package lists and upgrade existing 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

Set Up Virtual Environment#

Create a virtual environment for GALACTIC

$ python -m venv galactic

Activate the virtual environment

$ source galactic/bin/activate
(galactic) $ galactic init

This will ask you to enter your password to access to the GALACTIC store, which is required to install some packages from the ecosystem. If you don’t have an account, you can use an empty password; this will give you access to the public packages.

Install GALACTIC#

Install any package from the GALACTIC ecosystem, for example the concept algebra via pip:

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

Verify Installation#

Run a basic check:

(galactic) $ python -c "import galactic"

Run Jupyter Notebooks#

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

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

Attention

Replace $VIRTUAL_ENV with %$VIRTUAL_ENV% on windows systems.

Uninstall#

To remove the virtual environment, simply delete the galactic directory:

(galactic) $ deactivate
$ rm -rf galactic