MARCELL-TOOLS

Prerequisites

This project requires a Conda installation. For instructions on how to install miniconda see: https://conda.io/miniconda.html.

Creating a new environment

To install the project for first time, create new conda environment:

On Linux/MacOS machines, create a new marcell-tools environment with:

conda env create -n marcell-tools -f environment.yml
source activate marcell-tools
pip install -e .

On Windows machines the activation command is slightly different:

conda env create -n marcell-tools -f environment.yml
activate marcell-tools 
pip install -e .

Updating environment requirements

To update changes in the requirements (as defined in the environment.yml file) orsetup.py:

Linux/MacOS:

conda env update -n marcell-tools -f environment.yml
source activate marcell-tools
pip install -e .

Windows:

conda env update -n marcell-tools -f environment.yml
activate marcell-tools
pip install -e .

Pyfasttext

The pyfasttext module has to be installed separately within the environment:

• source activate marcell-tools
• pip install pyfasttext

Remember to re-activate

When running the project, remember to activate the marellipi environment:

On Linux/MacOS:

source activate marcell-tools

Windows:

activate marcell-tools

Verify and test

TBA