Tracks/Software/Judging

From 2014.igem.org

(Difference between revisions)
(Bronze Medal)
 
(19 intermediate revisions not shown)
Line 1: Line 1:
 +
<!--
 +
{{CSS/Main}}
 +
{{NavBar}}
 +
<html>
 +
 +
<!--
 +
<style type="text/css">
 +
#software {display: block;}
 +
</style>
 +
 +
<div id="contentcontainer">
 +
 +
<div class="container_12">
 +
 +
<div class="grid_3">
 +
</html>
 +
{{HTML/TrackMenu}}
 +
<html>
 +
<div class="contentpara" style="margin-top: 60px;">
 +
<p style="width: 160px; margin: auto; color:#7d7d7d; font-size:80%;"></p>
 +
</div>
 +
</div>
 +
<div class="grid_9">
 +
</html>
 +
''Status of this document:'' '''Draft for discussion'''
''Status of this document:'' '''Draft for discussion'''
Line 7: Line 32:
===Bronze Medal===
===Bronze Medal===
-
#Register the team, have a great summer, and have fun attending the Regional Jamboree and World Championship Jamboree.
+
#Register the team, have a great summer, and have fun attending the Jamboree in Boston.
#Create and share a description of the team's project via the iGEM wiki.
#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.
#Present a Poster and Talk at the Regional Jamboree and World Championship Jamboree.
#Develop and make available via the [[The Registry of Software Tools|The Registry of Software Tools]] an open source software tool that supports synthetic biology.
#Develop and make available via the [[The Registry of Software Tools|The Registry of Software Tools]] an open source software tool that supports synthetic biology.
-
{{ombox
+
''Detailed Technical Requirements:''
-
| text = 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 [https://www.docker.io/ Docker] container of your server (details are being worked on by iGEM headquarters)
 +
* Basic user guide
 +
 
 +
===Silver Medal===
 +
 
 +
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
 +
* collect one bonus point (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:''
 +
 
 +
* good test coverage
 +
* excellent installation-, user- and developer documentation
 +
* collect 3 bonus points (see below)
 +
 
 +
===Bonus points===
 +
 
 +
None of the bonus points are a strict requirement but you have to collect at least one or three of them in order to earn the Silver or Gold medal, respectively.
 +
 
 +
* 2-3 points for: experimental validation of your software or algorithm (experiments can be outsourced to other teams, labs or companies)
 +
* 1 point for: use and support of [http://www.sbolstandard.org SBOL]
 +
* 1 point for: re-use and further development of previous iGEM software projects (or parts thereof)
 +
* 1 point for: use and/or improvement of existing synthetic biology tools or frameworks
 +
* 1 point for: development of a well documented library for other developers rather than "only" stand-alone Apps for end users
 +
* 1-2 points for: surprising us with something that is so cool or new that we would have never thought of it
 +
 
 +
 
 +
 
 +
Please note, these requirements are preliminary and will still be changed and fine-tuned by the software committee. Feel free to contact the software committee to ask for clarification or participate in the discussion.
 +
 
 +
-->

Latest revision as of 22:08, 10 July 2014