Skip to content

Commit

Permalink
Fix logo and other documentation-bugs (#137)
Browse files Browse the repository at this point in the history
* Add logo to index.rst

* Change type to geom_type and improve docs

* Split 'resampling grid data' and 'gridding vector data' notebooks

* Remove nbsphinx_link in dependencies of the docs

* Fix sphinx rtd theme to 1.0.0, so menu functions again

* Update README.md
  • Loading branch information
rubencalje authored Jan 20, 2023
1 parent f3bb38c commit 8a8e55e
Show file tree
Hide file tree
Showing 10 changed files with 687 additions and 666 deletions.
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,12 @@
Python package with functions to process, build and visualise MODFLOW models in the Netherlands.

The functions in nlmod have four main objectives:
1. Create and adapt the temporal and spatial discretization of a MODFLOW model using an xarray Dataset. These functions are contained in `nlmod.dims`
2. Read data from external sources, project this data on the modelgrid and add this data to an xarray Dataset. These functions are contained in `nlmod.read`
3. Use data in an xarray Dataset to build modflow packages using flopy. The functions for modflow 6 packages are in `nlmod.gwf`, for modpath in `nlmod.modpath`.
4. Visualise modeldata in Python or GIS software. These functions are contained in `nlmod.plot` and `nlmod.gis`.

External data sources that can be read are:
- AHN, digital elevation model
- bgt, surface water level geometries
- Geotop, subsurface model
- Jarkus, bathymetry
- KNMI, precipitation and evaporation
- REGIS, subsurface model
- Rijkswaterstaat, surface water polygons
- multiple waterboards, surface water level data
1. Create and adapt the temporal and spatial discretization of a MODFLOW model using an xarray Dataset (`nlmod.dims`).
2. Download and read data from external sources, project this data on the modelgrid and add this data to an xarray Dataset (`nlmod.read`).
3. Use data in an xarray Dataset to build modflow packages using FloPy (`nlmod.gwf` for Modflow 6 and `nlmod.modpath` for Modpath).
4. Visualise modeldata in Python (`nlmod.plot`) or GIS software (`nlmod.gis`).

More information can be found on the documentation-website: https://nlmod.readthedocs.io/.

## Installation

Expand Down
Loading

0 comments on commit 8a8e55e

Please sign in to comment.