Metadata-Version: 2.1
Name: balltree
Version: 1.0.1
Summary: Fast balltree implementation for 3-dim data.
Author-email: Jan Luca van den Busch <jlvdb@astro.ruhr-uni-bochum.de>
License: GPL-3.0-or-later
Project-URL: source, https://github.com/jlvdb/balltree.git
Project-URL: documentation, https://balltree.readthedocs.io/
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Programming Language :: C
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy >=1.21
Provides-Extra: dev
Requires-Dist: balltree[test] ; extra == 'dev'
Requires-Dist: balltree[docs] ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-design ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

.. image:: https://raw.githubusercontent.com/jlvdb/balltree/main/docs/source/_static/logo.png
    :width: 750
    :alt: balltree

|

.. image:: https://img.shields.io/pypi/v/balltree?logo=pypi&logoColor=blue
    :target: https://pypi.org/project/balltree/
.. image:: https://github.com/jlvdb/balltree/actions/workflows/python-ci.yml/badge.svg
    :target: https://github.com/jlvdb/yet_another_wizz/actions/workflows/python-ci.yml
.. image:: https://readthedocs.org/projects/balltree/badge/?version=latest
    :target: https://balltree.readthedocs.io/en/latest/?badge=latest

|

A fast ball tree implementation for three dimensional (weighted) data with an
Euclidean distance norm. The base implementation is in `C` and there is a
wrapper for `Python`.

The tree is optimised towards spatial correlation function calculations since
the query routines are geared towards range queries, i.e. counting pairs with a
given (range of) separations. Fixed number nearest neighbour search is currently
not implemented.

.. toc

Installation
------------

A `C` library can be built with the provided make file, the python wrapper is
automatically compiled and installed with ``pip install balltree``.

The installation does not require any external `C` libraries, the python wrapper
requires the ``Python.h`` header (which should be included in a default python
installation) and `numpy` (including ``numpy/arrayobject.h``).


Maintainers
-----------

- Jan Luca van den Busch
  (*author*, Ruhr-Universität Bochum, Astronomisches Institut)
