Installation

dipwmsearch can be installed via the environment manager conda, via the Python package installer pip, or directly from source code via git. The preferred and advisable installation procedure is via conda.

dipwmsearch works on Linux and Mac OSX operating systems.

Installation using conda

Prerequisite

This requires to have conda installed. To test whether it is the case, in a shell just type:

conda -V
# which prints the version number of conda
conda -h
# which should print the help

If conda is not installed please refer to https://conda.io/projects/conda/en/latest/user-guide/install/index.html and install conda before going further.

Create a dedicated environment and install the package

The following bash commands will

create a new environment called myname
install the dipwmsearch package in it
activate the conda environment
run a test command for dipwmsearch.

env_name="myname"
conda create --name ${env_name} -c conda-forge  -c atgc-montpellier dipwmsearch
conda activate ${env_name}
python -m dipwmsearch

Package installation (within your prefered environment)

From the channel of the ATGC-Montpellier organisation:

conda install -c atgc-montpellier dipwmsearch

Installation using pip

pip install dipwmsearch

Local installation using git

## clone the git repository::
git clone git@gite.lirmm.fr:rivals/dipwmsearch.git
## go to the root of the folder::
cd dipwmsearch
## use the `Makefile` to complete installation
make install

Help with installation

An introduction to conda can be found here. We advised to use Miniconda to install and setup conda on your local account.

The tool pip is the standard program to install modules for Python: look at its documentation.