From 3d6c7b2efdc94e1e2a405cb1c09c82c6b31221ef Mon Sep 17 00:00:00 2001 From: Benoit Bovy Date: Wed, 29 Aug 2018 12:19:47 +0200 Subject: [PATCH] doc: add instruction for installation using conda --- doc/source/install.rst | 37 ++++++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/doc/source/install.rst b/doc/source/install.rst index 41ee4595..43289ccc 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -4,18 +4,34 @@ Install Fastscapelib ==================== This library is header only and uses C++14 standards. It depends on -xtensor_. You can install xtensor, e.g., using conda_: +xtensor_. -.. code-block:: bash - - $ conda install xtensor -c conda-forge +.. _xtensor: https://github.com/QuantStack/xtensor Install the C++ library ----------------------- +Using conda +~~~~~~~~~~~ + +Fastscapelib is available as a conda_ package in the conda-forge channel. + +.. code-block:: bash + + $ conda install fastscapelib -c conda-forge + +.. _conda: https://conda.io/docs/ + From source using cmake ~~~~~~~~~~~~~~~~~~~~~~~ +You need to first install the dependencies. You can install xtensor, +e.g., using conda_: + +.. code-block:: bash + + $ conda install xtensor -c conda-forge + Run the commands below from the source directory to install the fastscapelib's header files using cmake (on Unix platforms): @@ -39,12 +55,19 @@ On Windows platforms: $ nmake $ nmake install -.. _xtensor: https://github.com/QuantStack/xtensor -.. _conda: https://conda.io/docs/ - Install the Python library -------------------------- +Using conda +~~~~~~~~~~~ + +Fastscapelib's Python bindings is available as a separate conda_ +package, still in the conda-forge channel. + +.. code-block:: bash + + $ conda install fastscapelib-python -c conda-forge + From source using pip ~~~~~~~~~~~~~~~~~~~~~