Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Saltzberg authored Nov 4, 2020
1 parent c93cc83 commit 39c70a3
Showing 1 changed file with 34 additions and 4 deletions.
38 changes: 34 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,42 @@
# imp_analysis_tutorial

This tutorial focuses on analyzing the results of integrative modeling.
This tutorial demonstrates the analysis of integrative modeling results using the [Integrative Modeling Platform](https://integrativemodeling.org) (IMP).

[./rnapolii](./rnapoliii) - Imporved analysis routine for the [PMI modeling tutorial](https://github.com/salilab/imp_tutorial) of the RNA Polymerase III stalk
[./rnapolii](./rnapoliii) - Improved analysis routine for the [PMI modeling tutorial](https://integrativemodeling.org/tutorials/rnapolii_stalk/) of the RNA Polymerase III stalk.

Citations: In review

### Installation and Dependencies
## Installation and Dependencies

### Introduction
### Getting the tutorial code and data
This tutorial can be downloaded from this page or the command line using `git clone github.com/salilab/imp_analysis_tutorial`

### Installing IMP and dependencies

The tutorial requires IMP v2.13 (April 2020) or later to run correctly.

---Using anaconda---
The simplest way to install and run IMP and this tutorial is using [anaconda](https://www.anaconda.com/products/individual).

Once installed, IMP and required dependencies can be installed using the following commands
```
conda install -c salilab imp pyrmsd
conda install numpy scikit-learn matplotlib pandas
conda install -c conda-forge hdbscan
```

---Using stand-alone IMP---
IMP [binaries or source code](https://integrativemodeling.org/download.html) are available for download.

Python 3.X is recommended to run IMP. Dependencies can be installed via `pip`:

```
pip install numpy scikit-learn matplotlib pandas hdbscan
```

A modified version of pyRMSD must be installed as well:
* [pyRMSD](https://github.com/salilab/pyRMSD)

## Running the tutorial

Navigate to `./rnapolii` and continue from the [rnapolii README](./rnapolii/README.md)

0 comments on commit 39c70a3

Please sign in to comment.