Name: Name of the relevant software.
Language: Please indicate the primary language(s) used by the module. Please also state if interfaces for other languages are available.
Licence: Specify the licence under which the software is released. Provide a link to the full online description of the licence. You’ll find descriptions of the most common licences at https://opensource.org/licenses . An example here would be: GPL
Documentation Tool: All source code created for this module should be documented so please indicate what tool has been used for documentation. Doxygen covers most languages but for Fortran you might want to use Ford, for Python ReST, etc.
Application Documentation: Provide a link to any documentation for the application.
Relevant Training Material: Add a link to any relevant training material. If there currently is none then say ‘Not currently available.’

Pilot Project Name¶

This is an example of what a pilot project for E-CAM looks like. The original source of this page (readme.rst) contains lots of additional comments to help you create your pilot project (and understand ReST syntax) so please use this as a starting point. You are free add any level of complexity you wish (within the bounds of what ReST can do). More general instructions for making your contribution can be found in “How to contribute?”.

Remember that for any associated modules to be accepted into the E-CAM repository, your source code changes in the target application must pass a number of acceptance criteria:

Style (use meaningful variable names, no global variables,…)
Source code documentation (each function should be documented with each argument explained)
Tests (everything you add should have either unit or regression tests)
Performance (If what you introduce has a significant computational load you should make some performance optimisation effort using an appropriate tool. You should be able to verify that your changes have not introduced unexpected performance penalties, are threadsafe if needed,…)

Development Plan ¶

Decompose your plan of how you will implement the project into an ordered list of modules that you will develop. The idea is that once you have achieved all modules then the project will be considered complete.

The number of modules you should list here is related to the length of the pilot project, but as a rule of thumb there should at least 1 module for every 2 months that you will spend on the project.

For each module you list, give a few lines of description of what it is about and the expected delivery date. You could also give a brief overview how it fits into the larger picture of what you want to achieve.

If needed you can include latex mathematics like $\frac{ \sum_{t=0}^{N}f(t,k) }{N}$ which won’t show up on GitLab/GitHub but will in final online documentation.