nlmod
=====

`nlmod` is a Python package to build, run and visualize MODFLOW 6 groundwater models in the
Netherlands. The main focus is on building models in the Netherlands using publicly
available datasets, though lots of functionality could be applied to groundwater models
elsewhere.

.. image:: _static/logo_10000_2.png
  :width: 300
  :alt: The logo of nlmod
  
.. image:: _static/logo_artesia.svg
  :width: 300
  :alt: The logo of Artesia

`nlmod` relies on the wonderful features of 
`xarray <https://docs.xarray.dev>`_ and `geopandas <https://geopandas.org>`_ for
storing and manipulating data and `flopy <https://flopy.readthedocs.io>`_ is used for
building and running groundwater models.

We thank the following institutions for their contributions to the development of nlmod:

.. image:: _static/logo_pwn.svg
  :width: 200
  :alt: The logo of PWN

.. image:: _static/logo_hhnk.svg
  :width: 200
  :alt: The logo of Hoogheemraadschap Hollands Noorderkwartier

.. image:: _static/logo_waternet.png
  :width: 200
  :alt: The logo of Waternet

.. image:: _static/logo_vitens.jpg
  :width: 200
  :alt: The logo of Vitens

.. image:: _static/logo_evides.png
  :width: 200
  :alt: The logo of Evides

.. image:: _static/logo_brabant_water.svg
  :width: 200
  :alt: The logo of Brabant Water


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

   Getting Started <getting_started>
   Data Sources <data_sources>
   Example Models <examples>
   Utilities <utilities>
   Workflows <workflows>
   Advanced Stress Packages <advanced_stress_packages>
   API-docs <modules>


Indices and tables
==================

* :ref:`genindex`