| Name | hexcover JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | |
| Summary | Given a centroid and side length, tile an area with regular flat hexagons |
| upload_time | 2023-10-02 11:52:38 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | # Blue Oak Model License Version 1.0.0 ## Purpose This license gives everyone as much permission to work with this software as possible, while protecting contributors from liability. ## Acceptance In order to receive this license, you must agree to its rules. The rules of this license are both obligations under that agreement and conditions to your license. You must not do anything with this software that triggers a rule that you cannot or will not follow. ## Copyright Each contributor licenses you to do everything with this software that would otherwise infringe that contributor's copyright in it. ## Notices You must ensure that everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license or a link to <https://blueoakcouncil.org/license/1.0.0>. ## Excuse If anyone notifies you in writing that you have not complied with [Notices](#notices), you can keep your license by taking all practical steps to comply within 30 days after the notice. If you do not do so, your license ends immediately. ## Patent Each contributor licenses you to do everything with this software that would otherwise infringe any patent claims they can license or become able to license. ## Reliability No contributor can revoke this license. ## No Liability ***As far as the law allows, this software comes as is, without any warranty or condition, and no contributor will be liable to anyone for any damages related to this software or this license, under any kind of legal claim.*** |
| keywords |
geo
telecoms
hexagon
gis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Hexcover
A utility package which calculates a regular hexagonal tiling for an area, given a centroid as a Shapely [Point](https://shapely.readthedocs.io/en/latest/manual.html#Point), and a side length.
# Installation
`Hexcover` is available on PyPI:
`pip install hexcover`
# Usage
```python
from shapely.geometry import Point
from hexcover.util import hexagon_coverage
# centroid
c = Point(0.0, 0.0)
coverage = hexagon_coverage(c, 10)
# coverage is a namedtuple of seven polygons. The first entry is the central polygon.
# Subsequent entries begin directly above the central polygon, and proceed clockwise.
```
The returned `namedtuple` has seven fields:
- `centre`
- `top`
- `topright`
- `bottomright`
- `bottom`
- `bottomleft`
- `topleft`
## Examples
There's an example [notebook](hexcover.ipynb), and a sample output [GeoJSON file](coverage.geojson) showing the result of covering the [Crystal Palace Transmitting Station](https://en.wikipedia.org/wiki/Crystal_Palace_transmitting_station) with 100-metre hexagons.
# Input Coordinates
A **projected** coordinate system must be used. Don't give input in e.g. WGS84
# Requirements
`Shapely` >= 1.6.3
# License
[The Blue Oak Model License 1.0](LICENSE.md)
# DOI
[](https://zenodo.org/badge/latestdoi/194419900)
Raw data
{
"_id": null,
"home_page": "",
"name": "hexcover",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Geo,Telecoms,Hexagon,GIS",
"author": "",
"author_email": "Stephan H\u00fcgel <urschrei@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d1/ca/22c01a2bf8404fe481844bd158b02ae8a3e4a7fb565cc272a49ba80035f5/hexcover-0.6.0.tar.gz",
"platform": null,
"description": "# Hexcover\nA utility package which calculates a regular hexagonal tiling for an area, given a centroid as a Shapely [Point](https://shapely.readthedocs.io/en/latest/manual.html#Point), and a side length.\n\n# Installation\n`Hexcover` is available on PyPI: \n`pip install hexcover`\n\n# Usage\n```python\n\nfrom shapely.geometry import Point\nfrom hexcover.util import hexagon_coverage\n\n# centroid\nc = Point(0.0, 0.0)\ncoverage = hexagon_coverage(c, 10)\n\n# coverage is a namedtuple of seven polygons. The first entry is the central polygon.\n# Subsequent entries begin directly above the central polygon, and proceed clockwise.\n```\nThe returned `namedtuple` has seven fields:\n\n- `centre`\n- `top`\n- `topright`\n- `bottomright`\n- `bottom`\n- `bottomleft`\n- `topleft`\n\n## Examples\nThere's an example [notebook](hexcover.ipynb), and a sample output [GeoJSON file](coverage.geojson) showing the result of covering the [Crystal Palace Transmitting Station](https://en.wikipedia.org/wiki/Crystal_Palace_transmitting_station) with 100-metre hexagons.\n\n# Input Coordinates\nA **projected** coordinate system must be used. Don't give input in e.g. WGS84\n\n# Requirements\n`Shapely` >= 1.6.3\n\n# License\n[The Blue Oak Model License 1.0](LICENSE.md)\n\n# DOI\n[](https://zenodo.org/badge/latestdoi/194419900)\n",
"bugtrack_url": null,
"license": "# Blue Oak Model License Version 1.0.0 ## Purpose This license gives everyone as much permission to work with this software as possible, while protecting contributors from liability. ## Acceptance In order to receive this license, you must agree to its rules. The rules of this license are both obligations under that agreement and conditions to your license. You must not do anything with this software that triggers a rule that you cannot or will not follow. ## Copyright Each contributor licenses you to do everything with this software that would otherwise infringe that contributor's copyright in it. ## Notices You must ensure that everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license or a link to <https://blueoakcouncil.org/license/1.0.0>. ## Excuse If anyone notifies you in writing that you have not complied with [Notices](#notices), you can keep your license by taking all practical steps to comply within 30 days after the notice. If you do not do so, your license ends immediately. ## Patent Each contributor licenses you to do everything with this software that would otherwise infringe any patent claims they can license or become able to license. ## Reliability No contributor can revoke this license. ## No Liability ***As far as the law allows, this software comes as is, without any warranty or condition, and no contributor will be liable to anyone for any damages related to this software or this license, under any kind of legal claim.*** ",
"summary": "Given a centroid and side length, tile an area with regular flat hexagons",
"version": "0.6.0",
"project_urls": {
"Repository": "https://github.com/urschrei/hexcover",
"Tracker": "https://github.com/urschrei/hexcover/issues"
},
"split_keywords": [
"geo",
"telecoms",
"hexagon",
"gis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9c61b2d3a28ae65e8fb909a3ce174063a32465a172958b6447bc39425a9dd79f",
"md5": "4c3a236b4e34ed2133c6f9c9f7d29f86",
"sha256": "3a9060eacde3904e634ab64ab91146e266bbe24262bcf02d5828f11e648327e0"
},
"downloads": -1,
"filename": "hexcover-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c3a236b4e34ed2133c6f9c9f7d29f86",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5118,
"upload_time": "2023-10-02T11:52:37",
"upload_time_iso_8601": "2023-10-02T11:52:37.553111Z",
"url": "https://files.pythonhosted.org/packages/9c/61/b2d3a28ae65e8fb909a3ce174063a32465a172958b6447bc39425a9dd79f/hexcover-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d1ca22c01a2bf8404fe481844bd158b02ae8a3e4a7fb565cc272a49ba80035f5",
"md5": "ac34b30c7880cba16de45a623d2aa66d",
"sha256": "4ec4dd9cde5c202b1e0c9c705ab30f2a971e3e3eb5dc8047d3d0f7d432bba5ce"
},
"downloads": -1,
"filename": "hexcover-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "ac34b30c7880cba16de45a623d2aa66d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11302,
"upload_time": "2023-10-02T11:52:38",
"upload_time_iso_8601": "2023-10-02T11:52:38.725372Z",
"url": "https://files.pythonhosted.org/packages/d1/ca/22c01a2bf8404fe481844bd158b02ae8a3e4a7fb565cc272a49ba80035f5/hexcover-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-02 11:52:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "urschrei",
"github_project": "hexcover",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hexcover"
}
