Difference between revisions of "Category:Howtos"
Jump to navigation
Jump to search
(keep it simple) |
(howto) |
||
| Line 1: | Line 1: | ||
| − | One of the greatest dangers in any project is that people | + | 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: |
| − | |||
* Keep it simple. It's not the complete documentation, it's just a Howto. | * Keep it simple. It's not the complete documentation, it's just a Howto. | ||
Revision as of 03:40, 17 January 2010
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:
- Keep it simple. It's not the complete documentation, it's just a Howto.
- Give minimal information needed 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. Links to documentation are good.
- 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.