π GALACTIC Installation Guide#
This document describes how to install GALACTIC.
Using Conda (Recommended)#
The setup uses a fully isolated Conda environment and does not modify system Python.
β οΈ While GALACTIC may work on other Linux distributions or operating systems, this guide officially supports Ubuntu 24.04 with Conda.
Install Conda#
We recommend Miniconda (lightweight and stable).
Download and install Miniconda from the official site: https://docs.conda.io/en/latest/miniconda.html
Create the Conda Environment#
Choose an environment configuration based on your use case:
Use case |
Filename |
|---|---|
Default user install |
Create a dedicated environment (replace base.yml with your chosen file if needed):
$ conda env create -f base.yml
Activate the environment:
$ conda activate galactic
Verify Graphviz installation:
(galactic) $ dot -V
Install GALACTIC#
Install any package from the GALACTIC ecosystem, for example the concept algebra
via pip:
(galactic) $ pip install \
--extra-index-url https://www.thegalactic.org/pypi/simple/ \
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 $CONDA_PREFIX/share/galactic
Uninstall#
To remove the environment completely:
(galactic) $ conda deactivate
$ conda remove -n galactic --all
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
Install GALACTIC#
Install any package from the GALACTIC ecosystem, for example the concept algebra
via pip:
(galactic) $ pip install \
--extra-index-url https://www.thegalactic.org/pypi/simple/ \
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
Uninstall#
To remove the virtual environment, simply delete the galactic directory:
(galactic) $ deactivate
$ rm -rf galactic
π§ To be completedβ¦ π§