Installation

Warning

The grand package is meant to be used on Unix systems. For Windows users we recommend using WSL or a virtual machine.

Python 3.8 or later is required for installing and running the grand package. OS specific instructions are found below.

Linux

Once you have Python 3.8 installed your can get the grand package from PyPI, e.g. using pip as:

pip install grand

If you don’t already have Python3.8, on Linux we provide a ready to use AppImage. It contains Python3.8 and extra Python packages needed by grand. Note that you need not use this AppImage. The grand package is compatible with any distribution of CPython 3.8, e.g. installing from source or using conda if you prefer.

If you like to go for the AppImage you can download it from GitHub as:

wget https://github.com/grand-mother/grand/releases/download/appimage/python3-x86_64.AppImage
chmod +x python3-x86_64.AppImage

Further instructions on Python AppImages can be found on GitHub. In particular we recommend extracting the AppImage in order to get a contained and expendable Python runtime. This can be done as:

./python3-x86_64.AppImage --appimage-extract
mv squashfs-root python3
rm -f python3-x86_64.AppImage

Then, you can export the AppImage python to you environment as:

export PATH="$(path)/python3/usr/bin:$PATH"

OSX

On OSX you will need to build the grand package from the source. This can be done as:

git clone https://github.com/grand-mother/grand.git
cd grand
pip3.8 install --user -U pip
pip3.8 install --user -U -r requirements.txt
make install PYTHON=$(which python3.8)

Once built, the grand package can be relocated to any desired location.