Installation

The e2elink is a Python package. Installation should be straightforward.

Linux and MacOSX

We recommend using a conda environment:

$ conda create -n e2elink python=3.7
$ conda activate e2elink

Then simply run:

$ git clone https://github.com/ersilia-os/cidrz-e2e-linkage.git
$ cd cidrz-e2e-linkage
$ pip install -e .

You are done!

A CLI command will be available to you.

$ ersilia --help

This package uses pre-trained machine-learning models and pre-computed synthetic data that require about 1 GB of disk space. These data will be downloaded the first time the software is run.

For developers

The e2elink package contains many machine-learning functionalities that were necessary to prepare a pre-trained list of models. To obtain a fully-featured version of the tool, run:

$ pip install .[dev]