Skip to content

Commit

Permalink
DOC: Update install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sebp committed Jun 30, 2024
1 parent 1675df8 commit bb88992
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions doc/install.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
Installing scikit-survival
==========================

This is the recommended and easiest to install scikit-survival is to use
:ref:`install-conda`.
The recommended and easiest way to install scikit-survival is to use
:ref:`install-conda` or :ref:`install-pip`.
Pre-built binary packages for scikit-survival are available for Linux, macOS, and Windows.
Alternatively, you can install scikit-survival :ref:`install-from-source`.

.. _install-conda:

Anaconda
--------
conda
-----

Pre-built binary packages for Linux, MacOS, and Windows are available
for `Anaconda <https://www.anaconda.com/distribution/>`_.
If you have Anaconda installed, run::
If you have `conda <https://docs.anaconda.com/>`_ installed, you can
install scikit-survival from the ``conda-forge`` channel by running::

conda install -c conda-forge scikit-survival

.. _install-pip:

pip
---

If you use ``pip``, install the latest release of scikit-survival with::

pip install scikit-survival


.. _install-from-source:

Expand All @@ -31,9 +40,9 @@ On Linux, you need to install *gcc*, which in most cases is available
via your distribution's packaging system.
Please follow your distribution's instructions on how to install packages.

**MacOS**
**macOS**

On MacOS, you need to install *clang*, which is available from
On macOS, you need to install *clang*, which is available from
the *Command Line Tools* package. Open a terminal and execute::

xcode-select --install
Expand All @@ -55,7 +64,7 @@ Latest Release

To install the latest release of scikit-survival from source, run::

pip install scikit-survival
pip install scikit-survival --no-binary scikit-survival


.. note::
Expand Down

0 comments on commit bb88992

Please sign in to comment.