Skip to content

Commit b4a1220

Browse files
authored
Update docs to remove precompiled binaries
1 parent 205a5e9 commit b4a1220

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

README.rst

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ whole genome sequence data.
99
Quick start guide
1010
=================
1111

12-
1. Download and install the `latest release`_.
12+
1. Follow the `installation instructions`_.
1313

1414
2. Convert your VCF(s) to the SMC++ input format with vcf2smc_::
1515

@@ -43,24 +43,16 @@ populations; see split_.
4343
Installation instructions
4444
=========================
4545

46-
Installer binaries are available from the `releases page`_. Download
47-
the installer for your platform and then run it using ``bash``.
48-
The script will walk you through the installation process. You may
49-
need to ``source /path/to/smcpp/bin/activate`` before running
50-
``/path/to/smcpp/bin/smc++`` in order to prevent conflicts with your
51-
existing Python installation.
52-
53-
The installers are based on the Anaconda_ scientific Python distribution.
54-
If Anaconda already exists on your machine, a more efficient way to
55-
install SMC++ is by using the ``conda`` command::
46+
SMC++ is distributed as an Anaconda_ package. Inside the Anaconda environment, install
47+
the precompiled binary using the command::
5648

5749
$ conda install -c terhorst -c bioconda -c conda-forge smcpp
5850

5951
This will automatically download all necessary dependencies and create
6052
an ``smc++`` executable in the ``bin/`` folder of your Anaconda
6153
distribution.
6254

63-
If neither of these options works for you, you may build the software
55+
You may also build the software
6456
from scratch using the `build instructions`_ provided in the next
6557
section.
6658

@@ -71,7 +63,7 @@ Build instructions
7163
==================
7264
SMC++ requires the following libraries and executables in order compile and run:
7365

74-
- Python 3.3 or greater.
66+
- Python 3.5 or greater.
7567
- A C++-11 compiler (gcc 4.8 or later, for example).
7668
- gmp_, for some rational field computations.
7769
- mpfr_ (at least version 3.0.0), for some extended precision calculations.

0 commit comments

Comments
 (0)