Merge branch 'master' of github.com:pysal/pointpats

README.md

@@ -0,0 +1,64 @@
+---
+pointpats: Point Pattern Analysis in PySAL
+---
+
+[![image](https://api.travis-ci.org/pysal/pointpats.svg)](https://travis-ci.org/pysal/pointpats)
+
+[![Documentation Status](https://readthedocs.org/projects/pointpats/badge/?version=latest)](https://pointpats.readthedocs.io/en/latest/?badge=latest)
+
+[![image](https://badge.fury.io/py/pointpats.svg)](https://badge.fury.io/py/pointpats)
+
+Statistical analysis of planar point patterns.
+
+This package is part of a [refactoring of PySAL](https://github.com/pysal/pysal/wiki/PEP-13:-Refactor-PySAL-Using-Submodules).
+
+Introduction
+============
+
+This [pointpats](https://github.com/pysal/pointpats) package is intended
+to support the statistical analysis of planar point patterns.
+
+It currently works on cartesian coordinates. Users with data in
+geographic coordinates need to project their data prior to using this
+module.
+
+Documentation
+=============
+
+Online documentation is available
+[here](https://pointpats.readthedocs.io).
+
+Examples
+========
+
+-   [Basic point pattern
+    structure](https://github.com/pysal/pointpats/tree/master/notebooks/pointpattern.ipynb)
+-   [Centrography and
+    visualization](https://github.com/pysal/pointpats/tree/master/notebooks/centrography.ipynb)
+-   [Marks](https://github.com/pysal/pointpats/tree/master/notebooks/marks.ipynb)
+-   [Simulation of point
+    processes](https://github.com/pysal/pointpats/tree/master/notebooks/process.ipynb)
+-   [Distance based
+    statistics](https://github.com/pysal/pointpats/tree/master/notebooks/distance_statistics.ipynb)
+
+Installation
+============
+
+Install pointpats by running:
+
+    $ pip install pointpats
+
+Development
+===========
+
+pointpats development is hosted on
+[github](https://github.com/pysal/pointpats).
+
+As part of the PySAL project, pointpats development follows these
+[guidelines](http://pysal.readthedocs.io/en/latest/developers/index.html).
+
+Bug reports
+===========
+
+To search for or report bugs, please see pointpats'
+[issues](https://github.com/pysal/pointpats/issues).