Plans for Examples and Tests

[dbrakenhoff]

This is in addition to any other open issues w.r.t. examples and tests.

• Examples restructuring
  • Move caching notebook to developers section (and make developers section on docs)
  • Implement Ruben proposal in Excel
• Tests
  • Datasources in separate CI step (badges per source?!)
  • Notebooks in CI step, upload artifacts to RTD
  • Fixtures!
  • Coverage goal 70%

[rubencalje]

The proposal in Excel to restucture examples in our readthedocs-page that @dbrakenhoff is referring to :

examples.xlsx

It is a few months old, so maybe not fully up to date.

[rubencalje]

I made a start in PR #525 . I have edited the excel-file a bit to represent current changes. Below is the contents:

	Notebook	Section	separate notebook?	New?
Datas sources	Using information from GeoTOP
	Downloading meteorological data
Example models	Building a groundwater model from scratch	Create a model dataset
		Add wells and river
		Run model
		Plot heads
	Schoonhoven	Generating layer model
		Refining layer model
		Retrieving surface water data	?
		Run model
		Calculate and plot GxG
		Particle tracking	?
		Compare with measured heads from BRO	?
	Transport model along the coast	Generating layer model
		Retrieving surface water data
		Adding transport parameters
		Run model
		Plot movie of concentration
Utilities (try to use data from example models)	Layer methods	Split layers
		Combine layers
		Set new model top
		Set layer top
		Set layer bottom
		Set layer thickness
		Set minimum layer thickness
		Calculate thickness, transmissivity and resistance
	Caching
	Gridding vector data
	Resampling raster data
	Exporting model data to GIS	Export griddata
		Export vector data
	Plot methods	Maps
		Cross-sections
		Timeseries
Workflows	Working with grid rotation
	Generating model datasets
	Aggregating surface water data
	Comparing modelled heads to observations
	Particle Tracking with PRT
	Voronoi Example
Advanced stress packages	Unsaturated zone flow modelling
	Using the lake package