Installation instructions

Installation

There are a couple of options for installing EnGens locally.

  1. Pulling the Docker image (all platforms)

  2. Building the Docker image (all platforms)

  3. Conda installation (LinuxOS)

For running EnGens demos online, checkout our Google Colab and Binder notebooks.

Binder Link

Colab Link

Docker pull

Make sure you have the Docker installed.

Open the console and simply run:

$ docker pull ac121/engens:latest

Docker build

You can clone this repo and build the docker image yourself.

prerequisites: git , docker

  1. Clone the github repo:

$ git clone https://github.com/KavrakiLab/EnGens.git

  1. Build the image:

$ cd EnGens
$ docker build -t test_engens:latest .

You’re all set!

Conda build

If you don’t want to use docker, you can clone this repo and install using conda (or mamba which will be faster).

prerequisites: conda or mamba

  1. Clone the github repo:

$ git clone https://github.com/KavrakiLab/EnGens.git

  1. Install with conda (or mamba)

$ cd EnGens
$ conda env create -f ./environment.yaml
$ #mamba env create -f ./environment.yml

$ conda activate engens
$ #mamba activate engens

$ ./linux_setup.sh

If the command ./linux_setup.sh fails due to not having pypatch - do pip install pypatch.