Installation¶

If you plan on developing the LEAP package, you will need to install via the following steps:

1. Install R¶

In order to work on the data_generation submodule, you will need to install R and the rpy2 package. The rpy2 package is a Python interface to R, which allows you to run R code from Python.

MacOS¶

Go to the R for MacOS page and download the latest version of R.

Linux (Ubuntu/Debian)¶

Follow the instructions on the R for Ubuntu page to install the latest version of R.

sudo apt-get update
sudo apt-get install r-base
sudo apt-get install r-base-dev

Windows¶

Go to the R for Windows page and download the latest version of R.

2. Install pandoc¶

If you plan on working on the docs, you will also need to install pandoc, as this is used to convert Jupyter notebooks to rst files.

MacOS¶

brew install pandoc
pandoc --version

Linux (Ubuntu/Debian)¶

wget https://github.com/jgm/pandoc/releases/download/3.6.4/pandoc-3.6.4-1-amd64.deb
sudo dpkg -i pandoc-3.6.4-1-amd64.deb
sudo apt-get install -f
pandoc --version

Windows¶

See the pandoc installation instructions for Windows.

3. Install git-lfs¶

MacOS¶

See the git-lfs installation instructions for MacOS.

brew install git-lfs
git lfs install
sudo git lfs install --system

Linux (Ubuntu/Debian)¶

See the git-lfs installation instructions for Linux.

Windows¶

See the git-lfs installation instructions for Windows.

4. Install LEAP¶

To install a development version of the LEAP package:

git clone https://github.com/resplab/leap.git
cd leap
pip install -e ".[dev]"
pip install -r requirements-docs.txt
pip install -r requirements-data-generation.txt