Category:Howtos

One of the greatest dangers in any project is that people do not know how to reproduce the work already done, then the work is effectively lost. Yet reproducibility is the first requirement of science! Please describe how to reproduce your successes here. Here are some suggestions.

• Keep it simple. It's not the complete documentation, it's just a Howto.
• Give minimal information needed to reproduce building the code and running it on a particular problem. It's OK to refer to specific README files in the source code, no need to repeat the info here, but it must be clear how to get to it.
• Include links to the code and data repositores, and to the documentation.
• Record versions with which it all worked, such as git commit hash or Subversion tag for source codes, the date and some checksum (sum, md5sum) for data files, and versions of the operating system, compilers, and libraries.
• Include some pictures and results.
• Update the page as the codes and data change, but do not delete the information on past working versions.

Thanks!