README.rst 2.07 KB
Newer Older
1
=====================================================
2
3
4
5
6
de Novo Ambiguous Restraints for Iterative Assignment
=====================================================

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

7
8
9
10
11
12
13
14
.. image:: https://gitlab.pasteur.fr/bis-aria/ariaec/badges/master/pipeline.svg
   :target: https://gitlab.pasteur.fr/bis-aria/ariaec/commits/master
   :alt: Pipeline status

.. image:: https://gitlab.pasteur.fr/bis-aria/ariaec/badges/master/coverage.svg
   :target: https://gitlab.pasteur.fr/bis-aria/ariaec/commits/master
   :alt: Coverage report

15
16
17
18
.. image:: https://img.shields.io/badge/DOI-10.1093%2Fbioinformatics%2Fbtl589-blue.svg
   :target: https://doi.org/10.1093/bioinformatics/btl589
   :alt: DOI status

19

Fabrice Allain's avatar
Fabrice Allain committed
20
**ariaec**  is a Python_ library that provides *de novo* structure prediction
21
22
23
based on ARIA_ pipeline and evolutionary restraints inferred from co-evolution.


24
25
26
27
28
29
30
31
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,
analyze contact maps or protein structures and generate statistics from a culled
list of PDB files.


Quick Start
-----------
32

33
Be sure to check if the following packages are correctly installed with
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
34
your python installation or virtual environment.
35

Fabrice Allain's avatar
Fabrice Allain committed
36
37
38
* **pip** (>= 9.0)
* **setuptools** (>= 18.0)
* **numpy** (>= 1.11)
39

Fabrice Allain's avatar
Fabrice Allain committed
40
Then the easiest solution is to call the **pip** command below :
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
41

Fabrice Allain's avatar
Fabrice Allain committed
42
   ``pip install git+https://gitlab.pasteur.fr/bis-aria/ariaec``
43

44
For more information about installation and usage, please refer to the
Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
45
`ARIAEC documentation <http://bis-aria.pages.pasteur.fr/ariaec>`_.
46
47
48
49

Contributing
------------

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
50
Please read `guidelines for contributing <https://gitlab.pasteur.fr/bis-aria/ariaec/blob/master/CONTRIBUTING.md>`_ for any
51
52
suggestions or bug report.

53
54
55


.. Hyperlinks
56
57
.. _ZIP: https://gitlab.pasteur.fr/bis-aria/ariaec/repository/master/archive.zip
.. _TAR: https://gitlab.pasteur.fr/bis-aria/ariaec/repository/master/archive.tar
58
.. _Gitlab: https://gitlab.pasteur.fr/bis-aria/ariaec
59
60
.. _ARIA: http://aria.pasteur.fr
.. _Python: https://www.python.org