<img src="docs/logos/arborx_logo_v1.0.png" width="192">

ArborX
======
ArborX is an open-source library designed to provide performance portable
algorithms for geometric search, similarly to nanoflann and Boost Geometry.

Installation
------------
The installation instructions can be found [here](https://github.com/arborx/ArborX/wiki/Build).

Using ArborX
------------
The interface is described [here](https://github.com/arborx/ArborX/wiki/ArborX%3A%3ABoundingVolumeHierarchy).

Examples
--------
Examples can be found in the [examples directory](https://github.com/arborx/ArborX/tree/master/examples).

Questions, Bug Reporting, and Issue Tracking
--------------------------------------------
Questions, bug reporting and issue tracking are provided by GitHub. Please
report all bugs by creating a new issue with the "bug" tag. You can ask
questions by creating a new issue with the "question" tag.

Contributing
------------
We encourage you to contribute to ArborX! Please check out the
[guidelines](CONTRIBUTING.md) about how to proceed.

Citing ArborX
-------------
## Citing

If you use ArborX in your work, please cite the [TOMS article](CITATION.bib).

License
-------
ArborX has a [BSD 3-clause open-source license](LICENSE).
