<h1 align="left">networkh3</h1>
<p>
<img alt="Version" src="https://img.shields.io/badge/version-0.0.5-blue.svg?cacheSeconds=2592000" />
<a href="#" target="_blank">
<img alt="License: MIT License" src="https://img.shields.io/badge/License-MIT License-yellow.svg" />
</a>
</p>
<p>A package to return clipped H3 hexagons from the extent of an OSMnx network. Useful for anyone looking to use the H3 spatial indexing system in route analyses or spatial analyses, and for saving time sourcing H3 hexagons.</p>
## Examples
<p>
<img src="https://raw.githubusercontent.com/callumscoby/networkh3/main/images/london_example.png" height="258px"/>
<img src="https://raw.githubusercontent.com/callumscoby/networkh3/main/images/washington_example.png" height="258px" />
<p>(L-R): London, Washington DC</p></p>
<p>Example workflows are available in the <a href="https://github.com/callumscoby/networkh3">Github</a> repository.</p>
## Install
Install the latest version from PyPI:
```sh
pip install networkh3
```
## Import
```sh
from networkh3 import NETWORKH3
```
## Usage
NETWORKH3 requires three parameters: the area of interest, the type of OSMNx network, and the resolution of the returned H3 hexagons:
```sh
from networkh3 import NETWORKH3
NETWORKH3.get_h3('Leeds, United Kingdom', 'drive', 9)
```
Optional style keywords can also be specified:
```sh
from networkh3 import NETWORKH3
import contextily as cx
NETWORKH3.get_h3('Leeds, United Kingdom', 'drive', 9,
network_kwargs={
'node_size': 1,
'node_color': 'black',
'edge_color': 'red',
'edge_linewidth': 0.2},
h3_kwargs={
'facecolor': 'white',
'alpha': 0.6},
basemap_kwargs={
'source': cx.providers.Stamen.TonerLite}
)
```
The network and clipped H3 hexagons can then be used in analysis:
```sh
# Calling the network
NETWORKH3.network
# Calling the clipped H3 hexagons
NETWORKH3.h3
```
## Issues and support
<p>See the <a href="https://github.com/callumscoby/networkh3">Github</a> repository to report an issue or contribute to this project.</p>
## Contact
* Website: <a href="callumscoby.com">callumscoby.com</a>
* Twitter: [@ScobyCallum](https://twitter.com/ScobyCallum)
* Github: [@callumscoby](https://github.com/callumscoby)
* LinkedIn: [@callumscoby](https://linkedin.com/in/callumscoby)
## Acknowledgements
* <p>⌇ <a href="https://github.com/gboeing/osmnx">OSMnx</a></p>
* <p>🗺 <a href="https://github.com/uber/h3">H3</a></p>
Raw data
{
"_id": null,
"home_page": "https://github.com/callumscoby/networkh3",
"name": "networkh3",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "OSMnx,H3,Routing,Network analysis",
"author": "Callum Scoby",
"author_email": "callumjamesscoby@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b1/fa/d0226cc0821097c56e2e16d43f08c6a53b71d910861535059cd69c481262/networkh3-0.0.5.tar.gz",
"platform": null,
"description": "<h1 align=\"left\">networkh3</h1>\n<p>\n <img alt=\"Version\" src=\"https://img.shields.io/badge/version-0.0.5-blue.svg?cacheSeconds=2592000\" />\n <a href=\"#\" target=\"_blank\">\n <img alt=\"License: MIT License\" src=\"https://img.shields.io/badge/License-MIT License-yellow.svg\" />\n </a>\n</p>\n\n<p>A package to return clipped H3 hexagons from the extent of an OSMnx network. Useful for anyone looking to use the H3 spatial indexing system in route analyses or spatial analyses, and for saving time sourcing H3 hexagons.</p>\n\n## Examples\n<p>\n<img src=\"https://raw.githubusercontent.com/callumscoby/networkh3/main/images/london_example.png\" height=\"258px\"/>\n<img src=\"https://raw.githubusercontent.com/callumscoby/networkh3/main/images/washington_example.png\" height=\"258px\" />\n\n\n<p>(L-R): London, Washington DC</p></p>\n\n<p>Example workflows are available in the <a href=\"https://github.com/callumscoby/networkh3\">Github</a> repository.</p>\n\n## Install\n\nInstall the latest version from PyPI:\n\n```sh\npip install networkh3\n```\n\n## Import\n\n```sh\nfrom networkh3 import NETWORKH3\n```\n\n## Usage\n\nNETWORKH3 requires three parameters: the area of interest, the type of OSMNx network, and the resolution of the returned H3 hexagons:\n\n```sh\nfrom networkh3 import NETWORKH3\n\nNETWORKH3.get_h3('Leeds, United Kingdom', 'drive', 9)\n```\n\nOptional style keywords can also be specified:\n\n```sh\nfrom networkh3 import NETWORKH3\nimport contextily as cx\n\nNETWORKH3.get_h3('Leeds, United Kingdom', 'drive', 9, \n network_kwargs={\n 'node_size': 1, \n 'node_color': 'black',\n 'edge_color': 'red',\n 'edge_linewidth': 0.2}, \n h3_kwargs={\n 'facecolor': 'white', \n 'alpha': 0.6}, \n basemap_kwargs={\n 'source': cx.providers.Stamen.TonerLite}\n )\n```\n\nThe network and clipped H3 hexagons can then be used in analysis:\n\n```sh\n# Calling the network\nNETWORKH3.network\n\n# Calling the clipped H3 hexagons\nNETWORKH3.h3\n```\n\n## Issues and support\n\n<p>See the <a href=\"https://github.com/callumscoby/networkh3\">Github</a> repository to report an issue or contribute to this project.</p>\n\n\n## Contact\n\n* Website: <a href=\"callumscoby.com\">callumscoby.com</a>\n* Twitter: [@ScobyCallum](https://twitter.com/ScobyCallum)\n* Github: [@callumscoby](https://github.com/callumscoby)\n* LinkedIn: [@callumscoby](https://linkedin.com/in/callumscoby)\n\n## Acknowledgements\n* <p>\u2307 <a href=\"https://github.com/gboeing/osmnx\">OSMnx</a></p>\n\n* <p>\ud83d\uddfa <a href=\"https://github.com/uber/h3\">H3</a></p>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A package to return H3 hexagons based on an OSMnx network",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/callumscoby/networkh3"
},
"split_keywords": [
"osmnx",
"h3",
"routing",
"network analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b1fad0226cc0821097c56e2e16d43f08c6a53b71d910861535059cd69c481262",
"md5": "a10dbfd573fbdf5e994c1d64bf5f136d",
"sha256": "e3e3bc4d0e635f67da198fb9e6e87880662e60605644d6bfc55d50c38d719fe9"
},
"downloads": -1,
"filename": "networkh3-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "a10dbfd573fbdf5e994c1d64bf5f136d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4247,
"upload_time": "2023-08-29T12:12:30",
"upload_time_iso_8601": "2023-08-29T12:12:30.217026Z",
"url": "https://files.pythonhosted.org/packages/b1/fa/d0226cc0821097c56e2e16d43f08c6a53b71d910861535059cd69c481262/networkh3-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-29 12:12:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "callumscoby",
"github_project": "networkh3",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "networkh3"
}
JSON
