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

 
(10 intermediate revisions by the same user not shown)
Line 3: Line 3:
  
 
<h1>Installation</h1>
 
<h1>Installation</h1>
−
You can download our project from <a href=https://github.com/igemsoftware/Michigan15>our github</a> or <a href=https://static.igem.org/mediawiki/2015/d/d3/Michigan15.zip>download the wiki freeze version here</a>. We HIGHLY recommend downloading from GitHub, as it will be a more recent, and undoubtedly better, version.
+
<p>You can download our project from <a href=https://github.com/igemsoftware/Michigan15>our github</a> or <a href=https://static.igem.org/mediawiki/2015/d/d3/Michigan15.zip>download the wiki freeze version here</a>. We <em>highly</em> recommend downloading from GitHub, as it will be a more recent, and as a result better, version.<p>
  
−
<div class="highlightBox">
+
<h2> Pre-installations for Protocat </h2>
−
<h4>Note</h4>
+
<h4> Python and Pip </h4>
−
<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>
+
<ol>
−
</div>
+
<li>Run the Python 3.4.3 installer from <a href="https://www.python.org/downloads/release/python-343/">here</a></li>
 +
<li>Make sure Add Python to PATH is enabled</li>
 +
<li>Newer releases of Python come with Pip pre-installed</li>
 +
</ol>
  
 +
<h4>Django</h4>
 +
<ol>
 +
<li>Open Command Prompt(Windows) or Terminal (Mac)</li>
 +
<li>Use "pip install django" to install the main Django packages</li>
 +
<li>Other necessary installations</li>
 +
<ul>
 +
<li>Type "pip install django-nose" into the prompt</li>
 +
<li>Type "pip install coverage" into the prompt</li>
 +
<li>Type "pip install django-contrib-comments" into the prompt</li>
 +
<li>Type "pip install pytz" into the prompt</li>
 +
<li>Type "pip install docutils" into the prompt</li>
 +
</ul>
 +
</ol>
  
−
<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>
+
<h4> Github </h4>
 +
<ol>
 +
<li> Install Github from <a href="https://desktop.github.com/"> here</a> </li>
 +
<li> Be sure to select your operating system for the download </li>
 +
<li> Make sure Github has access to PATH</li>
 +
</ol>
  
−
<p>
+
<h2>Running Protocat </h2>
−
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.
+
<ol>
−
</p>
+
<li>Copy the SSH URL from https://github.com/igemsoftware/Michigan15</li>
 +
<li>Inside Command Prompt or Terminal, cd into the directory you want the Michigan15 source file to be in</li>
 +
<li>Type "git clone [the SSH URL]" into the terminal</li>
 +
<li>cd Michigan15/mibiosoft</li>
 +
<li>To run, use "python manage.py runserver" and type the server address into your web browser</li>
 +
<li>Enjoy using Protocat 2.0!</li>
 +
</ol>
  
−
<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 14:14, 18 September 2015


Michigan Software 2015

Installation

You can download our project from our github or download the wiki freeze version here. We highly recommend downloading from GitHub, as it will be a more recent, and as a result better, version.

Pre-installations for Protocat

Python and Pip

  1. Run the Python 3.4.3 installer from here
  2. Make sure Add Python to PATH is enabled
  3. Newer releases of Python come with Pip pre-installed

Django

  1. Open Command Prompt(Windows) or Terminal (Mac)
  2. Use "pip install django" to install the main Django packages
  3. Other necessary installations
    • Type "pip install django-nose" into the prompt
    • Type "pip install coverage" into the prompt
    • Type "pip install django-contrib-comments" into the prompt
    • Type "pip install pytz" into the prompt
    • Type "pip install docutils" into the prompt

Github

  1. Install Github from here
  2. Be sure to select your operating system for the download
  3. Make sure Github has access to PATH

Running Protocat

  1. Copy the SSH URL from https://github.com/igemsoftware/Michigan15
  2. Inside Command Prompt or Terminal, cd into the directory you want the Michigan15 source file to be in
  3. Type "git clone [the SSH URL]" into the terminal
  4. cd Michigan15/mibiosoft
  5. To run, use "python manage.py runserver" and type the server address into your web browser
  6. Enjoy using Protocat 2.0!