Metadata-Version: 2.4
Name: neatnet
Version: 0.1.4
Summary: Street geometry processing toolkit
Author-email: Martin Fleischmann <martin@martinfleischmann.net>, Anastassia Vybornova <anvy@itu.dk>, "James D. Gaboardi" <jgaboardi@gmail.com>
License: BSD 3-Clause
Project-URL: Home, https://github.com/uscuni/
Project-URL: Repository, https://github.com/uscuni/neatnet
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: esda>=2.6.0
Requires-Dist: geopandas>=1.0.1
Requires-Dist: libpysal>=4.12.1
Requires-Dist: momepy>=0.9.0
Requires-Dist: networkx>=3.3
Requires-Dist: numpy>=2
Requires-Dist: pandas>=2.2.3
Requires-Dist: scipy>=1.14.1
Requires-Dist: shapely>=2.0.6
Requires-Dist: scikit-learn>=1.2.0
Provides-Extra: tests
Requires-Dist: codecov; extra == "tests"
Requires-Dist: coverage; extra == "tests"
Requires-Dist: matplotlib; extra == "tests"
Requires-Dist: mypy<2,>=1.15.0; extra == "tests"
Requires-Dist: pre-commit; extra == "tests"
Requires-Dist: pyarrow>=17.0; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-xdist; extra == "tests"
Requires-Dist: ruff; extra == "tests"
Requires-Dist: yamllint; extra == "tests"
Provides-Extra: docs
Requires-Dist: ipykernel; extra == "docs"
Requires-Dist: ipywidgets; extra == "docs"
Requires-Dist: jupyterlab; extra == "docs"
Requires-Dist: myst_nb; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
Requires-Dist: sphinx_autosummary_accessors; extra == "docs"
Requires-Dist: sphinx_book_theme; extra == "docs"
Requires-Dist: sphinx_copybutton; extra == "docs"
Provides-Extra: all
Requires-Dist: neatnet[docs,tests]; extra == "all"
Dynamic: license-file

# `neatnet`: Street Geometry Processing Toolkit

[![Continuous Integration](https://github.com/uscuni/neatnet/actions/workflows/testing.yml/badge.svg)](https://github.com/uscuni/neatnet/actions/workflows/testing.yml) [![codecov](https://codecov.io/gh/uscuni/neatnet/graph/badge.svg?token=GFISMU0WPS)](https://codecov.io/gh/uscuni/neatnet)

## Introduction

`neatnet` offers a set of tools pre-processing of street network geometry aimed at its simplification. This typically means removal of dual carrieageways, roundabouts and similar transportation-focused geometries and their replacement with a new geometry representing the street space via its centerline. The resulting geometry shall be closer to a morphological representation of space than the original source, that is typically drawn with transportation in mind (e.g. OpenStreetMap).

## Examples

```py
import neatnet

simplified = neatnet.neatify(gdf)
```

## Installing

You can install neatnet from PyPI or from conda-forge using the tool of your choice:

```sh
pip install neatnet
```

Or (recommended):

```sh
conda install neatnet -c conda-forge
```

## Contribution

While we consider the API stable, the project is young and may be evolving fast. All contributions are very welcome, see our guidelines in [`CONTRIBUTING.md`](https://github.com/uscuni/neatnet/blob/main/CONTRIBUTING.md).

## Recommended Citations

The package is a result of a scientific collaboration between [The Research Team on Urban Structure](https://uscuni.org) of Charles University (USCUNI), [NEtwoRks, Data, and Society](https://nerds.itu.dk) research group of IT University Copenhagen (NERDS) and [Oak Ridge National Laboratory](https://www.ornl.gov/gshsd).

If you use `neatnet` for a research purpose, please consider citing the original paper introducing it.

### Canonical Citation (primary)

*forthcoming*

### Repository Citation (secondary)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14765801.svg)](https://doi.org/10.5281/zenodo.14765801)

* **Fleischmann, M., Vybornova, A., & Gaboardi, J.D.** (2025). `uscuni/neatnet`. Zenodo. https://doi.org/10.5281/zenodo.14765801

## Funding

The development has been supported by the Charles University’s Primus program through the project "Influence of Socioeconomic and Cultural Factors on Urban Structure in Central Europe", project reference `PRIMUS/24/SCI/023`.

---------------------------------------

This package developed & and maintained by:
* [Martin Fleischmann](https://github.com/martinfleis)
* [Anastassia Vybornova](https://github.com/anastassiavybornova)
* [James D. Gaboardi](https://github.com/jGaboardi)


Copyright (c) 2024-, neatnet Developers
