###########
 Compiling
###########

******************
 Getting GooseEYE
******************

Using conda
===========

The easiest is to use *conda* to install *GooseEYE*:

.. code::

   conda install -c conda-forge gooseeye

From source
===========

Download the package:

.. code::

   git checkout https://github.com/tdegeus/GooseEYE.git
   cd GooseEYE

Install headers, *CMake* and *pkg-config* support:

.. code::

   cmake .
   make install

***********
 Compiling
***********

Using CMake
===========

The following structure can be used for your project's
``CMakeLists.txt``:

.. code:: cmake

   find_package(GooseEYE REQUIRED)

   add_executable(myexec mymain.cpp)

   target_link_libraries(myexec PRIVATE
       GooseEYE
       xtensor::optimize
       xtensor::use_xsimd)

See the `documentation of xtensor
<https://xtensor.readthedocs.io/en/latest/>`_ concerning optimisation.

.. note::

   There are additional targets available to expedite your
   ``CMakeLists.txt``:

   -  ``GooseEYE::assert``: enable GooseEYE assertions by defining
      ``GOOSEEYE_ENABLE_ASSERT``.

   -  ``GooseEYE::debug``: enable GooseEYE assertions by defining
      ``GOOSEEYE_ENABLE_ASSERT`` and xtensor assertions by defining
      ``XTENSOR_ENABLE_ASSERT`` (slow).

   -  ``GooseEYE::compiler_warnings``: enable compiler warnings
      (generic).

By hand
=======

Presuming that the compiler is ``c++``, compile using:

.. code::

   c++ -I/path/to/GooseEYE/include ...

Note that you have to take care of the *xtensor* dependency, the C++
version, optimisation, enabling *xsimd*, ...

Using pkg-config
================

Find the location of the headers can be automatised using *pkg-config*:

.. code::

   pkg-config --cflags GooseEYE