Difference between revisions of "Category:Howtos"

From openwfm
Jump to navigation Jump to search
(req)
Line 1: Line 1:
The greatest danger in any project that people forget how to reproduce the work already done. Yet reproducibility is the first requirement of science!  
+
The greatest danger in any project that people forget how to reproduce the work already done. Yet reproducibility is the first requirement of science! Please
  
Please
+
* give sufficient information to build the codes and run them on a particular problem, including links to code and data repositores
 
+
* make sure to note the versions of all resources used, such as [[Wikipedia:git (software)|git]] commit hash or [[Wikipedia:Subversion (software)|Subversion]] tag for source codes, as well date, size, and [[Wikipedia:MD5|md5sum]] for data files, and version numbers of compilers and libraries
* sufficient information to build the codes and run them on a particular problem, including links to code and data repositores
+
* include some pictures and results
* make sure to note the versions that were used, such as [[Wikipedia:git]] [[Wikipedia:hash]] or version numbers in a way that the specific versions can be retrieved in future
 
* include some pictures or listings of the results if possible
 
 
* update the pages as the codes and data change.
 
* update the pages as the codes and data change.

Revision as of 03:00, 17 January 2010

The greatest danger in any project 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
  • 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.