File: INSTALL.md

package info (click to toggle)
flye 2.9.5%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 36,720 kB
  • sloc: cpp: 14,771; python: 6,027; ansic: 322; makefile: 89; sh: 38
file content (68 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
59
60
61
62
63
64
65
66
67
68
Flye Installation
=================

Availability
------------

Flye is available for Linux and MacOS platforms.

Bioconda Releases
-----------------

You can get the latest stable release through Bioconda:

    conda install flye

Alternatively, you can get a release version from the github releases page


Building Requirements
---------------------

* Python 2.7 or 3.5+ (with setuptools package installed)
* C++ compiler with C++11 support (GCC 4.8+ / Clang 3.3+ / Apple Clang 5.0+)
* GNU make
* Git
* Core OS development headers (zlib, ...)


Local building (without installation)
-------------------------------------

You may use the package locally without system installation.
To get and compile the latest git version, run:

    git clone https://github.com/fenderglass/Flye
    cd Flye
    make

Then, Flye will be available as:

    python bin/flye

Building on ARM architecture
----------------------------

In case building Flye on ARM architecture fails, you might need to modify minimap2 compilation parameters:
https://github.com/fenderglass/Flye/issues/386

Installing from source
----------------------

To install the Flye package into your system, run:

    git clone https://github.com/fenderglass/Flye
	cd Flye
    python setup.py install

Depending on your OS, you might need to add
```--user``` or ```--prefix``` options to the 
install command for the local installation.

After installation, Flye could be invoked via:

    flye

Optionally, run some tests to ensure that installation was successful:

    python flye/tests/test_toy.py