TessPy
TessPy: a python package for geographical tessellation - Published in JOSS (2022)
Science Score: 93.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in JOSS metadata -
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Basic Info
- Host: GitHub
- Owner: siavash-saki
- License: bsd-3-clause
- Language: Python
- Default Branch: main
- Size: 151 MB
Statistics
- Stars: 35
- Watchers: 3
- Forks: 6
- Open Issues: 10
- Releases: 2
Metadata Files
README.md
tesspy
tesspy is a python library for geographical tessellation.
The process of discretization of space into subspaces without overlaps and gaps is called tessellation and is of interest to researchers in the field of spatial analysis. Tessellation is essential in understanding geographical space and provides a framework for analyzing geospatial data. Different tessellation methods are implemented in tesspy. They can be divided into two groups. The first group is regular tessellation methods: square grid and hexagon grid. The second group is irregular tessellation methods based on geospatial data. These methods are adaptive squares, Voronoi diagrams, and city blocks. The geospatial data used for tessellation is retrieved from the OpenStreetMap database.
Installation
You can install tesspy from PyPI using pip (Not Recommended):
pip install tesspy
and from conda (Recommended):
conda install -c conda-forge tesspy
Creating a new environment for tesspy
tesspy depends on geopandas, which could make the installation sometimes tricky because of the conflicts with the current packages. Therefore, we recommend creating a new clean environment and installing the dependencies from the conda-forge channel.
Create a new environment:
shell
conda create -n tesspy_env -c conda-forge
Activate this environment:
shell
conda activate tesspy_env
Install tesspy from conda-forge channel:
shell
conda install -c conda-forge tesspy
Install from the repository
If you want to work with the latest development version, you can directly install it from GitHub. To do that, it is recommended to first install all the dependencies using conda. (preferably in a newly created env).
shell
conda install -c conda-forge geopandas scipy h3-py osmnx hdbscan mercantile scikit-learn
Then install TessPy using:
shell
pip install git+git://github.com/siavash-saki/tesspy
Dependencies
tesspy's dependencies are: geopandas, scipy, h3-py, osmnx, hdbscan, mercantile, and scikit-learn.
Documentation
The official documentation is hosted on ReadTheDocs.
Examples
The city of "Frankfurt am Main" in Germany is used to showcase different tessellation methods. This is how a tessellation object is built, and different methods are called. For the tessellation methods based on Points of Interests (adaptive squares, Voronoi polygons, and City Blocks), we use amenity data from the OpenStreetMap.
python
from tesspy import Tessellation
ffm= Tessellation('Frankfurt am Main')
Squares
python
ffm_sqruares = ffm.squares(resolution=15)
Hexagons
python
ffm_hex_8 = ffm.hexagons(resolution=8)
Adaptive Squares
python
ffm_asq = ffm.adaptive_squares(start_resolution=14, threshold=100, poi_categories=['amenity'])
Voronoi Polygons
python
ffm_voronoi = ffm.voronoi(poi_categories=['amenity'], n_polygons=500)
City Blocks
python
ffm_city_blocks = ffm.city_blocks(n_polygons=500)
Contributing to tesspy
All kind of contributions are welcome: * Improvement of code with new features, bug fixes, and bug reports * Improvement of documentation * Additional tests
Follow the instructions here for submitting a PR.
If you have any ideas or questions, feel free to open an issue.
Acknowledgements
tesspy is the result of the research project ClusterMobil conducted by the Research Lab for Urban Transport. This research project is funded by the state of Hesse and HOLM funding under the Innovations in Logistics and Mobility measure of the Hessian Ministry of Economics, Energy, Transport and Housing. [HA Project No.: 1017/21-19]
JOSS Publication
TessPy: a python package for geographical tessellation
Authors
Frankfurt University of Applied Sciences, Frankfurt am Main, Germany, Research Lab for Urban Transport, Frankfurt am Main, Germany
Frankfurt University of Applied Sciences, Frankfurt am Main, Germany, Research Lab for Urban Transport, Frankfurt am Main, Germany
Frankfurt University of Applied Sciences, Frankfurt am Main, Germany, Research Lab for Urban Transport, Frankfurt am Main, Germany
Editor
Martin Fleischmann
Tags
Tessellation Urban Computing OpenStreetMap City SegmentationGitHub Events
Total
- Watch event: 5
Last Year
- Watch event: 5
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| siavash-saki | s****i@e****m | 178 |
| JoHamann | 9****n | 73 |
| Siavash Saki | 5****i | 44 |
| James Gaboardi | j****i@g****m | 4 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 25
- Total pull requests: 36
- Average time to close issues: 23 days
- Average time to close pull requests: about 2 hours
- Total issue authors: 9
- Total pull request authors: 5
- Average comments per issue: 0.68
- Average comments per pull request: 0.19
- Merged pull requests: 27
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 0.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jGaboardi (11)
- siavash-saki (4)
- Zeroto521 (3)
- yannikw0 (2)
- dakoyaki (1)
- andredaa (1)
- jose-vines-toteat (1)
- BenjMy (1)
- ysig (1)
Pull Request Authors
- siavash-saki (28)
- JoHamann (3)
- yannikw0 (2)
- jGaboardi (2)
- ValentinMaftei (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 314 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 10
- Total maintainers: 1
pypi.org: tesspy
Tessellation of Urban Areas
- Homepage: https://github.com/siavash-saki/tesspy
- Documentation: https://tesspy.readthedocs.io/
- License: BSD License
-
Latest release: 0.1.2
published over 3 years ago
Rankings
Maintainers (1)
conda-forge.org: tesspy
- Homepage: https://github.com/siavash-saki/tesspy
- License: BSD-3-Clause
-
Latest release: 0.1.2
published over 3 years ago
Rankings
Dependencies
- actions/checkout v2 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/checkout v2 composite
- codecov/codecov-action v2 composite
- conda-incubator/setup-miniconda v2 composite
- psf/black stable composite
- contextily *
- esda *
- geopandas =0.10
- h3-py *
- hdbscan *
- libpysal *
- mercantile *
- osmnx *
- scikit-learn *
- scipy *
- seaborn *
- statsmodels *
- ipykernel *
- ipython *
- nbsphinx *
- sphinx_rtd_theme *