Installing ShakeLab

Overview

ShakeLab is written in Python and currently supports Python 3.10.

Installation using pip

ShakeLab is available as a Python package on PyPI and can be installed using pip. Using pip is recommended for new users, as pip automatically manages and installs all the required dependencies.

$ pip3 install -U shakelab

However, since ShakeLab is currently under development, be aware that the pip repository might not be the most up-to-date source. If you are a developer, refer to the section Installation from sources.

Using a virtual environment

It is highly recommended to use a virtual environment when installing ShakeLab to avoid conflicts with other packages.

First, create a virtual environment:

$ python3 -m venv shakelab-env

Activate the virtual environment:

On Windows:

$ shakelab-env\Scripts\activate

On macOS and Linux:

$ source shakelab-env/bin/activate

Once the virtual environment is activated, you can install ShakeLab using pip:

(shakelab-env) $ pip3 install -U shakelab

Installation using MacPorts

For Mac users, installation can be done using the command port of the MacPorts package manager.

$ sudo port install py310-shakelab

To set up the executable paths, use the port select command:

$ sudo port select --set sphinx py310-shakelab

For more information, refer to the package overview.

Installation from sources

For the most up-to-date installation, ShakeLab can be installed directly from the GitHub repository.

$ pip3 install git+https://github.com/shakelab/shakelab.git

To upgrade an existing installation:

$ pip3 install --upgrade git+https://github.com/shakelab/shakelab.git

If you are a developer, you can simply install the cloned Git repository with:

$ pip3 install --upgrade --editable shakelab