Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Welcome to boxtree's documentation!
===================================
boxtree is a package that, given some point locations in two or three
dimensions, sorts them into an adaptive quad/octree of boxes, efficiently, in
parallel, using OpenCL.
Other places on the web to find boxtree stuff:
* `wiki home page <http://wiki.tiker.net/BoxTree>`_
* `source code via git <http://github.com/inducer/boxtree>`_
Now you obviously want to watch the library do something (at least mildly)
cool? Well, sit back and watch:
.. literalinclude:: ../examples/demo.py
:start-after: STARTEXAMPLE
:end-before: ENDEXAMPLE
This file is included in the :mod:`boxtree` distribution as
:file:`examples/demo.py`. With some plotting code (not shown above, but
included in the demo file), you can see what's going on:
.. image:: images/tree.png
More importantly, perhaps, than being able to draw the tree, the :class:`boxtree.Tree`
data structure is now accesible via the `tree` variable above, and the connecitivity
information needed for an FMM-like traversal is available in `trav` as
a :class:`boxtree.traversal.FMMTraversalInfo`.
Overview
--------
.. toctree::
:maxdepth: 3
reference
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`