Metadata-Version: 2.1
Name: proximity
Version: 0.2.0
Summary: Simple scenegraph for quickly debugging 3D meshes, polylines, and points
Home-page: https://github.com/lace/proximity
Author: Michael Dawson-Haggerty, Metabolize, Minnow Software, and other contributors
Author-email: github@paulmelnikow.com
License: UNKNOWN
Project-URL: Issue Tracker, https://github.com/lace/proximity/issues
Project-URL: Documentation, https://proximity.readthedocs.io/en/stable/
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Manufacturing
Classifier: Topic :: Artistic Software
Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: polliwog (==1.0.0b10)
Requires-Dist: rtree (==0.9.1)
Requires-Dist: vg (<2.0.0,>=1.7.0)

# proximity

[![version](https://img.shields.io/pypi/v/proximity?style=flat-square)][pypi]
[![python versions](https://img.shields.io/pypi/pyversions/proximity?style=flat-square)][pypi]
[![license](https://img.shields.io/pypi/l/proximity?style=flat-square)][pypi]
[![coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?style=flat-square)][coverage]
[![build](https://img.shields.io/circleci/project/github/lace/proximity/master?style=flat-square)][build]
[![code style](https://img.shields.io/badge/code%20style-black-black?style=flat-square)][black]

Mesh proximity queries based on [libspatialindex][] and [rtree][], extracted
from [Trimesh][].

[pypi]: https://pypi.org/project/proximity/
[coverage]: https://github.com/lace/proximity/blob/master/.coveragerc#L2
[build]: https://circleci.com/gh/lace/proximity/tree/master
[docs build]: https://proximity.readthedocs.io/en/latest/
[black]: https://black.readthedocs.io/en/stable/
[libspatialindex]: https://libspatialindex.org/
[rtree]: https://toblerity.org/rtree/
[trimesh]: https://trimsh.org/

## Installation

Requires [libspatialindex][].

### Mac OS

```sh
brew install spatialindex
```

### Ubuntu

```sh
apt-get install libspatialindex-dev
```

## Contribute

- Issue Tracker: https://github.com/lace/proximity/issues
- Source Code: https://github.com/lace/proximity

Pull requests welcome!


## Support

If you are having issues, please let us know.


## Acknowledgements

This code was extracted from [Trimesh][] by [Michael Dawson-Haggerty][mikedh].

[mikedh]: https://github.com/mikedh


## License

The project is licensed under the MIT license.


