Difference between revisions of "Team:Waterloo/Software"

m
(Added Mac PyRosetta Install Instructions)
Line 101: Line 101:
 
                     <div class="panel-body">
 
                     <div class="panel-body">
 
                     <h3>PyRosetta</h3>
 
                     <h3>PyRosetta</h3>
                    <h3>PyMOL</h3>
+
<h4>For Mac OSX (vanilla)</h4>
 +
<p> Adapted from <a href="http://www.pyrosetta.org/dow">this guide</a> and <a href="http://www.pyrosetta.org/documentation#TOC-Building-PyRosetta-from-source">this guide</a>.</p>
 +
<ol>
 +
<li>A license must be obtained prior to installation, to obtain an academic license (it's free by the way) please visit <a href="http://c4c.uwc4c.com/express_license_technologies/pyrosetta">this site</a> to get one.</li>
 +
<li>After obtaining a license, go back to the <a href="http://www.pyrosetta.org/dow">download page</a> and choose the PyRosetta monolith release for Mac. (<strong>NOTE:</strong> Do not use the download link provided in the license email for Linux and Mac installations! It <strong>does not</strong> include links to the latest version of PyRosetta.</li>
 +
<li>Create a new directory (new folder) in the space you'd like to install it (I would personally recommend creating a workspace directory and then un-tarring the pyrosetta.tar.bz2 in workspace, so the path to the .tar.bz2 file would be <pre><code>users/'YOURUSERNAME'/workspace/PyRosetta.monolith.mac.release-55.tar.bz2</pre></code></li>
 +
<li>In the terminal type in <pre><code>tar -vjxf PyRosetta-monolith.mac.release-55.tar.bz2</code></pre> to un-tar the file, or alternatively just click on it to decompress it.</li>
 +
<li>Since Mac already comes with Python 2.7, python does not have to be installed. Open a terminal window and paste in <pre><code>cd ~/workspace/PyRosetta.monolith.mac.release-55</code></pre> to move to the PyRosetta directory.</li>
 +
<li>Once you're in the directory, start python by typing <pre><code>python</code></pre> in the terminal, and import the PyRosetta library with the following commands:
 +
<pre><code>import rosetta
 +
rosetta.init()
 +
</code></pre></li>
 +
<li>If no errors or complaints have been made by your machine, congratulations, you have just installed software that is notoriously difficult to install!</li>
 +
</ol>
 +
<h3>PyRosetta for Mac OSX with a Package Manager (e.g. Homebrew)</h3>
 +
<p>Unfortunately, for Mac users that use either homebrew, fink, or macports, PyRosetta must be built from source, since custom versions of python are used when one of the above are installed. If you don't know what homebrew, fink, or macports is, you probably don't have it installed so use the instructions above.</p>
 +
<ol>
 +
<li>Obtain an academic Rosetta License from <a href="https://c4c.uwc4c.com/express_license_technologies/rosetta">here</a>.</li>
 +
<li>Once you have a license and have been prompted to the download page, download the latest source version of Rosetta. At the moment it is Rosetta 2015.19.</li>
 +
<li>After downloading the .tgz and un-tarring rosetta into the directory of your choice, go into the directory where rosetta is in and find <pre></code>building.txt</code></pre> located in the following path <pre><code>main/source/src/python/bindings/</code></pre> which contains specific instructions to build and deploy pyrosetta.</li>
 +
</ol>
 +
 
 +
<h3>PyMOL</h3>
 +
 
 
                     <h4></h4>
 
                     <h4></h4>
 
                 </div>
 
                 </div>

Revision as of 01:40, 18 September 2015

Software

Mathematical Modelling

Give an overview of our GitHub code here.

PyRosetta and PyMOL

Installation Instructions

PyRosetta

Adapted from this guide.

PyRosetta is fairly simple to install on Windows, assuming Python is installed. However, it does take large amounts of RAM (you'll need a computer with >4GB), so you may need to use the Linux version for older computers.

  1. Download Python 2.7. You MUST use the 64-bit version, and make sure to select the option to add python to your path.
  2. Install iPython. Open a command prompt, and type python -m pip install ipython. This should download and install ipython in one step.
  3. Get pyreadline (Download the 64-bit version, pyreadline-2.0.win-amd64.exe). Run the exe once download is complete. This provides a bunch of tab-completion and other handy features, it isn't necessary, but is very helpful.
  4. Get a PyRosetta license. These are free for academic/non-commercial use.
  5. Once your license is processed (which should only take a couple minutes), you'll receive an email with a username and password, and a link to the download.
  6. Download the most recent version of the PyRosetta windows. You'll want the .exe for the latest release.
  7. When the download completes, run the exe to install PyRosetta.
  8. Two shortcuts should appear on the desktop, one for "iPython PyRosetta shell" and on for "PyMOL PyRosetta Link". Delete the second one, as it doesn't work with the version of PyMOL we'll be using.
  9. Open the ipython shell using the remaining shortcut. type:
    from rosetta import *
                rosetta.init()
                
  10. If you get a message ending with something like the following, you've successfully installed PyRosetta.
    core.init.random: RandomGenerator:init: Normal mode, seed=-1088387864 RG_type=mt19937

PyMOL

Adapted from this guide

  1. Create a folder (e.g. C:\PyMOL_Install) to hold the files>
  2. Download:
    • pymol-1.7.6.0-cp27-none-win_amd64.whl
    • pymol_launcher-1.0-cp27-none-win_amd64.whl
    • numpy-1.9.2+mkl-cp27-none-win_amd64.whl
    • Pmw-2.0.0-py2-none-any.whl
  3. Move the files to the folder you created.
  4. Start a command prompt, and move to the directory you saved the files in:
    cd C:\PyMOL_Install
  5. Assuming you added python to you path earlier, run the command:
    python -m pip install --no-index --find-link="%CD%" --pre pymol_launcher-1.0-cp27-none-win_amd64.whl
    1. If there are errors, try installing the .whl files in this order: numpy, Pmw, pymol-1.7.6.0, pymol_launcher
    2. If there are no errors, you should be able start PyMOL using C:\Python27\PyMOL.exe
  6. Create a shortcut on your desktop to make starting PyMOL easier.

Linking PyMOL and PyRosetta

Adapted from this guide.

  1. Start PyMOL
  2. In the command line (upper window), type
    run C:\Program Files\PyRosetta\PyMOLPyRosettaServer.py
  3. You should see a message just above saying:
    
                    PyMOL <---> PyRosetta link started!
                    at 127.0.0.1 port 65000
    If it doesn't work, check if PyRosetta installed to the above path (which it should have if you followed the instructions on this page). If the path is different, modify the run command to match.
  4. Go to the 'File' menu and select 'Edit pymolrc'.
  5. Add the same run command to the file, then save it. This will start the PyRosetta link automatically every time you run PyMOL.

PyRosetta

For Mac OSX (vanilla)

Adapted from this guide and this guide.

  1. A license must be obtained prior to installation, to obtain an academic license (it's free by the way) please visit this site to get one.
  2. After obtaining a license, go back to the download page and choose the PyRosetta monolith release for Mac. (NOTE: Do not use the download link provided in the license email for Linux and Mac installations! It does not include links to the latest version of PyRosetta.
  3. Create a new directory (new folder) in the space you'd like to install it (I would personally recommend creating a workspace directory and then un-tarring the pyrosetta.tar.bz2 in workspace, so the path to the .tar.bz2 file would be
    users/'YOURUSERNAME'/workspace/PyRosetta.monolith.mac.release-55.tar.bz2
  4. In the terminal type in
    tar -vjxf PyRosetta-monolith.mac.release-55.tar.bz2
    to un-tar the file, or alternatively just click on it to decompress it.
  5. Since Mac already comes with Python 2.7, python does not have to be installed. Open a terminal window and paste in
    cd ~/workspace/PyRosetta.monolith.mac.release-55
    to move to the PyRosetta directory.
  6. Once you're in the directory, start python by typing
    python
    in the terminal, and import the PyRosetta library with the following commands:
    import rosetta
    rosetta.init() 
    
  7. If no errors or complaints have been made by your machine, congratulations, you have just installed software that is notoriously difficult to install!

PyRosetta for Mac OSX with a Package Manager (e.g. Homebrew)

Unfortunately, for Mac users that use either homebrew, fink, or macports, PyRosetta must be built from source, since custom versions of python are used when one of the above are installed. If you don't know what homebrew, fink, or macports is, you probably don't have it installed so use the instructions above.

  1. Obtain an academic Rosetta License from here.
  2. Once you have a license and have been prompted to the download page, download the latest source version of Rosetta. At the moment it is Rosetta 2015.19.
  3. After downloading the .tgz and un-tarring rosetta into the directory of your choice, go into the directory where rosetta is in and find
    building.txt
    located in the following path
    main/source/src/python/bindings/
    which contains specific instructions to build and deploy pyrosetta.

PyMOL

Lab Team Calculators

Digest Calculator Ligation Calculator

Top