Commit 5f343f30 authored by Lukas Riedel's avatar Lukas Riedel Committed by Santiago Ospina De Los Ríos

Write parameter version attributes into user docs

Attributes are sorted by decreasing version.
parent cedc75d3
...@@ -8,6 +8,8 @@ We're rolling out version `X.Y.0`! :tada: ...@@ -8,6 +8,8 @@ We're rolling out version `X.Y.0`! :tada:
`dune.module` to `X.Y.0`. `dune.module` to `X.Y.0`.
- [ ] `master`: Update all `version="unreleased"` tags in the default config - [ ] `master`: Update all `version="unreleased"` tags in the default config
file XML sources to `version="X.Y.0"`. file XML sources to `version="X.Y.0"`.
- [ ] `master`: Update all [version directives][sphinx-ver-dir] with version
`unreleased` in the user docs to `X.Y.0`.
### 2 — On GitLab ### 2 — On GitLab
- [ ] [Create branch][new branch] `X.Y-stable` from `master` - [ ] [Create branch][new branch] `X.Y-stable` from `master`
...@@ -47,3 +49,4 @@ Close this issue! ...@@ -47,3 +49,4 @@ Close this issue!
[new label]: https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/-/labels/new [new label]: https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/-/labels/new
[DockerHub description]: https://hub.docker.com/r/dorie/dorie [DockerHub description]: https://hub.docker.com/r/dorie/dorie
[badge]: https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/edit [badge]: https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/edit
[sphinx-ver-dir]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded
...@@ -13,6 +13,8 @@ The MRs to be considered in this update are listed in # ...@@ -13,6 +13,8 @@ The MRs to be considered in this update are listed in #
- [ ] Update version numbers in `VERSION`, `CHANGELOG.md`, `dune.module` - [ ] Update version numbers in `VERSION`, `CHANGELOG.md`, `dune.module`
- [ ] Update `version="unreleased"` tags in the default config file XML - [ ] Update `version="unreleased"` tags in the default config file XML
sources <!-- only if applicable --> sources <!-- only if applicable -->
- [ ] Update Sphinx version directives with version `unreleased` in the user
docs. <!-- only if applicable -->
#### Help on Cherry-Picking #### Help on Cherry-Picking
Cherry-picking merge commits requires specifying the "mainline" parent, which Cherry-picking merge commits requires specifying the "mainline" parent, which
......
...@@ -32,6 +32,7 @@ ...@@ -32,6 +32,7 @@
* Parameter XML files support tags for version changes !171 * Parameter XML files support tags for version changes !171
* Unit test for Parameter XML file parser !171 * Unit test for Parameter XML file parser !171
* CMake option to enable code coverage flags on all targets !172 * CMake option to enable code coverage flags on all targets !172
* Changes to config file parameters listed per version in user docs !175
### Changed ### Changed
* Data structures for storing and accessing parameter information !55 * Data structures for storing and accessing parameter information !55
......
...@@ -26,6 +26,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -26,6 +26,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<suggestion> richards </suggestion> <suggestion> richards </suggestion>
<values> richards, richards+transport </values> <values> richards, richards+transport </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
</category> </category>
...@@ -84,6 +85,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -84,6 +85,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> path </values> <values> path </values>
<suggestion> None </suggestion> <suggestion> None </suggestion>
<comment> This category is only used for 'rectangular' grids </comment> <comment> This category is only used for 'rectangular' grids </comment>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="volume"> <parameter name="volume">
...@@ -93,6 +95,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -93,6 +95,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<suggestion> 0 </suggestion> <suggestion> 0 </suggestion>
<values> path or int </values> <values> path or int </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="boundaryLower"> <parameter name="boundaryLower">
...@@ -102,6 +105,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -102,6 +105,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<suggestion> 0 </suggestion> <suggestion> 0 </suggestion>
<values> path or int </values> <values> path or int </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="boundaryUpper"> <parameter name="boundaryUpper">
...@@ -111,6 +115,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -111,6 +115,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<suggestion> 1 </suggestion> <suggestion> 1 </suggestion>
<values> path or int </values> <values> path or int </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="boundaryLeft"> <parameter name="boundaryLeft">
...@@ -120,6 +125,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -120,6 +125,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<suggestion> 2 </suggestion> <suggestion> 2 </suggestion>
<values> path or int </values> <values> path or int </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="boundaryRight"> <parameter name="boundaryRight">
...@@ -129,6 +135,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -129,6 +135,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<suggestion> 3 </suggestion> <suggestion> 3 </suggestion>
<values> path or int </values> <values> path or int </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="boundaryFront"> <parameter name="boundaryFront">
...@@ -139,6 +146,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -139,6 +146,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> 4 </suggestion> <suggestion> 4 </suggestion>
<values> path or int </values> <values> path or int </values>
<comment> Only in 3D </comment> <comment> Only in 3D </comment>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="boundaryBack"> <parameter name="boundaryBack">
...@@ -148,6 +156,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -148,6 +156,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<suggestion> 5 </suggestion> <suggestion> 5 </suggestion>
<values> path or int </values> <values> path or int </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
</category> </category>
...@@ -160,6 +169,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -160,6 +169,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> none, waterFlux </values> <values> none, waterFlux </values>
<suggestion> none </suggestion> <suggestion> none </suggestion>
<comment> none, waterFlux </comment> <comment> none, waterFlux </comment>
<versionadded version="unreleased"> Replaces ``useAdaptivity``.
</versionadded>
</parameter> </parameter>
<parameter name="maxLevel"> <parameter name="maxLevel">
...@@ -201,6 +212,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -201,6 +212,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> elementFraction, errorFraction, threshold </values> <values> elementFraction, errorFraction, threshold </values>
<suggestion> elementFraction </suggestion> <suggestion> elementFraction </suggestion>
<comment> elementFraction, errorFraction, threshold </comment> <comment> elementFraction, errorFraction, threshold </comment>
<versionchanged version="unreleased"> Option ``targetTolerance`` removed.
</versionchanged>
</parameter> </parameter>
<parameter name="refinementFraction"> <parameter name="refinementFraction">
...@@ -230,6 +243,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -230,6 +243,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> info </suggestion> <suggestion> info </suggestion>
<values> trace, debug, info, warning, error, critical </values> <values> trace, debug, info, warning, error, critical </values>
</parameter> </parameter>
<versionadded version="unreleased"> </versionadded>
</category> </category>
<category name="misc"> <category name="misc">
......
...@@ -29,6 +29,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -29,6 +29,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
The dataset name inside the ``outputFile``. The dataset name inside the ``outputFile``.
</definition> </definition>
<values> path </values> <values> path </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="converter"> <parameter name="converter">
...@@ -40,6 +41,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -40,6 +41,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> none, binary, exponential </values> <values> none, binary, exponential </values>
<suggestion> binary </suggestion> <suggestion> binary </suggestion>
<comment> none, binary, exponential </comment> <comment> none, binary, exponential </comment>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="tempDir"> <parameter name="tempDir">
...@@ -49,6 +51,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -49,6 +51,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> path </values> <values> path </values>
<suggestion> /tmp/fft_generator/ </suggestion> <suggestion> /tmp/fft_generator/ </suggestion>
<versionchanged version="unreleased"> Renamed from
``generator.fft.outputPath``. </versionchanged>
</parameter> </parameter>
</category> </category>
...@@ -57,6 +61,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -57,6 +61,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<definition> Physical dimensions of the field. </definition> <definition> Physical dimensions of the field. </definition>
<suggestion> 2 </suggestion> <suggestion> 2 </suggestion>
<values> 2, 3 </values> <values> 2, 3 </values>
<versionchanged version="unreleased"> Renamed from
``generator.dimensions``. </versionchanged>
</parameter> </parameter>
<parameter name="extensions"> <parameter name="extensions">
...@@ -66,6 +72,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -66,6 +72,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> int &times; int (&times; int) </values> <values> int &times; int (&times; int) </values>
<suggestion> 1 1 </suggestion> <suggestion> 1 1 </suggestion>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="cells"> <parameter name="cells">
...@@ -73,6 +80,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -73,6 +80,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> int &times; int (&times; int) </values> <values> int &times; int (&times; int) </values>
<suggestion> 100 100 </suggestion> <suggestion> 100 100 </suggestion>
<versionchanged version="unreleased"> Renamed from ``generator.fft.N``.
</versionchanged>
</parameter> </parameter>
</category> </category>
...@@ -85,6 +94,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -85,6 +94,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> int </values> <values> int </values>
<suggestion> 1 </suggestion> <suggestion> 1 </suggestion>
<versionchanged version="unreleased"> Renamed from
``generator.fft.seed``. </versionchanged>
</parameter> </parameter>
<parameter name="variance"> <parameter name="variance">
...@@ -93,6 +104,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -93,6 +104,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> float </values> <values> float </values>
<suggestion> 0.2 </suggestion> <suggestion> 0.2 </suggestion>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="corrLength"> <parameter name="corrLength">
...@@ -101,6 +113,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -101,6 +113,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> float &times; float (&times; float) </values> <values> float &times; float (&times; float) </values>
<suggestion> .1 .05 </suggestion> <suggestion> .1 .05 </suggestion>
<versionchanged version="unreleased"> Renamed from
``generator.fft.correlationLenghts``. </versionchanged>
</parameter> </parameter>
<parameter name="covariance"> <parameter name="covariance">
...@@ -109,6 +123,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -109,6 +123,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> exponential, gaussian, spherical, whiteNoise </values> <values> exponential, gaussian, spherical, whiteNoise </values>
<suggestion> gaussian </suggestion> <suggestion> gaussian </suggestion>
<comment> exponential, gaussian, spherical, whiteNoise </comment> <comment> exponential, gaussian, spherical, whiteNoise </comment>
<versionchanged version="unreleased"> Renamed from
``generator.fft.covariance``. </versionchanged>
</parameter> </parameter>
</category> </category>
...@@ -120,6 +136,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -120,6 +136,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> int </values> <values> int </values>
<suggestion> 0 1 </suggestion> <suggestion> 0 1 </suggestion>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
</category> </category>
...@@ -133,6 +150,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -133,6 +150,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> bool </values> <values> bool </values>
<suggestion> true </suggestion> <suggestion> true </suggestion>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
</category> </category>
</dorie> </dorie>
...@@ -20,6 +20,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -20,6 +20,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<definition> Logging level of the Richards solver. </definition> <definition> Logging level of the Richards solver. </definition>
<suggestion> info </suggestion> <suggestion> info </suggestion>
<values> trace, debug, info, warning, error, critical </values> <values> trace, debug, info, warning, error, critical </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="outputPath"> <parameter name="outputPath">
...@@ -48,6 +49,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -48,6 +49,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<definition> Policy to write the data. </definition> <definition> Policy to write the data. </definition>
<suggestion> endOfRichardsStep </suggestion> <suggestion> endOfRichardsStep </suggestion>
<values> endOfRichardsStep, none </values> <values> endOfRichardsStep, none </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="subsamplingLevel"> <parameter name="subsamplingLevel">
...@@ -78,6 +80,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -78,6 +80,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> infiltration.yml </suggestion> <suggestion> infiltration.yml </suggestion>
</definition> </definition>
<values> path </values> <values> path </values>
<versionchanged version="unreleased"> Expects a YAML file now.
</versionchanged>
</parameter> </parameter>
</category> </category>
...@@ -89,6 +93,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -89,6 +93,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> data, analytic </values> <values> data, analytic </values>
<suggestion> analytic </suggestion> <suggestion> analytic </suggestion>
<comment> Choose initial condition type: data, analytic </comment> <comment> Choose initial condition type: data, analytic </comment>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="quantity"> <parameter name="quantity">
...@@ -98,12 +103,14 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -98,12 +103,14 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> matricHead </values> <values> matricHead </values>
<suggestion> matricHead </suggestion> <suggestion> matricHead </suggestion>
<comment> Choose quantity represented: matricHead </comment> <comment> Choose quantity represented: matricHead </comment>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="equation"> <parameter name="equation">
<definition> Equation for the initial condition </definition> <definition> Equation for the initial condition </definition>
<values> equation [x,y,z,h] </values> <values> equation [x,y,z,h] </values>
<suggestion> -h </suggestion> <suggestion> -h </suggestion>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="file"> <parameter name="file">
...@@ -112,12 +119,14 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -112,12 +119,14 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
file extension ``.h5``. file extension ``.h5``.
</definition> </definition>
<values> path </values> <values> path </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="dataset"> <parameter name="dataset">
<definition> Dataset to use as initial condition (``data`` type only). <definition> Dataset to use as initial condition (``data`` type only).
</definition> </definition>
<values> string </values> <values> string </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="interpolation"> <parameter name="interpolation">
...@@ -125,6 +134,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -125,6 +134,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> nearest, linear </values> <values> nearest, linear </values>
<suggestion> linear </suggestion> <suggestion> linear </suggestion>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
</category> </category>
...@@ -199,6 +209,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -199,6 +209,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> path </values> <values> path </values>
<suggestion> richards_param.yml </suggestion> <suggestion> richards_param.yml </suggestion>
</parameter> </parameter>
<versionadded version="unreleased"> </versionadded>
</category> </category>
<category name="numerics"> <category name="numerics">
...@@ -210,6 +221,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -210,6 +221,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> 1 </suggestion> <suggestion> 1 </suggestion>
<values> 0, 1, 2, 3 </values> <values> 0, 1, 2, 3 </values>
<comment> Select '0' for the finite volume (FV) solver </comment> <comment> Select '0' for the finite volume (FV) solver </comment>
<versionchanged version="unreleased"> Renamed from ``grid.FEorder``.
</versionchanged>
</parameter> </parameter>
<parameter name="upwinding"> <parameter name="upwinding">
...@@ -225,6 +238,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -225,6 +238,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> none </suggestion> <suggestion> none </suggestion>
<comment> Choose upwinding type: 'none', 'semiUpwind', 'fullUpwind' <comment> Choose upwinding type: 'none', 'semiUpwind', 'fullUpwind'
</comment> </comment>
<versionchanged version="unreleased"> Renamed from
``dg.experimental.upwinding``. </versionchanged>
</parameter> </parameter>
<parameter name="DGMethod"> <parameter name="DGMethod">
...@@ -240,6 +255,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -240,6 +255,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> SIPG, NIPG, OBB, IIP </values> <values> SIPG, NIPG, OBB, IIP </values>
<suggestion> SIPG </suggestion> <suggestion> SIPG </suggestion>
<versionchanged version="unreleased"> Renamed from
``dg.experimental.method``. </versionchanged>
</parameter> </parameter>
<parameter name="DGWeights"> <parameter name="DGWeights">
...@@ -248,6 +265,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -248,6 +265,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> true, false </values> <values> true, false </values>
<suggestion> true </suggestion> <suggestion> true </suggestion>
<versionchanged version="unreleased"> Renamed from
``dg.experimental.weights``. </versionchanged>
</parameter> </parameter>
<parameter name="penaltyFactor"> <parameter name="penaltyFactor">
...@@ -255,6 +274,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -255,6 +274,8 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> float </values> <values> float </values>
<suggestion> 10 </suggestion> <suggestion> 10 </suggestion>
<versionchanged version="unreleased"> Renamed from
``dg.penaltyFactor``. </versionchanged>
</parameter> </parameter>
</category> </category>
...@@ -267,6 +288,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -267,6 +288,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<suggestion> true </suggestion> <suggestion> true </suggestion>
<values> true, false </values> <values> true, false </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="checkJumps"> <parameter name="checkJumps">
...@@ -277,6 +299,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -277,6 +299,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<suggestion> none </suggestion> <suggestion> none </suggestion>
<values> none, warn, error </values> <values> none, warn, error </values>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
<parameter name="checkTol"> <parameter name="checkTol">
...@@ -285,6 +308,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html ...@@ -285,6 +308,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition> </definition>
<values> float &gt; 0 </values> <values> float &gt; 0 </values>
<suggestion> 1E-10 </suggestion> <suggestion> 1E-10 </suggestion>
<versionadded version="unreleased"> </versionadded>
</parameter> </parameter>
</category> </category>
......
...@@ -63,6 +63,13 @@ Parameter Field Generator ...@@ -63,6 +63,13 @@ Parameter Field Generator
Main Routine Main Routine
------------ ------------
Common and richards parameters are needed in the configuration file. Depending on the ``simulation.mode``, the respective model categories will be
read. The parameters without model prefix are always evaluated.
.. versionadded:: unreleased
Added ``transport`` model parameters.
.. versionchanged:: unreleased
Split parameters into default and ``richards`` model parameters.
.. include:: @CHEATSHEET_DORIE_RELPATH@ .. include:: @CHEATSHEET_DORIE_RELPATH@
...@@ -4,6 +4,7 @@ import datetime ...@@ -4,6 +4,7 @@ import datetime
import os import os
import re import re
import textwrap import textwrap
from distutils.version import LooseVersion
try: try:
str = unicode str = unicode
...@@ -23,6 +24,15 @@ def write(parameters,out,path_base,*args,**kwargs): ...@@ -23,6 +24,15 @@ def write(parameters,out,path_base,*args,**kwargs):
<description> <description>
.. deprecated: <ver>
[description]
.. versionchanged: <ver>
[description]
.. versionadded: <ver>
[description]
Possible values | <values> Possible values | <values>
Default value | <suggestion> Default value | <suggestion>
Queried at | <file path (if available)> Queried at | <file path (if available)>
...@@ -70,6 +80,24 @@ def _format_parameter(parameter, path_base): ...@@ -70,6 +80,24 @@ def _format_parameter(parameter, path_base):
out += "\n" out += "\n"
out += "\n" out += "\n"
# Changes by version
def write_version_attr(param, attr_name):
data_dict = getattr(param, attr_name)
versions_sorted = sorted(data_dict.keys(),
key=LooseVersion,
reverse=True)
nonlocal out
for version in versions_sorted:
out += tab + ".. {0}:: {1}\n".format(attr_name, version)
description = data_dict[version]
if description:
out += tab + tab + description + "\n"
out += "\n"
write_version_attr(parameter, "deprecated")