Skip to content

Resolve "Add cookbook example on how to use the random field generator"

Lukas Riedel requested to merge 179-add-cookbook-example-on-how-to-use-the-random-field-generator into master

What does this MR do?

Add a cook book page containing the two main use cases for the random number generator and Parameter Field Generator (PFG) module:

  • Miller-similar medium (exponential converter)
  • Binary heterogeneous medium (binary converter)

For both cases, a set of input files and instructions on how to create them from the default input files is supplied.

Images have been uploaded to the GitLab repository Wiki.

Is there something that needs to be double checked?

Do we need testing of the cases? Computing each case takes a couple of minutes. The errors related to input files are thrown immediately and we are actually not required to compute the entire simulation. However, there is no way of aborting the test after a certain time span and then indicating this test as "succeeded".

Solution: Use a separate test target for all cook book examples and run in with a Pipeline Schedule.

Can this MR be accepted?

  • Added cook book entry
  • Executed input files locally
  • Updated tests
  • Add Schedule for weekly test of cook book examples
    • Execute test:examples on schedule and master only: Revert 864d5298
  • Pipeline passing
  • Squash option set
  • Delete branch option set
  • Added entry to CHANGELOG.md

Assignee: If the Squash option is set, check/update the commit message right before merging!

Related issues

Closes #179 (closed)

Edited by Lukas Riedel

Merge request reports