"
Tracks/Software/Judging
From 2014.igem.org
(Difference between revisions)
(→Gold Medal) |
(→2014 Software Track Judging) |
||
| Line 19: | Line 19: | ||
* Basic code documentation for outside developers | * Basic code documentation for outside developers | ||
* Detailed installation or setup instructions for users (if applicable) | * Detailed installation or setup instructions for users (if applicable) | ||
| + | ** for web servers: provide Docker container of your server (details are being worked on by iGEM headquarters) | ||
* Basic user guide | * Basic user guide | ||
| Line 42: | Line 43: | ||
#Provide a convincing validation, testing the performance of their development -- experimental or by other teams. Note, even if the algorithm turns out not to work, they can still get Gold if their test is good and the analysis convincing. | #Provide a convincing validation, testing the performance of their development -- experimental or by other teams. Note, even if the algorithm turns out not to work, they can still get Gold if their test is good and the analysis convincing. | ||
#Show how their software effects Human Practices in Synthetic Biology. This may include: ethics, sharing, innovation and creative process, ownership, safety, or security. | #Show how their software effects Human Practices in Synthetic Biology. This may include: ethics, sharing, innovation and creative process, ownership, safety, or security. | ||
| + | |||
| + | ''Detailed Technical Requirements:'' | ||
| + | |||
===Bonus points=== | ===Bonus points=== | ||
| + | |||
| + | * use and support of SBOL and other standards | ||
| + | * re-use and further development of previous iGEM software projects (or parts thereof) | ||
| + | * use and/or improvement of existing synthetic biology tools or frameworks | ||
| + | * development of well documented libraries for other developers rather than "only" stand-alone Apps for end users | ||
Revision as of 21:05, 4 June 2014
Status of this document: Draft for discussion
Contents |
2014 Software Track Judging
Judging for the Software track will have area-specific requirements for medals as detailed below. These criteria evolve together with the iGEM competition, so please read carefully. Software Tools teams are also eligible for selection as Finalists, Grand Prizes, and Special Prizes at the iGEM 2014 World Championship Jamboree.
Bronze Medal
- Register the team, have a great summer, and have fun attending the Regional Jamboree and World Championship Jamboree.
- Create and share a description of the team's project via the iGEM wiki.
- Present a Poster and Talk at the Regional Jamboree and World Championship Jamboree.
- Develop and make available via the The Registry of Software Tools an open source software tool that supports synthetic biology.
Detailed Technical Requirements:
- Wiki documentation of project aims, methods and success
- Use git (from beginning of project)
- Submission of complete source code and any auxiliary files to GitHub
- Basic code documentation for outside developers
- Detailed installation or setup instructions for users (if applicable)
- for web servers: provide Docker container of your server (details are being worked on by iGEM headquarters)
- Basic user guide
Silver Medal (Note: changed from last year!)
In addition to the Bronze Medal requirements:
- Follow best practises in software development so that other developers can modify, use and re-use your code.
- Provide a comprehensive and well-designed User Guide.
- Demonstrate the relevance of your development for Synthetic Biology.
Detailed Technical Requirements:
- Detailed API documentation, preferably, automatically built from source code documentation (use tools like doxygen, yard, rdoc, naturaldocs, etc)
- more than one realistic test case
- automated unit tests, documentation of test coverage
- fulfill one bonus point requirement (see below)
Gold Medal
To earn a Gold Medal, in addition to the Silver Medal requirements, a team must:
- Provide a convincing validation, testing the performance of their development -- experimental or by other teams. Note, even if the algorithm turns out not to work, they can still get Gold if their test is good and the analysis convincing.
- Show how their software effects Human Practices in Synthetic Biology. This may include: ethics, sharing, innovation and creative process, ownership, safety, or security.
Detailed Technical Requirements:
Bonus points
- use and support of SBOL and other standards
- re-use and further development of previous iGEM software projects (or parts thereof)
- use and/or improvement of existing synthetic biology tools or frameworks
- development of well documented libraries for other developers rather than "only" stand-alone Apps for end users
