Basic tools (containers, algorithms) used by other quantstack packages
Installation
Package managers
We provide a package for the mamba (or conda) package manager:
mamba install -c conda-forge xtl
Install from sources
xtl
is a header-only library.
You can directly install it from the sources:
cmake -D CMAKE_INSTALL_PREFIX=your_install_prefix
make install
Documentation
To get started with using xtl
, check out the full documentation
Building the HTML documentation
xtl's documentation is built with three tools
While doxygen must be installed separately, you can install breathe by typing
pip install breathe
Breathe can also be installed with conda
conda install -c conda-forge breathe
Finally, build the documentation with
make html
from the docs
subdirectory.
License
We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.
This software is licensed under the BSD-3-Clause license. See the LICENSE file for details.