Development Tasks How-Tos¶
Note
Please also see the QDYN wiki for technical information about workflows on the Gitlab platform where QDYN development takes place.
How to add a new test¶
Create a new folder in
tests
or select an existing one.Add the test program(s) according to this guidelines.
If you have created a new folder for the test, add a Makefile. Otherwise, add the new test to the existing
Makefile.in
.Add a new python function for the test. For simple tests, add an entry to the list
TESTS
intests/test_simple.py
. If a test program is parallelized or needs a more complicated python function, add a new python script intests
or update on of the existing scripts.
How to add a new module¶
Create a new fortran file in the QDYN root directory.
Add the license header with the correct date and authors.
In
Makefile.in
add the module to the list of files that form theOBJ
variable.
How to add a new How-To¶
Detailed guidelines for writing How-Tos can be found in the How-Tos section of the documentation guidelines. The basis steps for adding a new How-To are:
Add a RST file in
doc/sources/howto
.Include the RST file in the ‘How-Tos’ section in
doc/sources/index.rst
.Check the How-To according to the checklist for How-tos.
How to add a new Example¶
Detailed guidelines for writing Examples can be found in the Examples section of the documentation guidelines. The basis steps for adding a new example are:
Create a new folder in
doc/sources/examples
.Add the Jupyter notebook. If necessary, add the example program and corresponding
Makefile.in
.Include the Jupyter notebook in the ‘Examples’ section in
doc/sources/index.rst
.Check the Example according to the checklist for Examples.
How to add a new Topical Overview¶
Detailed guidelines for writing Topical Overviews can be found in the Topical Overviews section of the documentation guidelines. The basis steps for adding a new example are:
Create a new RST file in
doc/sources/concepts
.Include the RST file in the Topical Overviews section in
doc/sources/index.rst
.Check the Example according to the checklist for Topical Overviews.