DOC: Documentation for updated build system

README.md

@@ -30,14 +30,33 @@ For details on Pybind11 and Armadillo refer to their respective documentation [1
 
 ## Installation
 CARMA is a header only library that relies on two other header only libraries, Armadillo and Pybind11.
+It can be integrated in a CMake build using `ADD_SUBDIRECTORY(<path_to_carma>)` or installation which provides an interface library target `carma::carma` that has been linked with Python, Numpy, Pybind11 and Armadillo. See [build configuration](https://carma.readthedocs.io/en/stable/building.html) for details.
+
+It can be installed using:
+```bash
+mkdir build
+cd build
+# optionally with -DCMAKE_INSTALL_PREFIX:PATH=<path/to/desired/location>
+cmake -DCARMA_INSTALL_LIB=ON ..
+cmake --build . --config Release --target install
+```
+
+You can than include it in a project using:
 
-CARMA can be integrated in a CMake build using `ADD_SUBDIRECTORY(<path_to_carma>)` which provides an interface library target `carma`
-that has been linked with Python, Numpy, Pybind11 and Armadillo. For Pybind11 and or Armadillo we create target(s) based on user settable version, see [build configuration](https://carma.readthedocs.io/en/stable/building.html), when they are not defined.
+```cmake
+FIND_PACKAGE(carma CONFIG REQUIRED)
+TARGET_LINK_LIBRARIES(<your_target> PRIVATE carma::carma)
+```
+
+### CMake subdirectory
+
+Alternatively you can forgo installing CARMA and directly use it as CMake subdirectory.
+For Pybind11 and or Armadillo we create target(s) based on user settable version, see [build configuration](https://carma.readthedocs.io/en/stable/building.html), when they are not defined.
 
 To link with CARMA:
 ```cmake
 ADD_SUBDIRECTORY(extern/carma)
-TARGET_LINK_LIBRARIES(<your_target> PRIVATE carma)
+TARGET_LINK_LIBRARIES(<your_target> PRIVATE carma::carma)
 ```
 CARMA and Armadillo can then be included using:
 ```C++
@@ -89,6 +108,8 @@ creating the tuple for the way out.
 #include <pybind11/numpy.h>
 #include <pybind11/pytypes.h>
 
+namespace py = pybind11;
+
 py::tuple ols(arma::mat& X, arma::colvec& y) {
     // We borrow the data underlying the numpy arrays
     int n = X.n_rows, k = X.n_cols;

docs/source/building.rst

@@ -14,29 +14,88 @@ CARMA v0.5 requires a compiler with support for C++14 and supports:
 * Pybind11 v2.6.0 -- v2.6.2
 * Armadillo >= 10.5.2
 
-CARMA target
-------------
+CMake build
+-----------
 
 CARMA provides a CMake configuration that can be used to integrate into existing builds.
-It is advised to use :bash:`ADD_SUBDIRECTORY`, this provides an interface target, ``carma``, that can be linked to your target.
+You can either use it directly or install it first. To edit the configuration please see 
+
+It is advised to use the ``carma::carma`` interface target that can be linked to your target.
 This target pre-compiles the ``cnalloc.h`` header containing wrappers around Numpy's (de)allocator that are then picked up by Armadillo.
 By pre-compiling the header we can ensure that the ``ARMA_ALIEN_MEM_ALLOC`` and ``ARMA_ALIEN_MEM_FREE`` definitions exist when including Armadillo
 regardless of the include order.
 
 .. warning:: if you are not using CARMA's cmake target you have to ensure that you include CARMA before Armadillo. Not doing so results in a compile error.
 
+Installation
+************
+
+Make sure to change the configuration if desired before installing CARMA.
+
+CARMA can be installed using:
+
+.. code-block:: bash
+    
+    mkdir build
+    cd build
+    # optionally with -DCMAKE_INSTALL_PREFIX:PATH=
+    cmake -DCARMA_INSTALL_LIB=ON ..
+    cmake --build . --config Release --target install
+
+You can than include it in a project using:
+
+.. code-block:: cmake
+
+    FIND_PACKAGE(carma CONFIG REQUIRED)
+    TARGET_LINK_LIBRARIES(<your_target> PRIVATE carma::carma)
+
+The ``REQUIRED`` state is propagated to the dependencies of CARMA.
+
+Variables
+^^^^^^^^^
+
+The :bash:`FIND_PACKAGE` call sets the following variables
+
+- ``carma_FOUND`` -- true if CARMA was found
+- ``carma_INCLUDE_DIR`` -- the path to CARMA's include directory
+- ``carma_INCLUDE_DIRS`` -- the paths to CARMA's include directory and the paths to the include directories of the dependencies.
+
+Components
+^^^^^^^^^^
+
+When including carma using :bash:`FIND_PACKAGE` two targets are created:
+
+- ``carma::carma``
+
+``carma::carma`` has been linked with Python, Numpy, Pybind11 and Armadillo and pre-compiles the ``cnalloc.h`` header which means that there is no required order to includes or carma and armadillo. If you only want this component you can use :bash:`FIND_PACKAGE(carma CONFIG REQUIRED COMPONENTS carma)`
+
+- ``carma::headers``
+
+If you want to have a header-only target that is not linked with the dependencies and does not pre-compile ``cnalloc.h``. You must than make sure to link it to it's dependencies and make sure to always include carma before armadillo.
+If you only want this component you can use :bash:`FIND_PACKAGE(carma CONFIG REQUIRED COMPONENTS headers)`
+
+Subdirectory
+************
+
+Alternatively, you can use CARMA without installing it by using:
+
+.. code-block:: cmake
+
+    ADD_SUBDIRECTORY(extern/carma)
+    TARGET_LINK_LIBRARIES(<your_target> PRIVATE carma::carma)
+
+The same targets and conditions as for the installation hold, however, this build will obtain Armadillo and Pybind11 if they have not been provided.
+
 Armadillo
 ---------
 
 Users can provide a specific Armadillo version by making sure the target ``armadillo`` is set before including CARMA or by setting:
 
-The Armadillo version can be set using:
-
 .. code-block:: bash
     
     -DARMADILLO_ROOT_DIR=/path/to/armadillo/root/directory
 
-If neither is set, CARMA will provide the ``armadillo`` target at build time and store a clone of armadillo in ``carma/extern/armadillo-code``.  The Armadillo version, by default ``10.5.2``, can be set using:
+When using the subdirectory build, if neither is set, CARMA will provide the ``armadillo`` target at build time and store a clone of armadillo in ``carma/extern/armadillo-code``.  The Armadillo version, by default ``10.5.2``, can be set using:
 
 .. code-block:: bash
     
@@ -52,7 +111,7 @@ Users can provide a specific Pybind11 version by making sure the target ``pybind
     -DPYBIND11_ROOT_DIR=/path/to/pybind11/root/directory
 
 
-If neither is set, CARMA will provide the ``pybind11`` target at build time and store a clone in ``carma/extern/pybind11``.  The Pybind11 version, by default ``v2.6.2`` can be set using:
+When using the subdirectory build, if neither is set, CARMA will provide the ``pybind11`` target at build time and store a clone in ``carma/extern/pybind11``.  The Pybind11 version, by default ``v2.6.2`` can be set using:
 
 .. code-block:: bash