Difference between revisions of "Team:Michigan Software/Documentation"

 
(7 intermediate revisions by 3 users not shown)
Line 3: Line 3:
  
 
<h1>Documentation</h1>
 
<h1>Documentation</h1>
−
 
+
<h2> API </h2>
−
 
+
<p> Documentation is implemented in the admindocs of Django using the Python module docutils. To browse documentation go to the admin interface and click on the "Documentation" link in the upper right corner of the page. </p>
−
<div class="highlightBox">
+
<img src="https://static.igem.org/mediawiki/2015/f/f0/Team_Michigan_Software_API.png" width=100%/>
−
<h4>Note</h4>
+
<h2> Test Coverage </h2>
−
<p>In order to be considered for the <a href="https://2015.igem.org/Judging/Awards#SpecialPrizes">Best Software Tool award</a>, you must fill out this page.</p>
+
<p>To run test coverage, use "python manage.py test protocat_app"</p>
−
</div>
+
<img src="https://static.igem.org/mediawiki/2015/8/83/Team_Michigan_Software_TC.png" />
−
 
+
−
 
+
−
<p>Regardless of the topic, iGEM projects often create or adapt computational tools to move the project forward. Because they are born out of a direct practical need, these software tools (or new computational methods) can be surprisingly useful for other teams. Without necessarily being big or complex, they can make the crucial difference to a project's success. This award tries to find and honour such "nuggets" of computational work.</p>
+
−
 
+
−
<p>
+
−
If you are working on software as your main project, please join the software track. If you are creating software as an addition to your main project, please apply for this award.
+
−
</p>
+
−
 
+
−
<p>
+
−
Here are a few examples from previous teams:
+
−
</p>
+
−
<ul>
+
−
<li><a href="https://2013.igem.org/Team:TU-Munich/Results/Software">TU Munich 2013</a></li>
+
−
<li><a href="https://2014.igem.org/Team:Heidelberg/Software">Heidelberg 2014</a></li>
+
−
<li><a href="https://2014.igem.org/Team:Aachen/Project/Measurement_Device#Software">Aachen 2014</a></li>
+
−
</ul>
+
  
 
</div>
 
</div>
  
 
</html>
 
</html>

Latest revision as of 23:03, 18 September 2015


Michigan Software 2015

Documentation

API

Documentation is implemented in the admindocs of Django using the Python module docutils. To browse documentation go to the admin interface and click on the "Documentation" link in the upper right corner of the page.

Test Coverage

To run test coverage, use "python manage.py test protocat_app"