# pydov <img src="docs/_static/img/logo.png" align="right" alt="" width="120">
 [](https://pydov.readthedocs.io/en/latest/?badge=latest) [](https://www.repostatus.org/#active) [](https://doi.org/10.5281/zenodo.2788680) [](https://github.com/pyOpenSci/software-review/issues/19)
pydov is a Python package to query and download data from [Databank Ondergrond Vlaanderen (DOV)](https://www.dov.vlaanderen.be). It is hosted on [GitHub](https://github.com/DOV-Vlaanderen/pydov) and development is coordinated by Databank Ondergrond Vlaanderen (DOV). DOV aggregates data about soil, subsoil and groundwater of Flanders and makes them publicly available. Interactive and human-readable extraction and querying of the data is provided by a [web application](https://www.dov.vlaanderen.be/portaal/?module=verkenner#ModulePage), whereas the focus of this package is to **support machine-based extraction and conversion of the data**.
To get started, see the documentation at https://pydov.readthedocs.io.
Please note that downloading DOV data with pydov is governed by the same [disclaimer](https://www.dov.vlaanderen.be/page/disclaimer) that applies to the other DOV services. Be sure to consult it when using DOV data with pydov.
## Installation
You can install `pydov` stable using pip:
```shell script
pip install pydov
```
Or clone the [git repository](https://github.com/DOV-Vlaanderen/pydov) and install with `python setup.py install` to get the latest snapshot from the master branch.
To contribute to the code, make sure to install the package and all of the development dependencies enlisted in the
[requirements_dev.txt](requirements_dev.txt) file. First, clone the [git repository](https://github.com/DOV-Vlaanderen/pydov).
We advice to use an Python development environment, for example with [conda](https://docs.conda.io/en/latest/miniconda.html) or
[virtualenv](https://virtualenv.pypa.io/en/latest/). Activate the (conda/virtualenv) environment and
install the package in development mode:
```shell script
pip install -e .[devs]
```
Need more detailed instructions? Check out the [installation instructions](https://pydov.readthedocs.io/en/stable/installation.html) and the [development guidelines](https://pydov.readthedocs.io/en/stable/development.html).
## Quick start
Read the [quick start](https://pydov.readthedocs.io/en/stable/quickstart.html) from the docs or jump straight in:
```python
from pydov.search.boring import BoringSearch
from pydov.util.location import Within, Box
from owslib.fes2 import PropertyIsGreaterThan
boringsearch = BoringSearch()
dataframe = boringsearch.search(
query=PropertyIsGreaterThan(propertyname='diepte_tot_m', literal='550'),
location=Within(Box(107500, 202000, 108500, 203000))
)
```
The resulting dataframe contains the information on boreholes (boringen) within the provided bounding box (as defined by the `location` argument)
with a depth larger than 550m:
```
>>> dataframe
pkey_boring boornummer x y mv_mtaw start_boring_mtaw gemeente diepte_boring_van diepte_boring_tot datum_aanvang uitvoerder boorgatmeting diepte_methode_van diepte_methode_tot boormethode
0 https://www.dov.vlaanderen.be/data/boring/1989... kb14d40e-B777 108015.0 202860.0 5.0 5.0 Gent 0.0 660.0 1989-01-25 onbekend False 0.0 660.0 onbekend
1 https://www.dov.vlaanderen.be/data/boring/1972... kb14d40e-B778 108090.0 202835.0 5.0 5.0 Gent 0.0 600.0 1972-05-17 onbekend False 0.0 600.0 onbekend
```
## Documentation
Full documentation of `pydov` can be found on our [ReadTheDocs page](https://pydov.readthedocs.io).
## Contributing
You do not need to be a code expert to contribute to this project as there are several ways you can contribute to
this project. Have a look at the [contributing page](https://pydov.readthedocs.io/en/latest/contributing.html).
## Meta
- We welcome [contributions](.github/CONTRIBUTING.rst) including bug reports.
- License: MIT
- Citation information can be found on [Zenodo](https://doi.org/10.5281/zenodo.2788680).
- Please note that this project is released with a [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.rst). By participating in this project you agree to abide by its terms.
- Also note that downloading DOV data with pydov is governed by the same [disclaimer](https://www.dov.vlaanderen.be/page/disclaimer) that applies to the other DOV services. Be sure to consult it when using DOV data with pydov.
Raw data
{
"_id": null,
"home_page": "https://github.com/DOV-Vlaanderen/pydov",
"name": "pydov",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pydov",
"author": "DOV-Vlaanderen",
"author_email": "dov@vlaanderen.be",
"download_url": "https://files.pythonhosted.org/packages/06/18/966f6c9d27953aa225b1f974056800567d0c84de44a28d839ac2421041a0/pydov-3.1.0.tar.gz",
"platform": null,
"description": "# pydov <img src=\"docs/_static/img/logo.png\" align=\"right\" alt=\"\" width=\"120\">\n\n [](https://pydov.readthedocs.io/en/latest/?badge=latest) [](https://www.repostatus.org/#active) [](https://doi.org/10.5281/zenodo.2788680) [](https://github.com/pyOpenSci/software-review/issues/19)\n\npydov is a Python package to query and download data from [Databank Ondergrond Vlaanderen (DOV)](https://www.dov.vlaanderen.be). It is hosted on [GitHub](https://github.com/DOV-Vlaanderen/pydov) and development is coordinated by Databank Ondergrond Vlaanderen (DOV). DOV aggregates data about soil, subsoil and groundwater of Flanders and makes them publicly available. Interactive and human-readable extraction and querying of the data is provided by a [web application](https://www.dov.vlaanderen.be/portaal/?module=verkenner#ModulePage), whereas the focus of this package is to **support machine-based extraction and conversion of the data**.\n\nTo get started, see the documentation at https://pydov.readthedocs.io.\n\nPlease note that downloading DOV data with pydov is governed by the same [disclaimer](https://www.dov.vlaanderen.be/page/disclaimer) that applies to the other DOV services. Be sure to consult it when using DOV data with pydov.\n\n## Installation\n\nYou can install `pydov` stable using pip:\n\n```shell script\npip install pydov\n```\n\nOr clone the [git repository](https://github.com/DOV-Vlaanderen/pydov) and install with `python setup.py install` to get the latest snapshot from the master branch.\n\nTo contribute to the code, make sure to install the package and all of the development dependencies enlisted in the\n[requirements_dev.txt](requirements_dev.txt) file. First, clone the [git repository](https://github.com/DOV-Vlaanderen/pydov).\nWe advice to use an Python development environment, for example with [conda](https://docs.conda.io/en/latest/miniconda.html) or\n[virtualenv](https://virtualenv.pypa.io/en/latest/). Activate the (conda/virtualenv) environment and\ninstall the package in development mode:\n\n```shell script\npip install -e .[devs]\n```\n\nNeed more detailed instructions? Check out the [installation instructions](https://pydov.readthedocs.io/en/stable/installation.html) and the [development guidelines](https://pydov.readthedocs.io/en/stable/development.html).\n\n## Quick start\n\nRead the [quick start](https://pydov.readthedocs.io/en/stable/quickstart.html) from the docs or jump straight in:\n\n```python\nfrom pydov.search.boring import BoringSearch\nfrom pydov.util.location import Within, Box\n\nfrom owslib.fes2 import PropertyIsGreaterThan\n\nboringsearch = BoringSearch()\n\ndataframe = boringsearch.search(\n query=PropertyIsGreaterThan(propertyname='diepte_tot_m', literal='550'),\n location=Within(Box(107500, 202000, 108500, 203000))\n)\n```\n\nThe resulting dataframe contains the information on boreholes (boringen) within the provided bounding box (as defined by the `location` argument)\nwith a depth larger than 550m:\n```\n>>> dataframe\n pkey_boring boornummer x y mv_mtaw start_boring_mtaw gemeente diepte_boring_van diepte_boring_tot datum_aanvang uitvoerder boorgatmeting diepte_methode_van diepte_methode_tot boormethode\n0 https://www.dov.vlaanderen.be/data/boring/1989... kb14d40e-B777 108015.0 202860.0 5.0 5.0 Gent 0.0 660.0 1989-01-25 onbekend False 0.0 660.0 onbekend\n1 https://www.dov.vlaanderen.be/data/boring/1972... kb14d40e-B778 108090.0 202835.0 5.0 5.0 Gent 0.0 600.0 1972-05-17 onbekend False 0.0 600.0 onbekend\n```\n\n\n## Documentation\n\nFull documentation of `pydov` can be found on our [ReadTheDocs page](https://pydov.readthedocs.io).\n\n## Contributing\n\nYou do not need to be a code expert to contribute to this project as there are several ways you can contribute to\nthis project. Have a look at the [contributing page](https://pydov.readthedocs.io/en/latest/contributing.html).\n\n## Meta\n\n- We welcome [contributions](.github/CONTRIBUTING.rst) including bug reports.\n- License: MIT\n- Citation information can be found on [Zenodo](https://doi.org/10.5281/zenodo.2788680).\n- Please note that this project is released with a [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.rst). By participating in this project you agree to abide by its terms.\n- Also note that downloading DOV data with pydov is governed by the same [disclaimer](https://www.dov.vlaanderen.be/page/disclaimer) that applies to the other DOV services. Be sure to consult it when using DOV data with pydov.\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A Python package to download data from Databank Ondergrond Vlaanderen (DOV).",
"version": "3.1.0",
"project_urls": {
"Homepage": "https://github.com/DOV-Vlaanderen/pydov"
},
"split_keywords": [
"pydov"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94c013ad3bc2ae213ab314bd1549b6a2c706c60b8f43eb14db9294e0aba0cccb",
"md5": "b94ba476096f6fae7021d83abd145b3e",
"sha256": "b7cdad53294d9759a1298280bc565474746e29ccee24f6ee5cda71a500512f0a"
},
"downloads": -1,
"filename": "pydov-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b94ba476096f6fae7021d83abd145b3e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 72971,
"upload_time": "2023-10-10T13:53:11",
"upload_time_iso_8601": "2023-10-10T13:53:11.583739Z",
"url": "https://files.pythonhosted.org/packages/94/c0/13ad3bc2ae213ab314bd1549b6a2c706c60b8f43eb14db9294e0aba0cccb/pydov-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0618966f6c9d27953aa225b1f974056800567d0c84de44a28d839ac2421041a0",
"md5": "1a479d6be965e4afa826675e3848ad2e",
"sha256": "a65635e07b5c88de028c8596d383c9d4cbd32803bad2cfe409ed260b0b01b38c"
},
"downloads": -1,
"filename": "pydov-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1a479d6be965e4afa826675e3848ad2e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 973551,
"upload_time": "2023-10-10T13:53:12",
"upload_time_iso_8601": "2023-10-10T13:53:12.913401Z",
"url": "https://files.pythonhosted.org/packages/06/18/966f6c9d27953aa225b1f974056800567d0c84de44a28d839ac2421041a0/pydov-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-10 13:53:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DOV-Vlaanderen",
"github_project": "pydov",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "pydov"
}
JSON
