Usage

Installation

To use μGUIDE, first install it using pip:

  1. We recommend to use a conda virtual environment. If conda is installed on your machine, an environment for installing μGUIDE can be created as follows:

$ conda create -n uGUIDE_env python=3.8 && conda activate uGUIDE_env

  1. Fork the repository and run the following command to clone it on your local machine:

(uGUIDE_env) $ git clone git@github.com:{YOUR_GITHUB_USERNAME}/uGUIDE.git

  1. cd to μGUIDE directory and install it:

(uGUIDE_env) $ cd uGUIDE
(uGUIDE_env) $ pip install .

This will also install the dependencies of μGUIDE.

  1. To check if the installation worked fine, you can run:

(uGUIDE_env) $ python -c 'import uGUIDE'

and it should not give any error message.