Category:Howtos

From openwfm
Revision as of 03:21, 17 January 2010 by Jmandel (talk | contribs) (It's OK to refer to specific README files...)
Jump to navigation Jump to search

The greatest danger in any project is that people forget how to reproduce the work already done. Yet reproducibility is the first requirement of science! Please:

  • Give sufficient information to build the codes and run them on a particular problem, including links to code and data repositores,

It's OK to refer to specific README files in the source code, no need to repeat the info

  • Make sure to note the versions of all resources used, such as git commit hash or Subversion tag for source codes, as well date, size, and md5sum for data files, and version numbers of compilers and libraries.
  • Include some pictures and results.
  • Update the pages as the codes and data change.

Thanks!