Skip to content

Commit

Permalink
doc: add instruction for installation using conda
Browse files Browse the repository at this point in the history
  • Loading branch information
benbovy committed Aug 29, 2018
1 parent c60657c commit 3d6c7b2
Showing 1 changed file with 30 additions and 7 deletions.
37 changes: 30 additions & 7 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand All @@ -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
~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 3d6c7b2

Please sign in to comment.