Difference between revisions of "Team:Waterloo/Software"

(Added Mac PyRosetta Install Instructions)
(Added Linux PyMOL and PyRosetta Install Instruction, and section for using Waterloo team scripts)
Line 140: Line 140:
 
                     <div class="panel-body">
 
                     <div class="panel-body">
 
                     <h3>PyRosetta</h3>
 
                     <h3>PyRosetta</h3>
−
 
+
<p> Please ensure you're running at 64-bit version of Ubuntu or your preferred Linux flavour, as PyRosetta is available in 64-bit only.</p>
−
                    FILL IN HERE
+
<ol>
 +
<li>Installing iPython first is useful, as it allows much easier interaction with PyRosetta: <pre><code>sudo apt-get install ipython</code></pre></li>
 +
<li><a href="http://www.pyrosetta.org/dow">Download the latest release.namespace build for Ubuntu (you will have to <a href="https://els.comotion.uw.edu/express_license_technologies/pyrosetta">sign up</a> for a free academic license).</li>
 +
<li>Place the file where you want to use it (Note: Somewhere convenient to access, such as the your home folder, is recommened since you will be running files from this folder each time to use PyRosetta/PyRosetta+PyMOL).</li>
 +
<li>In terminal, navigate to the folder above, and use <pre><code>tar -vjxf PyRosetta-<version>.tar.bz2</code></pre> to extract the file.</li>
 +
<li>Run the script which sets up your environment by typing <pre><code>source SetPyRosettaEnvironment.sh</code></pre> while in the PyRosetta folder. This must be done each time you want to use Rosetta.</li>
 +
<li>Open IPython (ipython) and try running PyRosetta to see that it set up properly: <pre><code>import rosetta
 +
rosetta.init()</code></pre>.</li>
 +
</ol>
  
 
                     <h3>PyMOL</h3>
 
                     <h3>PyMOL</h3>
 +
 +
<p>Run this command in terminal: <pre><code>sudo apt-get install pymol</code></pre></p>
 +
 +
<p>This will install the version of PyMOL which is hosted on Ubuntu's package directory. This is not the newest version, but it's reasonably up-to-date, and this method has the added bonus of automatically installing all dependencies that are need for PyMOL.</p>
 +
 
                     <h4></h4>
 
                     <h4></h4>
 
                 </div>
 
                 </div>
 
             </div>
 
             </div>
 
             <div class="panel panel-default">
 
             <div class="panel panel-default">
−
                 <div class="panel-heading" role="tab" id="mac-install">
+
                 <div class="panel-heading" role="tab" id="source-install">
 
                     <h4 class="panel-title">
 
                     <h4 class="panel-title">
 
                     <a role="button" data-toggle="collapse" data-parent="#accordion" href="#source-collapse" aria-expanded="false" aria-controls="source-collapse">
 
                     <a role="button" data-toggle="collapse" data-parent="#accordion" href="#source-collapse" aria-expanded="false" aria-controls="source-collapse">
Line 160: Line 173:
  
 
                     FILL IN HERE
 
                     FILL IN HERE
 +
 +
                </div>
 +
            </div>
 +
 +
            <div class="panel panel-default">
 +
                <div class="panel-heading" role="tab" id="waterloo-scripts">
 +
                    <h4 class="panel-title">
 +
                    <a role="button" data-toggle="collapse" data-parent="#accordion" href="#waterloo-collapse" aria-expanded="false" aria-controls="waterloo-collapse">
 +
                    Using Waterloo Scripts
 +
                    <span class="hidden-xs toggle-arrow pull-right">Panel Toggle</span>
 +
                    </a>
 +
                    </h4>
 +
                </div>
 +
                <div id="waterloo-collapse" class="panel-collapse collapse" role="tabpanel" aria-labelledby="waterloo-scripts">
 +
                    <div class="panel-body">
 +
<h3>Recommended Directory Structure</h3>
 +
 +
<p>The scripts developed by the Waterloo iGEM team can be called from different computers without errors using the following directory structure:</p>
 +
<ol>
 +
<li>In the same directory as the PyRosetta folder, create another folder called working.</li>
 +
<li>Within the working directory create folders pdb/, results/, and scripts/</li>
 +
<li>Create subdirectories pdb/wt/, results/batch/, and results/batch/log/</li>
 +
<li>Download the files dock_variants.py, results.csv, and dock_caller.sh into the scripts directory.</li>
 +
</ol>
 +
<p>This sets up a directory structure that scripts can be called from different computers without errors.</p>
  
 
                 </div>
 
                 </div>

Revision as of 02:16, 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

PyRosetta

Please ensure you're running at 64-bit version of Ubuntu or your preferred Linux flavour, as PyRosetta is available in 64-bit only.

  1. Installing iPython first is useful, as it allows much easier interaction with PyRosetta: 
    sudo apt-get install ipython
  2. Download the latest release.namespace build for Ubuntu (you will have to sign up for a free academic license).
  3. Place the file where you want to use it (Note: Somewhere convenient to access, such as the your home folder, is recommened since you will be running files from this folder each time to use PyRosetta/PyRosetta+PyMOL).
  4. In terminal, navigate to the folder above, and use 
    tar -vjxf PyRosetta-.tar.bz2
    to extract the file.
  5. Run the script which sets up your environment by typing 
    source SetPyRosettaEnvironment.sh
    while in the PyRosetta folder. This must be done each time you want to use Rosetta.
  6. Open IPython (ipython) and try running PyRosetta to see that it set up properly: 
    import rosetta
rosetta.init()
    .

PyMOL

Run this command in terminal: 

sudo apt-get install pymol

This will install the version of PyMOL which is hosted on Ubuntu's package directory. This is not the newest version, but it's reasonably up-to-date, and this method has the added bonus of automatically installing all dependencies that are need for PyMOL.

FILL IN HERE

Recommended Directory Structure

The scripts developed by the Waterloo iGEM team can be called from different computers without errors using the following directory structure:

  1. In the same directory as the PyRosetta folder, create another folder called working.
  2. Within the working directory create folders pdb/, results/, and scripts/
  3. Create subdirectories pdb/wt/, results/batch/, and results/batch/log/
  4. Download the files dock_variants.py, results.csv, and dock_caller.sh into the scripts directory.

This sets up a directory structure that scripts can be called from different computers without errors.

Lab Team Calculators

Digest Calculator Ligation Calculator

Top