| Name | map-nl JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | https://github.com/fpgmaas/map-nl |
| Summary | Quickly create maps of the Netherlands in Python |
| upload_time | 2023-12-04 06:44:02 |
| maintainer | |
| docs_url | None |
| author | Florian Maas |
| requires_python | >=3.9,<3.12 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center" style="margin: 30px 30px 40px 30px;">
<img alt="map nl" height="150" src="https://github.com/fpgmaas/map-nl/blob/main/docs/static/nl.png?raw=true">
</p>
# map-nl
[](https://img.shields.io/github/v/release/fpgmaas/map-nl)
[](https://github.com/fpgmaas/map-nl/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/fpgmaas/map-nl)
[](https://img.shields.io/github/commit-activity/m/fpgmaas/map-nl)
[](https://img.shields.io/github/license/fpgmaas/map-nl)
_map-nl_ is a Python package to help you quickly create [PC4](https://www.cbs.nl/nl-nl/dossier/nederland-regionaal/geografische-data/gegevens-per-postcode) maps of the Netherlands, i.e. maps based on the numerical part of Dutch postal codes. While that is already possible without _map-nl_, this package aims to make the process a lot easier. It automatically downloads the geojson files, so all you need to provide is a dataset with two columns: One containing PC4 codes and one with a related value to plot on the map. _map-nl_ then uses [folium](https://github.com/python-visualization/folium) to plot the map.
For an example map created with _map-nl_, see [here](https://fpgmaas.github.io/map-nl/static/choropleth.html).
---
<p align="center">
<a href="https://fpgmaas.github.io/map-nl">Documentation</a> - <a href="https://fpgmaas.github.io/map-nl/contributing/">Contributing</a>
</p>
---
## Quickstart
### Installation
To install _map-nl_, simply run:
```shell
pip install map-nl
```
or a similar command for your dependency manager.
### Usage
To create a choropleth map of the average WOZ-value in the Netherlands, you could run the following:
```py
import pandas as pd
from map_nl import ChoroplethMapNL
df = pd.read_csv("https://raw.githubusercontent.com/fpgmaas/map-nl/main/data/woz-pc4.csv")
m = ChoroplethMapNL(geojson_simplify_tolerance=0.0001).plot(
df, pc4_column_name="pc4", value_column_name="WOZ", legend_name="Average WOZ Value"
)
m.save("map.html")
```
This will download the geojson file to the `.map_nl` directory, simplify the geojson file to reduce the disk size of the plot, plot the map and save it to disk.
For more details, see [the documentation](https://fpgmaas.github.io/map-nl).
### Attribution & License
By default, a geojson file with PC4 polygons is downloaded from [Opendatasoft.com](https://public.opendatasoft.com/explore/dataset/georef-netherlands-postcode-pc4/information/). The file is provided by Central Bureau voor de Statistiek & Basisregistratie Kadaster and usage of this file falls under the [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) license.
---
Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).
Icon created by <a href="https://www.flaticon.com/free-icons/holland" title="holland icons">Roundicons - Flaticon</a>
Raw data
{
"_id": null,
"home_page": "https://github.com/fpgmaas/map-nl",
"name": "map-nl",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<3.12",
"maintainer_email": "",
"keywords": "",
"author": "Florian Maas",
"author_email": "ffpgmaas@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/25/1c/72261c8b8ce1c19970d54fd6095fec54669b4796dfd3b30014425fe5e1b8/map_nl-0.1.0.tar.gz",
"platform": null,
"description": "<p align=\"center\" style=\"margin: 30px 30px 40px 30px;\">\n <img alt=\"map nl\" height=\"150\" src=\"https://github.com/fpgmaas/map-nl/blob/main/docs/static/nl.png?raw=true\">\n</p>\n\n# map-nl\n\n[](https://img.shields.io/github/v/release/fpgmaas/map-nl)\n[](https://github.com/fpgmaas/map-nl/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/fpgmaas/map-nl)\n[](https://img.shields.io/github/commit-activity/m/fpgmaas/map-nl)\n[](https://img.shields.io/github/license/fpgmaas/map-nl)\n\n_map-nl_ is a Python package to help you quickly create [PC4](https://www.cbs.nl/nl-nl/dossier/nederland-regionaal/geografische-data/gegevens-per-postcode) maps of the Netherlands, i.e. maps based on the numerical part of Dutch postal codes. While that is already possible without _map-nl_, this package aims to make the process a lot easier. It automatically downloads the geojson files, so all you need to provide is a dataset with two columns: One containing PC4 codes and one with a related value to plot on the map. _map-nl_ then uses [folium](https://github.com/python-visualization/folium) to plot the map.\n\nFor an example map created with _map-nl_, see [here](https://fpgmaas.github.io/map-nl/static/choropleth.html).\n\n---\n\n<p align=\"center\">\n <a href=\"https://fpgmaas.github.io/map-nl\">Documentation</a> - <a href=\"https://fpgmaas.github.io/map-nl/contributing/\">Contributing</a>\n</p>\n\n---\n\n## Quickstart\n\n### Installation\n\nTo install _map-nl_, simply run:\n\n```shell\npip install map-nl\n```\n\nor a similar command for your dependency manager.\n\n### Usage\n\nTo create a choropleth map of the average WOZ-value in the Netherlands, you could run the following:\n\n```py\nimport pandas as pd\nfrom map_nl import ChoroplethMapNL\n\ndf = pd.read_csv(\"https://raw.githubusercontent.com/fpgmaas/map-nl/main/data/woz-pc4.csv\")\n\nm = ChoroplethMapNL(geojson_simplify_tolerance=0.0001).plot(\n df, pc4_column_name=\"pc4\", value_column_name=\"WOZ\", legend_name=\"Average WOZ Value\"\n)\nm.save(\"map.html\")\n```\n\nThis will download the geojson file to the `.map_nl` directory, simplify the geojson file to reduce the disk size of the plot, plot the map and save it to disk.\n\nFor more details, see [the documentation](https://fpgmaas.github.io/map-nl).\n\n### Attribution & License\n\nBy default, a geojson file with PC4 polygons is downloaded from [Opendatasoft.com](https://public.opendatasoft.com/explore/dataset/georef-netherlands-postcode-pc4/information/). The file is provided by Central Bureau voor de Statistiek & Basisregistratie Kadaster and usage of this file falls under the [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) license.\n\n---\n\nRepository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).\n\nIcon created by <a href=\"https://www.flaticon.com/free-icons/holland\" title=\"holland icons\">Roundicons - Flaticon</a>\n",
"bugtrack_url": null,
"license": "",
"summary": "Quickly create maps of the Netherlands in Python",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://fpgmaas.github.io/map-nl/",
"Homepage": "https://github.com/fpgmaas/map-nl",
"Repository": "https://github.com/fpgmaas/map-nl"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "18918b411ddc5bda5bd8179a0605ca36ff1ef5fea799517b3683885e49849592",
"md5": "2a42737b7b3853b12ba7446a48a42414",
"sha256": "6c115aad91312fb1221d373638f8d1f6a5cbd4e3c6e694cff838d86b8c4c692a"
},
"downloads": -1,
"filename": "map_nl-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a42737b7b3853b12ba7446a48a42414",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.12",
"size": 11608,
"upload_time": "2023-12-04T06:44:01",
"upload_time_iso_8601": "2023-12-04T06:44:01.649457Z",
"url": "https://files.pythonhosted.org/packages/18/91/8b411ddc5bda5bd8179a0605ca36ff1ef5fea799517b3683885e49849592/map_nl-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "251c72261c8b8ce1c19970d54fd6095fec54669b4796dfd3b30014425fe5e1b8",
"md5": "19d77641053cb25fad4dc2c68fc9ae79",
"sha256": "73500b579eb7fbb5c1d09995baf29f3a02ff74ee14e6535d6e3ebeba1f6d0c70"
},
"downloads": -1,
"filename": "map_nl-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "19d77641053cb25fad4dc2c68fc9ae79",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.12",
"size": 9850,
"upload_time": "2023-12-04T06:44:02",
"upload_time_iso_8601": "2023-12-04T06:44:02.670431Z",
"url": "https://files.pythonhosted.org/packages/25/1c/72261c8b8ce1c19970d54fd6095fec54669b4796dfd3b30014425fe5e1b8/map_nl-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-04 06:44:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fpgmaas",
"github_project": "map-nl",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "map-nl"
}
