diff --git a/README.md b/README.md index e64204d08de8090d20f1085cc6bdb543b67e5c55..cde7ffec080f84ddbd2abf36d2ffedc8cc744bb6 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ The material is organized as follows * __Exercises__: click [here](./exercises/README.md) to go to the exercise description -* __Slides__: click [here](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/index#/title-slide) to view the slides +* __Slides__: click [here](./slides/README.md) to view the slide overview * __Links__: click [here](./links/README.md) to go to a list of useful links ## Installation of the course @@ -17,8 +17,8 @@ If you plan to use Ubuntu on Windows via WSL, we have a brief [installation docu ### Install DuMu<sup>x</sup> together with the course -The easiest way to install everything you need is to use the install script `installcourse.sh`. -The script will install all needed ubuntu-packages, clone the required git repositories and build the dumux-course. +The easiest way to install everything you need is to use the install script `installcourse.sh`. +The script will install all needed ubuntu-packages, clone the required git repositories and build the dumux-course. It is also recommended to have a look inside the script, for further understanding. diff --git a/exercises/README.md b/exercises/README.md index 347b1c0643c2c573e28d9f3b74c755e285fcf852..c0815cc9428a4403f790d8f2637aa619f3a418a9 100644 --- a/exercises/README.md +++ b/exercises/README.md @@ -13,6 +13,8 @@ Based on a scenario where gas is injected into an aquifer, you learn how to * set up a non-isothermal test problem based on the isothermal test problem, * set boundary conditions. +:tv: [Lecture slides corresponding to exercise](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/problem.html#/example-application) + ### [:open_file_folder: Main file](./exercise-mainfile/README.md) In this exercise, you learn how to @@ -23,6 +25,8 @@ In this exercise, you learn how to * solve an instationary, nonlinear system, * apply analytic differentiation. +:tv: [Lecture slides corresponding to exercise](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/problem.html#/main-program-and-main-function) + ### [:open_file_folder: Runtime parameters](./exercise-runtimeparams/README.md) This exercise covers the following topics: You learn how to @@ -31,6 +35,8 @@ This exercise covers the following topics: You learn how to * set variables to collect runtime parameters, * use and change default values for runtime parameters. +:tv: [Lecture slides corresponding to exercise](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/params.html#/runtime-parameters) + ### [:open_file_folder: Grids](./exercise-grids/README.md) This exercise guides you through the following tasks: @@ -40,10 +46,14 @@ This exercise guides you through the following tasks: * apply grid zoning and grading, * read in structured and unstructured grids from external files. +:tv: [Lecture slides corresponding to exercise](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/grid.html#/grids) + ### [:open_file_folder: Properties](./exercise-properties/README.md) In this exercise, you learn how to adjust the properties in order to use a customized local residual. +:tv: [Lecture slides corresponding to exercise](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/properties.html#/title-slide) + ### [:open_file_folder: Fluid systems](./exercise-fluidsystem/README.md) This exercise covers the handling of phases and components in DuMu<sup>x</sup>. You learn @@ -52,6 +62,8 @@ This exercise covers the handling of phases and components in DuMu<sup>x</sup>. * how to implement a new fluidsystem, * and how to change the wettability of the porous medium. +:tv: [Lecture slides corresponding to exercise](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/materialsystem.html#/title-slide) + ### [:open_file_folder: Dune module](./exercise-dunemodule/README.md) You learn how to @@ -59,6 +71,9 @@ You learn how to * create a new dune module which depends on the dumux module, * create a new GitLab project. +:tv: [Lecture slides corresponding to exercise](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/dunemodule.html#/custom-dune-module) + + ### [:open_file_folder: Model](./exercise-model/README.md) This exercise covers the implementation of new models in DuMu<sup>x</sup>. You learn @@ -67,6 +82,8 @@ This exercise covers the implementation of new models in DuMu<sup>x</sup>. You l * how to implement a local residual using a minimal model design * use DuMu<sup>x</sup> to denoise an image (!) +:tv: [Lecture slides corresponding to exercise](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/model.html#/title-slide) + ### [:open_file_folder: Coupling free and porous medium flow](./exercise-coupling-ff-pm/README.md) This exercise is related to the [SFB1313 Project Area A](https://www.sfb1313.uni-stuttgart.de/research-areas/) @@ -79,6 +96,9 @@ You learn how to * change the model in the porous-medium domain, * change the model in the free-flow domain. +:tv: [Introduction to multidomain](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/multidomain.html#/title-slide) +:tv: [Lecture slides corresponding to exercise](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/coupled_ff-pm.html#/title-slide) + ### [:open_file_folder: Discrete fracture modeling](./exercise-fractures/README.md) This exercise is related to the [SFB1313 Project Area B](https://www.sfb1313.uni-stuttgart.de/research-areas/) @@ -89,6 +109,9 @@ You learn how to * change the properties of the fractures, * use domain markers to set internal boundary conditions. +:tv: [Introduction to multidomain](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/multidomain.html#/title-slide) +:tv: [Lecture slides corresponding to exercise](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/fractures.html#/title-slide) + ### [:open_file_folder: Biomineralization](./exercise-biomineralization/README.md) This exercise is related to the [SFB1313 Project Area C](https://www.sfb1313.uni-stuttgart.de/research-areas/) @@ -99,3 +122,5 @@ You learn how to * apply the mineralization model, i.e. add balance equations to describe dynamic solid phases. * compare different simulation results using a programmable filter in Paraview +:tv: [Introduction to multidomain](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/multidomain.html#/title-slide) +:tv: [Lecture slides corresponding to exercise](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/biomin.html#/title-slide) diff --git a/slides/README.md b/slides/README.md index 3fb8dd1babb3f8e129fe475d01afcba85dea4c60..6c4b3835a7d2b536aef09e0e685189201d3715a2 100644 --- a/slides/README.md +++ b/slides/README.md @@ -1,7 +1,35 @@ # DuMuX course slides The slides are automatically built and deployed in the CI and can be viewed at -[pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/index.html). + +:tv: [DuMuX course homepage](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/index.html) + +## Slide overview and direct links + +The link above will lead to a single slide deck from which all presentation in the course can be reached. +To reach a specific lecture directly, we have compiled some direct links: + +* [Introduction to DuMuX](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/intro.html#/title-slide) +* Part I: Basics ([overview](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/index.html#/section)) + - [A first test application](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/problem.html#/title-slide) + - [Runtime parameters](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/params.html#/title-slide) + - [Grid managers](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/grid.html#/title-slide) + - [Python bindings](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/python.html#/title-slide) + +* Part II: Customization, working with the code ([overview](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/index.html#/section-1)) + - [Properties](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/properties.html#/title-slide) + - [Constitutive laws and material system](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/materialsystem.html#/title-slide) + - [Creating a new Dune module](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/dunemodule.html#/title-slide) + - [Implementing a new model PDE](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/model.html#/title-slide) + +* Part III: Advanced exercises, multidomain models ([overview](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/index.html#/section-2)) + - [Introduction to Multidomain simulations](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/multidomain.html#/title-slide) + - [Coupled free-flow, porous media systems](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/coupled_ff-pm.html#/title-slide) + - [Discrete fracture modeling](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/fractures.html#/title-slide) + - [Biomineralization modeling](https://pages.iws.uni-stuttgart.de/dumux-repositories/dumux-course/biomin.html#/title-slide) + +## Developing the slides + In order to add new slides, simply add your `.md` file in this folder, and add an entry to `index.md` such that your slides are linked from the landing page. __Important__: In `index.md`, link to your slides using `./YOUR_FILENAME.html`, and make sure to put your link at the right position in the list.