Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 1.68 KB

README.md

File metadata and controls

22 lines (14 loc) · 1.68 KB

Voronoi diagrams on the surface of a Sphere

Update: Please use scipy 0.18 (scipy.spatial.SphericalVoronoi) for performing spherical Voronoi diagram calculations in Python -- the most robust version of the code is there, while this repo mostly exists for historical reasons and may contain bugs that have been patched by the collaborative work implementing the algorithm into scipy.

Note that the most robust version of this code is now in a scipy PR: scipy/scipy#5232

Slides from PyData London 2015 presentation about this package: https://www.slideshare.net/slideshow/embed_code/key/1bKCEyHa789nBe

A Python module for obtaining Voronoi diagrams on the surfaces of spheres, including the calculation of Voronoi region surface areas. Applications may range from calculating area per lipid in spherical viruses to geographical parsing.

The documentation for the project is available here: http://py-sphere-voronoi.readthedocs.org/en/latest/voronoi_utility.html

This project is still in development and some of the algorithm weaknesses are highlighted in the above documentation.

Please cite: DOI

For contributions:

  • ensure most/all unit tests pass (run: nosetests)
  • ensure all doctests pass (run: python voronoi_utility.py)
  • if you import new modules, you may need to mock them in the Sphinx conf.py documentation file so that the docs are properly compiled by readthedocs
  • attempt to match the numpy documentation standard as closely as possible