From 836479a50e39600a53b7115f6dd6e45890b290b1 Mon Sep 17 00:00:00 2001 From: Axel Huebl Date: Fri, 24 Jan 2014 16:30:45 +0100 Subject: [PATCH] Draft for example documentation - template done - YAML style - limits defined --- examples/KelvinHelmholtz/documentation.yml | 67 ++++++++++++++++++++++ examples/limits.yml | 14 +++++ 2 files changed, 81 insertions(+) create mode 100644 examples/KelvinHelmholtz/documentation.yml create mode 100644 examples/limits.yml diff --git a/examples/KelvinHelmholtz/documentation.yml b/examples/KelvinHelmholtz/documentation.yml new file mode 100644 index 0000000000..b9be5e91b3 --- /dev/null +++ b/examples/KelvinHelmholtz/documentation.yml @@ -0,0 +1,67 @@ +--- # Documentation for the Kelvin-Helmholtz Example +example: + name: Kelvin-Hemholtz Instability + short: KelvinHelmholtz + author: Axel Huebl , E. Paulo Alves, Thomas Grismayer + maintainer: Axel Huebl + + description: | + ... This should be an *extensive* documentation for the + physicists using this example. Quote references + ... Example references: *Alves12, *Bussmann13 ... + + references: + - Alves12: &Alves12 + author ... + title: ... + journal: ... + year: ... + link: doi link! + - Bussmann13: &Bussmann13 + author: ... + title: ... + journal: ... + year: ... + link: doi link! + +--- # Run-Time Tests for the Kelvin-Helmholtz Example +test: + - growthRate: + name: Kelvin-Helmholtz e-/e+ Growth Rate Test + description: | + This test runs the simulation with an electrons-positrons + gas and measures the growth rate of the characteristic B_z + field over time. + This is a very crutal test to see if the plasma dynamics + comes up right. + cmakeflag: 0 + cfgfile: submit/0016gpus.cfg + gpus: 16 + + pre-run: + - echo "Starting KHI Growth Rate Test" + - echo "Just printing even more here..." + post-run: + - echo "Check number of particles..." + - echo "Check total energy..." + - echo "Creating Energy(B_z) over time plot..." + - echo "Fit to expected growth rate..." + - echo "Check charge conservation..." + - echo "ok / failed" + + - relativistic: + name: Relativistic Kelvin-Helmholtz e-/p+ setting + description: | + This test runs the simulation with an electrons-protons + gas and a relativistic inital velocity of the streams... + cmakeflag: 1 + cfgfile: submit/0016gpus.cfg + gpus: 16 + + pre-run: + - echo "Starting Relativisitic KHI" + post-run: + - echo "Check number of particles..." + - echo "creating Energy(B_z) over time plot..." + - echo "fit ..." + - echo "measure artificial cherenkov / total energy..." diff --git a/examples/limits.yml b/examples/limits.yml new file mode 100644 index 0000000000..9afc8e86f6 --- /dev/null +++ b/examples/limits.yml @@ -0,0 +1,14 @@ +--- # Limits for run-time tests in the folder examples/ +limits: + description: | + This file contains the limits for allowed run-time tests in the + example's `documentation.yml`. Maintainers of the examples + should not exceed this limits, else their tests will be + considered as *failed*. + A zero-value for a limit means *no limit*. + + tests: 5 # the maximum number of tests per example + gpus: 16 # the maximum number of GPUs a test can use + walltime: 01:00:00 # the TOTAL walltime that is allowed for ALL + # tests of A SINGLE example to finish, + # including pre- and post-processing