Getting Started

Prerequisites

color-scheming is easily set up using anaconda. Create a conda environment with the following packages installed.

- numpy, scipy, graph-tool: for calculating reaction coordinates

- gsd: to store simulated particle trajectories

- matplotlib, moviepy: to render movies of particle trajectories

- ffmpeg: is automatically installed as a dependency of moviepy

$ conda create -n ENV_NAME
$ conda activate ENV_NAME
$ conda install -c conda-forge numpy scipy graph-tool gsd matplotlib moviepy

Installation

After installing prerequesites, clone the git repository:

$ git clone https://github.com/johnemmanuelbond/collRC path_to_repo

Users may install the repository into a conda environment using conda develop

$ conda develop path_to_repo/src

Uninstall with

$ conda develop -u path_to_repo/src