File: installation.rst

package info (click to toggle)
python-ruffus 2.8.4-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 16,468 kB
  • sloc: python: 17,613; makefile: 213; sh: 18
file content (58 lines) | stat: -rw-r--r-- 1,564 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
.. include:: global.inc
.. _Installation:

************************************
Installation
************************************

:mod:`Ruffus` is a lightweight python module for building computational pipelines.

.. note ::

    Ruffus requires Python 3.0 or higher, python 2 is no longer supported but older versions will still be python 2 compatible.



==============================================================================
conda installation
==============================================================================

The recomended method for installing CGAT-ruffus is to install using `conda <https://conda.io/en/latest/>`_ through
the `bioconda <https://anaconda.org/bioconda/ruffus>`_ channel. The reson for conda being the prefferred method
is that the dependancied are taken care of.

    ::

        conda install -c bioconda ruffus

==============================================================================
pip installation
==============================================================================

    *Ruffus* is also available on `pypi <https://pypi.org/project/ruffus/>`_.

    ::

        pip install ruffus

==============================================================================
Manual installation
==============================================================================

To obtain the latest code, check it out from `github <https://github.com/cgat-developers/ruffus>`_ and activate it.

    ::

        git clone https://github.com/cgat-developers/ruffus.git
	cd ruffus
	python setup.py install