Thanks to visit codestin.com
Credit goes to github.com

Skip to content

add README.md to resolve issue #24 #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
darribas merged 1 commit into from
Dec 28, 2018
Merged

add README.md to resolve issue #24 #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).
3 changes: 2 additions & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
with open('pointpats/__init__.py', 'r') as f:
exec(f.readline())

with open('README.rst', 'r', encoding='utf8') as file:
with open('README.md', 'r', encoding='utf-8') as file:
long_description = file.read()

def _get_requirements_from_files(groups_files):
Expand Down Expand Up @@ -40,6 +40,7 @@ def setup_package():
version=__version__,
description='Methods and Functions for planar point pattern analysis',
long_description = long_description,
long_description_content_type='text/markdown',
url='https://github.com/pysal/pointpats',
maintainer='Hu Shao',
maintainer_email='[email protected]',
Expand Down