README.md 2.01 KB
Newer Older
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
1 2 3 4
## de Novo Ambiguous Restraints for Iterative Assignment

**A pipeline for automated de novo contact map assignment**

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
5
[![chat](https://img.shields.io/badge/chat-mattermost-informational.svg)](https://chatlab.pasteur.fr/bis-aria/channels/aria)
6
[![documentation](https://img.shields.io/badge/docs-latest-blue.svg)](http://bis-aria.pages.pasteur.fr/ariaec)
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
7 8 9
[![pipeline status](https://gitlab.pasteur.fr/bis-aria/ariaec/badges/master/pipeline.svg)](https://gitlab.pasteur.fr/bis-aria/ariaec/commits/master)
[![coverage report](https://gitlab.pasteur.fr/bis-aria/ariaec/badges/master/coverage.svg)](https://gitlab.pasteur.fr/bis-aria/ariaec/commits/master)

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
10

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
11 12
**ariaec**  is a [Python](https://www.python.org/) library that provides *de novo* structure prediction
based on [ARIA](http://aria.pasteur.fr/) pipeline and evolutionary restraints inferred from co-evolution.
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
13 14 15

The package add a new command line interface aside the usual ARIA commands in
order to convert data, setup an ARIA project with evolutionary restraints,
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
16
analyze contact maps or protein structures or generate statistics from a culled
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
17 18 19 20 21 22 23 24
list of PDB files.


## Quick Start

Be sure to check if the following packages are correctly installed with
your python installation or virtual environment.

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
25 26
- **pip** (>= 18.0)
- **git** (>= 2.0)
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
27
- **cns-solve** (1.21)
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
28 29
- **ccpnmr analysis** (optional)
- **ccpn data model** (optional)
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
30 31 32

Then the easiest solution is to call the **pip** command below :

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
33
   `pip install git+http://gitlab.pasteur.fr/bis-aria/ariaec.git`
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
34 35 36 37

For more information about installation and usage, please refer to the
[ARIAEC documentation](http://bis-aria.pages.pasteur.fr/ariaec)

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
38 39
**ARIA contains patches for CNS-solve which needs to be compiled after the
installation. Please follow [post installation instructions](http://bis-aria.pages.pasteur.fr/ariaec/installation.html#post-installation-instructions).**
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
40

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
41 42 43 44 45
    
## Contributing

Please read [guidelines for contributing](https://gitlab.pasteur.fr/bis-aria/ariaec/blob/master/CONTRIBUTING.md) for any
suggestions or bug report.