Skip to content

Latest commit

 

History

History
106 lines (81 loc) · 3.6 KB

index.rst

File metadata and controls

106 lines (81 loc) · 3.6 KB

Welcome to pydov's documentation!

image

Documentation Status

image

pyopensci approval

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 package 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 efficient 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 trajectory.

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 quickstart 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.

select_datasets of your interest, and check the query_attribute and query_location pages to find the information you're looking for. While the search objects are different, the workflow is the same for each dataset.

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

Contents:

installation quickstart tutorials

select_datasets query_attribute query_location output_fields sort_limit performance caching hooks repeatable_log network_proxy

contributing development endpoints reference history authors conduct

Indices and tables

  • genindex
  • modindex
  • search