Metadata-Version: 2.4
Name: geoplanar
Version: 0.5.0
Summary: Geographic planar enforcement of polygon geoseries
Author-email: Serge Rey <sjsrey@gmail.com>
License: 3-Clause BSD
Project-URL: Home, https://geoplanar.readthedocs.io
Project-URL: Repository, https://github.com/sjsrey/geoplanar
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: geopandas
Requires-Dist: esda
Requires-Dist: libpysal>=4.8.0
Requires-Dist: packaging
Dynamic: license-file


# geoplanar
Planar enforcement for polygon geoseries

![mexico-us](https://i.imgur.com/CFgnecL.png)

[![unittests](https://github.com/sjsrey/geoplanar/workflows/.github/workflows/unittests.yml/badge.svg)](https://github.com/sjsrey/geoplanar/actions?query=workflow%3A.github%2Fworkflows%2Funittests.yml)
|[![Documentation Status](https://readthedocs.org/projects/geoplanar/badge/?version=latest)](https://geoplanar.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/badge/382492314.svg)](https://zenodo.org/badge/latestdoi/382492314)




`geoplanar` supports the detection and correction of violations of [planar enforcement](https://ibis.geog.ubc.ca/courses/klink/gis.notes/ncgia/u12.html#SEC12.6) for polygon geoseries including:


- [gaps](https://github.com/sjsrey/geoplanar/blob/main/notebooks/gaps.ipynb)
- [nonplanar coincident edges](https://github.com/sjsrey/geoplanar/blob/main/notebooks/nonplanaredges.ipynb)
- [nonplanar touches](https://github.com/sjsrey/geoplanar/blob/main/notebooks/nonplanartouches.ipynb)
- [overlaps](https://github.com/sjsrey/geoplanar/blob/main/notebooks/overlaps.ipynb)
- [holes](https://github.com/sjsrey/geoplanar/blob/main/notebooks/holes.ipynb)


## Status

`geoplanar` is currently in alpha status and is open to contributions that help shape the scope of the package. It is being developed in support of  [research ](https://nsf.gov/awardsearch/showAward?AWD_ID=1759746&HistoricalAwards=false) and is likely to be undergoing changes as the project evolves.

## Contributing

`geoplanar` development uses a [git-flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) model. Contributions following this model are welcomed.


## Funding

`geoplanar` is partially supported by [NSF Award #1759746, Comparative Regional Inequality Dynamics: Multiscalar and Multinational Perspectives](https://nsf.gov/awardsearch/showAward?AWD_ID=1759746&HistoricalAwards=false)


