Open Source Protein REdesign for You v3
Clone or download
Latest commit 71ac7f0 Dec 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Fixed numConfsPerBatch to match BBKStar Dec 10, 2018
gradle/wrapper convert from Jerkar build system to Gradle+Kotlin, and redo python dists Jul 17, 2017
python fix python wrapper. Nov 29, 2018
resources implement probe-style rules for analyzing non-bonded atomic interactions Jul 31, 2018
src/edu/duke/cs/osprey Revert "Making sure all posNum references have been uppercased" - lat… Dec 11, 2018
test-resources Convenience features Oct 23, 2018
test/edu/duke/cs/osprey Fix MSKStarLab. Dec 3, 2018
.gitignore update ignore list Jul 17, 2017
.travis.yml Started to fix errors Jul 9, 2018
CITING_OSPREY.txt Started to fix errors Jul 9, 2018
CONTRIBUTING.rst Started to fix errors Jul 9, 2018
LICENSE.txt change license to GPLv2 Dec 5, 2017
README.rst Started to fix errors Jul 9, 2018
build.gradle.kts study dihedral angles and rotamers in the top8000 dataset Aug 17, 2018
ewakStar.filteredSeqs.txt Fixing conformation & sequence counting Nov 28, 2018
gradlew Hack to avoid race condition for updating energy matrices Sep 23, 2018
gradlew.bat convert from Jerkar build system to Gradle+Kotlin, and redo python dists Jul 17, 2017
ligand.minimizing.emat Fixed numConfsPerBatch to match BBKStar Dec 10, 2018
ligand.rigid.emat Fixed numConfsPerBatch to match BBKStar Dec 10, 2018
osprey3_todo.txt add todo items Feb 17, 2017
upload.sh think I did the secret sauce wrong, maybe this will work? Feb 19, 2018

README.rst

OSPREY

Open-Source Protein REdesign for You

OSPREY is developed and maintained by the Donald Lab in the Department of Computer Science at Duke University.

For an introduction to OSPREY 3.0 and its new features please read this paper (accepted to the Journal of Computational Chemistry, 2018): https://www.biorxiv.org/content/early/2018/04/23/306324

Citation requirements

We require everyone who publishes or presents results from OSPREY to please mention the name "OSPREY," and to cite our papers as described in CITING_OSPREY.txt (especially our new paper introducing OSPREY 3.0).

License

GPLv2

Copyright (C) 2017 Duke University

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

The full text of the GPLv2 is included in the accompanying LICENSE.txt

Installation

on Windows:

Make sure you're running 64-bit Windows. Osprey is not supported on 32-bit Windows.

  1. Install Python 2.7 x86-64, choose the Windows x86-64 MSI Installer option, not Python 3+ or 32-bit version.
  2. During Python installation, enable the option to Add python.exe to Path.
  3. Install Java 8 64-bit, choose the Windows Offline (64-bit) option, not 32-bit version.
  4. After installing Java, add the C:\Program Files\Java\jre1.8.0_151\bin folder to your PATH environment variable. (See how to set the PATH Environment Variable) Be sure to replace the jre1.8.0_151 part with the actual Java installation folder on your computer. Tragically, the Java installer does not do this for you.
  5. Download the newest Osprey Python release (not the source files) and extract it to your favorite folder.
  6. Run the install batch script to install Osprey.

on Debian-like Linux:

Including distributions like Ubuntu and Mint

Make sure you're running 64-bit Linux. Osprey is not supported on 32-bit Linux.

  1. Install prerequisites:

    $ sudo apt-get install python2.7 python-pip openjdk-8-jre
    
  2. Download the newest Osprey Python release (not the source files) and extract it to your favorite folder.

  3. Run the install shell script to install Osprey:

    $ ./install.sh
    

manually using pip:

The install scripts use pip internally to install the Python package. If you want to customize the installation of the python package, you can ingore the install scripts and call pip directly. First download the newest Osprey Python release and extract it to your favorite folder. Then call pip:

$ pip2 install osprey --no-index --use-wheel --find-link=wheelhouse

Upgrading from an older version

If you're upgrading from an older installation of Osprey, just run the install script. There's no need to explicitly uninstall the older version.

Uninstallation

To uninstall Osprey, use the provided shell script.

on Windows:

> uninstall.bat

on Linux or Mac:

$ ./uninstall.sh

Running Osprey

using Python scripts

Python scripting is the preferred way of using Osprey due to its simplicity and flexibilty. To run Osprey from a Python script:

import osprey
osprey.start()

# run osprey commands, e.g.
osprey.printGpuInfo()

For more information about Python scripting with Osprey, see the tutorial at doc/tutorial.html in the distribution zip or the Python documentation at doc/api.osprey.html.

TODO: add links to online docs (eg tutorials, references)

using the command-line interface

The Python interface to Osprey represents a significant improvement in the user interface over the older command-line interface, and new Osprey projects should consider using the Python interface rather than the command-line interface.

However, for backwards compatibility, the command-line interface is still provided, although it may not receive feature updates in the future. It may eventually be removed from Osprey.

To access the command-line interface, download the Osprey Java distribution. Extract it to your favorite folder, then enter the following command into a shell:

$ cd bin
$ ./osprey [commands]

where [commands] are the Osprey commands you want to run. You can run Osprey without [commands] and Osprey will print a list of the available commands.

To show the version of your Osprey installation, try:

$ ./osprey version

To run a GMEC-based protein design, try:

$ ./osprey FindGMEC /path/to/config1 /path/to/config2 ...

To show GPU informatino, try:

$ ./osprey GPUInfo

The GpuInfo command prints info about available GPUs in the system, and which ones Osprey can use.

Contributing

Osprey is open-source software and contributions are welcome.

See the guide for contributors to see how to compile and package Osprey.