.. Copyright (c) 2016, Johan Mabille and Sylvain Corlay

   Distributed under the terms of the BSD 3-Clause License.

   The full license is in the file LICENSE, distributed with this software.


.. raw:: html

   <style>
   .rst-content .section>img {
       width: 30px;
       margin-bottom: 0;
       margin-top: 0;
       margin-right: 15px;
       margin-left: 15px;
       float: left;
   }
   </style>

Installation
============

`xsimd` is a header-only library, so installing it is just a matter of copying the ``include/xsimd`` directory.

However we provide standardized means to install it, with package managers or with cmake.
Besides the `xsimd` headers, all these methods place the ``cmake`` project configuration file in the right location so that third-party projects can use cmake's ``find_package`` to locate `xsimd` headers.

.. image:: conda.svg

Using the conda-forge Package
-----------------------------

A package for `xsimd` is available for the `mamba <https://mamba.readthedocs.io>`_ (or `conda <https://conda.io>`_) package manager.

.. code::

    mamba install -c conda-forge xsimd

.. image:: spack.svg

Using the Spack Package
-----------------------

A package for `xsimd` is available on the `Spack <https://spack.io>`_ package manager.

.. code::

    spack install xsimd
    spack load xsimd

.. image:: cmake.svg

From Source with cmake
----------------------

You can install `xsimd` from source with `cmake <https://cmake.org/>`_. On Unix platforms, from the source directory:

.. code::

    mkdir build
    cd build
    cmake -DCMAKE_INSTALL_PREFIX=/path/to/prefix ..
    make install

On Windows platforms, from the source directory:

.. code::

    mkdir build
    cd build
    cmake -G "NMake Makefiles" -DCMAKE_INSTALL_PREFIX=/path/to/prefix ..
    nmake
    nmake install