Welcome to pydov’s documentation!

https://travis-ci.org/DOV-Vlaanderen/pydov.svg?branch=master https://ci.appveyor.com/api/projects/status/4ljy2a0p661v3d9k/branch/master?svg=true Documentation Status https://coveralls.io/repos/github/DOV-Vlaanderen/pydov/badge.svg?branch=master https://zenodo.org/badge/DOI/10.5281/zenodo.2788681.svg

A Python package to query and download data from Databank Ondergrond Vlaanderen (DOV).

Introduction

The pydov package is a community effort and everyone is welcome to contribute. It is hosted on GitHub 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, whereas the focus of this package is to support machine-based extraction and conversion of the data. The pacakge aims to support a set of complementary use cases, for example:

  • integrate DOV data in larger data processing pipelines
  • support the reproducibility and/or repeatability of research studies
  • integrate the data in third-party applications

The machine-based availability of the data can potentially serve a diverse community of researchers, consultants, modelers, and students. As performant and proper functioning of DOV data processing is of interest to the variety of users, we believe that a community-based effort to develop and maintain these functionalities as an open source package provides the optimal development traject.

Please note that downloading DOV data with pydov is governed by the same disclaimer that applies to the other DOV services. Be sure to consult it when using DOV data with pydov.

Getting started

After Installation, check the Quick start instructions for a first introduction of the pydov functionalities. For a more in-depth overview of the capabilities, the Tutorials illustrate different capabilities of the pydov package for each of the object types (GrondwaterFilterSearch, BoringSearch and the interpretations derived from InformeleStratigrafieSearch).

The setup of appropriate queries on attribute or location is similar for the different data types and crucial to get acces to the required data. The Query on attribute properties and Query on location explain the query options for attributes and locations respectively.

All functionalities are build on top of the existing webservices provided by DOV. For more details about these services and endpoints, check the Accessing DOV data page.

Indices and tables