Skip to content
Snippets Groups Projects
Commit f7db4b88 authored by Studer Gabriel's avatar Studer Gabriel
Browse files

Edit README.md

parent 1b75756d
Branches
Tags
No related merge requests found
OpenStructure - A computational structural biology framework
============================================================
# OpenStructure - A computational structural biology framework
OpenStructure provides a modular, flexible, molecular modelling environment
which allows to integrate, process and visualize information of different origin
......@@ -14,6 +13,46 @@ Please do not hesitate to contact us for feedback or troubleshooting:
openstructure-users@maillist.unibas.ch
## OpenStructure Installation
OpenStructure is developed and tested across various Linux distributions. You can find detailed build instructions and a list of required dependencies here:
https://openstructure.org/docs/dev/install/
### Prefer Not to Compile it Yourself?
For a simple and portable setup, we recommend using a containerized
solution. OpenStructure provides its own Docker container registry,
making deployment easier.
### Containerized Solutions:
* Docker: [OpenStructure Docker Instructions](https://git.scicore.unibas.ch/schwede/openstructure/tree/master/docker)
* Singularity: [OpenStructure Singularity Instructions](https://git.scicore.unibas.ch/schwede/openstructure/tree/master/singularity)
## Getting started
The installation and container instructions will help you set up
OpenStructure for scripting. Additionally, here are some advanced
use cases worth highlighting.
### Benchmarking and Scoring
OpenStructure implements a benchmarking suite for comparing macromolecular
complexes. To get started, check out the examples in the `examples/scoring`
directory of this repository.
### Modeling
ProMod3 is a fully featured modeling engine built on top of OpenStructure.
It powers the SWISS-MODEL web server and provides advanced modeling
capabilities. Learn more here:
[ProMod3 Documentation](https://openstructure.org/promod3)
## Cite Us
If you like our software and have used it in your research project, please cite
the following paper on OpenStructure:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment