Skip to content

Commit a101a42

Browse files
committed
README update
1 parent 149b031 commit a101a42

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

README.rst

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -38,37 +38,32 @@ populations; see split_.
3838
Installation instructions
3939
=========================
4040

41-
Experimental pre-compiled binaries are available from the `releases
42-
page`_. These should work in most cases, however some users have
43-
reported issues related to threading conflicts in some cluster
44-
environments.
41+
Installer binaries are available from the `releases page`_. Download the
42+
installer for your platform and then run it using ``bash``. The script
43+
will walk you through the installation process.
4544

46-
The recommended way to install SMC++ is using the pre-compiled package
47-
for the Anaconda_ scientific Python distribution::
45+
The installers are based on the Anaconda_ scientific Python distribution.
46+
If Anaconda already exists on your machine, a more efficient way to
47+
install SMC++ is by using the ``conda`` command::
4848

4949
$ conda install -c terhorst -c bioconda -c conda-forge smcpp
5050

5151
This will automatically download all necessary dependencies and create
5252
an ``smc++`` executable in the ``bin/`` folder of your Anaconda
5353
distribution.
5454

55-
(If Anaconda Python is not currently installed on your system, we
56-
recommend installing Miniconda_ as it requires less space. Note that
57-
this does not require root access.)
58-
5955
If neither of these options works for you, you may build the software
6056
from scratch using the `build instructions`_ provided in the next
6157
section.
6258

6359
.. _releases page: https://github.com/popgenmethods/smcpp/releases
6460
.. _Anaconda: https://www.continuum.io/downloads
65-
.. _Miniconda: http://conda.pydata.org/miniconda.html
6661

6762
Build instructions
6863
==================
6964
SMC++ requires the following libraries and executables in order compile and run:
7065

71-
- Python 3.0 or greater.
66+
- Python 3.3 or greater.
7267
- A C++-11 compiler (gcc 4.8 or later, for example).
7368
- gmp_, for some rational field computations.
7469
- mpfr_ (at least version 3.0.0), for some extended precision calculations.
@@ -83,20 +78,15 @@ On OS X, the easiest way to install them is using Homebrew_::
8378

8479
$ brew install mpfr gmp gsl
8580

81+
After installing the requirements, SMC++ may be built by running::
82+
83+
$ pip install git+https://github.com/popgenmethods/smcpp
84+
8685
.. _Homebrew: http://brew.sh
8786
.. _gmp: http://gmplib.org
8887
.. _mpfr: http://mpfr.org
8988
.. _gsl: https//www.gnu.org/software/gsl/
9089

91-
Installing SMC++
92-
----------------
93-
After installing the requirements, SMC++ may be built by running::
94-
95-
$ git clone http://github.com/popgenmethods/smcpp
96-
$ cd smcpp
97-
$ python setup.py install
98-
99-
10090
Note for OS X users
10191
-------------------
10292
Versions of Clang shipping with Mac OS X do not currently support

0 commit comments

Comments
 (0)