Difference between revisions of "Category:Howtos"

From openwfm
Jump to navigation Jump to search
(purpose: reproduce)
(link)
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
One of the greatest dangers in any project is that people do not know how to reproduce the work already done, and it is effectively lost. Yet reproducibility is the first requirement of science! Please:
+
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!  
  
* Keep it simple. It's not the complete documentation, it's just a Howto.
+
This category is for pages that describe your success and allow others to do it again. See [[Help:Howtos]].
* Give minimal information needed to reproduce building the code and running it on a particular problem. Include links to the code and data repositores. It's OK to refer to specific README files in the source code, no need to repeat the info there but it must be clear how to get to the README file.  
 
* Include links to documentation.
 
* Make sure to note versions with which it all worked, such as [[Wikipedia:git (software)|git]] commit hash or [[Wikipedia:Subversion (software)|Subversion]] tag for source codes, the date and some checksum ([[Wikipedia:Sum (Unix)|sum]], [[Wikipedia:MD5|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. If someone is interested in an older version, they can always retrieve the history of the page.
 
  
Thanks!
+
[[Category:Contents]]

Latest revision as of 16:56, 4 April 2010

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!

This category is for pages that describe your success and allow others to do it again. See Help:Howtos.