Skip to content

Commit bf84169

Browse files
committed
Add a bit more detail on porechop gcc
1 parent c24ab22 commit bf84169

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,7 @@ produced in real-time along with fast pipelines for generating draft assemblies.
88

99
Documentation can be found at https://nanoporetech.github.io/pomoxis/.
1010

11-
Currently pomoxis supports only unix-like environments. Also of note is that
12-
the porechop dependency requires a compiler version that may not be installed
13-
by default on some systems.
14-
11+
Currently pomoxis supports only unix-like environments.
1512

1613
Build
1714
-----
@@ -24,9 +21,15 @@ To setup the environment run:
2421

2522
git clone --recursive https://github.com/nanoporetech/pomoxis
2623
cd pomoxis
24+
# For porechop to be compiled on older systems set these, e.g.:
25+
# export CXX="g++-4.9" CC="gcc-4.9"
2726
make install
2827
. ./venv/bin/activate
2928

29+
The installation of porechop (https://github.com/rrwick/Porechop)
30+
requires a newer compiler than is a available on some systems. It may therefore
31+
be necessary to install a newer compiler and set variables as in the above.
32+
3033
Running the above within a pre-exisiting virtual environnment may well fail;
3134
advanced may wish to simply run the `setup.py` file in the standard manner
3235
after compiling the third party programs as in the `Makefile`.

docs/index.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,23 @@ Installation
1414
Pomoxis should be installed inside a virtual environment. A Makefile is
1515
provided to fetch, compile and install all direct dependencies into an
1616
environment. (Some additional build dependencies are not installed via this
17-
Makefile, see `.gitlab-ci.yml` for additional requirements if things fail.
17+
Makefile, see `.travis.yml` for additional requirements if things fail.
1818

1919
To setup the environment run:
2020

2121
.. code-block:: bash
2222
23-
git clone --recursive https://git/research/pomoxis.git
23+
git clone --recursive https://github.com/nanoporetech/pomoxis.git
2424
cd pomoxis
25+
# For porechop to be compiled on older systems set these, e.g.:
26+
# export CXX="g++-4.9" CC="gcc-4.9"
2527
make install
2628
. ./venv/bin/activate
2729
30+
The installation of porechop `porechop <https://github.com/rrwick/Porechop>`_
31+
requires a newer compiler than is a available on some systems. It may therefore
32+
be necessary to install a newer compiler and set variables as in the above.
33+
2834
See :doc:`examples` for common bundled workflows.
2935

3036
Contents

0 commit comments

Comments
 (0)