brodata Documentation
=====================

**brodata** is a Python package for downloading and processing subsurface data from **DINO** and **BRO**.

The "**Basisregistratie Ondergrond**" (BRO) is the Dutch national database for subsurface data, maintained by **TNO Geological Survey of the Netherlands**, on behalf of the Dutch government. The growing database is accessible via web services that provides data in XML format. The **brodata** package simplifies the process of querying, downloading, and processing this data.

**brodata** is build and maintained by the private company **Artesia**. The source-code is available on `GitHub <https://github.com/ArtesiaWater/brodata>`__, where users can post issues or suggest improvements. In the summer of 2025, the "**ministerie van Volkshuisvesting en Ruimtelijke Ordening**" (VRO) made a one-time donation to improve the documentation of this package.

.. raw:: html

    <div align="center" style="display: flex; gap: 40px; justify-content: center;">

.. image:: _static/logo_bro.jpg
    :width: 200
    :alt: The logo of the BRO
    :target: https://basisregistratieondergrond.nl/

.. image:: _static/logo_rijksoverheid.svg
    :width: 200
    :alt: The logo of the Rijksoverheid
    :target: https://www.rijksoverheid.nl/ministeries/ministerie-van-volkshuisvesting-en-ruimtelijke-ordening

.. raw:: html

    </div>

Installation
------------

You can install the package using `pip` from `PyPI <https://pypi.org/project/brodata/>`__:

.. code-block:: shell

    pip install brodata

About This Documentation
------------------------

This website serves as the documentation for the **brodata** package. Use the menu below or on the left to navigate through the following sections:

- **Package** – General information about the package setup.
- **BRO-domains** – Demonstrations of how to use the package, splitted into the 5 supported BRO-domains (the 6th domain, Models and maps, is not supported). This section demonstrates for example how to download groundwater time-series and drilling data, and how to visualize them.
- **DINO Data** – Demonstrations of how to use the package for DINO data.
- **API Docs** – Detailed documentation of classes and methods available in **brodata**, also accessible via your Python interpreter.

Contents
--------

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   Package <package>
   Groundwater Monitoring <groundwater_monitoring>
   Subsurface Research <subsurface_research>
   Groundwater Use <groundwater_use>
   Mining Act <mining_act>
   Site Quality <site_quality>
   DINO Data <dino_data>
   API Docs <modules>

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`