Skip to content

Updating the wiki

K Clough edited this page Oct 28, 2024 · 3 revisions

Please help us to make this Wiki more useful!

Wiki etiquette

"We urge all users to be bold: if you spot an error, correct it. If you can improve an article, please do so. It is important, however, to distinguish boldness from recklessness. Start off small. Begin by making minor modifications to existing articles before attempting a complete rewrite." (Wikipedia guidelines)

Unlike Wikipedia, we don't have an army of people monitoring updates to our Wiki. So as a general rule, don't delete or overwrite text. We would prefer that you contact us to discuss the error, or consider whether you could instead add a comment like:

Other users have found that the code compiled better with the options xxx and yyy. [Note by MyName, 1/1/2018]

However, if you want to add additional material, or fix an obvious typo, please go ahead - we really welcome your input.

Target audience

Please bear in mind that many people who use the code will be physicists with variable levels of coding and HPC experience. Make your additions comprehensive and provide links for further information if a significant level of additional knowledge is required. Don't be afraid to "dumb down" - if it took you a while to figure something out, it is probably the same for others, even if it now seems trivial.