Difference between revisions of "Category:Howtos"
Jump to navigation
Jump to search
m (fmt) |
(clarify) |
||
| Line 2: | Line 2: | ||
* 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. | * 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 | + | * 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. | * Include some pictures and results. | ||
* Update the pages as the codes and data change. | * Update the pages as the codes and data change. | ||
Thanks! | Thanks! | ||
Revision as of 03:26, 17 January 2010
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 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 pages as the codes and data change.
Thanks!
Pages in category "Howtos"
The following 18 pages are in this category, out of 18 total.