Disclaimer

This is a slightly refactored version of the original code by Harry Jubb. Main changes are:

Python 3 support
Modular architecture to make Arpeggio PIP installable.
Support for mmCIF format to process also larger structures.
Results in JSON format.
Few bug fixes

Outline

Arpeggio calculates interatomic contacts based on the rules defined in CREDO. The program is freely available and requires only Open Source dependencies.

If you make use of Arpeggio, please cite the following article:

Harry C Jubb, Alicia P Higueruelo, Bernardo Ochoa-Montaño, Will R Pitt, David B Ascher, Tom L Blundell, Arpeggio: A Web Server for Calculating and Visualising Interatomic Interactions in Protein Structures. Journal of Molecular Biology, Volume 429, Issue 3, 2017, Pages 365-371, ISSN 0022-2836,

Getting Started

Web Interface

If you would like to run original version of Arpeggio on a small number of individual structures, the easiest way to get started is to use the web interface.

Dependencies

Arpeggio is written in Python and currently has the following dependencies:

Python (v3.6)
Numpy
BioPython (>= v1.60)
OpenBabel (with Python bindings)
PDBeCIF

If you need to use Arpeggio programmatically or to run for many structures:

The easiest way to set up with Arpeggio is using Conda. In your conda environment run the two following commands:

conda install -c openbabel openbabel
pip install git+https://github.com/PDBeurope/arpeggio.git@master#egg=arpeggio

To create conda environment please use e.g. the following command:

conda create conda -n arpeggio-env python=3.7

and activate it:

conda activate arpeggio-env

Running

arpeggio 1tqn_h.cif [options]

e.g.

arpeggio -s /A/508/ -o out/ 1tqn_h.cif

Use arpeggio -h for available options.

Arpeggio doesn't do any checking of your PDB structure, other than what BioPython does by default. Alternate locations and missing density are not explicitly accounted for and may result in anomalous results. Please use with caution.

Output

The only output presently available is in the JSON format with all the contacts given.

Interactions

atom-atom interactions

Key	Interaction	Description
clash	Clash	Denotes if the atom is involved in a steric clash.
covalent	Covalent	Denotes if the atom appears to be covalently bonded.
vdw_clash	VdW Clash	Denotes if the van der Waals radius of the atom is clashing with one or more other atoms.
vdw	VdW	Denotes if the van der Waals radius of the the atom is interacting with one or more other atoms.
proximal	Proximal	Denotes if the atom is > the VdW interaction distance, but within 5 Angstroms of other atom(s).
hbond	Hydrogen Bond	Denotes if the atom forms a hydrogen bond.
weak_hbond	Weak Hydrogen Bond	Denotes if the atom forms a weak hydrogen bond.
xbond	Halogen Bond	Denotes if the atom forms a halogen bond.
ionic	Ionic	Denotes if the atom may interact via charges.
metal	Metal Complex	Denotes if the atom is part of a metal complex.
aromatic	Aromatic	Denotes an aromatic ring atom interacting with another aromatic ring atom.
hydrophobic	Hydrophobic	Denotes hydrophobic interaction.
carbonyl	Carbonyl	Denotes a carbonyl-carbon:carbonyl-carbon interaction.
polar	Polar	Less strict hydrogen bonding (without angle terms).
weak_polar	Weak Polar	Less strict weak hydrogen bonding (without angle terms).

atom-plane interactions

Key	Interaction	Description
CARBONPI	Carbon-PI	Weakly electropositive carbon atom - $\Pi$ interactions [ref]
CATIONPI	Cation-PI	Cation - $\Pi$ interactions [ref]
DONORPI	Donor-PI	Hydrogen Bond donor - $\Pi$ interactions [ref]
HALOGENPI	Halogen-PI	Halogen bond donors - $\Pi$ [ref]
METSULPHURPI	Sulphur-PI	Methionine sulphur - $\Pi$ ring interactions [ref]

plane-plane interactions

Follows nomenclature established by Chakrabarti and Bhattacharyya (2007)

group-group/plane interactions

Key	Interaction	Description
AMIDEAMIDE	amide - amide	[ref]
AMIDERING	amide - ring	[ref]

Interacting entities

Key	Meaning
INTER	Between an atom from the user's selection and a non-selected atom
INTRA_SELECTION	Between two atoms both in the user's selection
INTRA_NON_SELECTION	Between two atoms that are both not in the user's selection
SELECTION_WATER	Between an atom in the user's selection and a water molecule
NON_SELECTION_WATER	Between an atom that is not in the user's selection and a
WATER_WATER	Between two water molecules

Examples

atom-atom interaction

   {
        "bgn": {
            "auth_asym_id": "A",
            "auth_atom_id": "CB",
            "auth_seq_id": 313,
            "label_comp_id": "VAL",
            "pdbx_PDB_ins_code": " "
        },
        "contact": [
            "proximal",
            "hydrophobic"
        ],
        "distance": 4.02,
        "end": {
            "auth_asym_id": "A",
            "auth_atom_id": "CBB",
            "auth_seq_id": 508,
            "label_comp_id": "HEM",
            "pdbx_PDB_ins_code": " "
        },
        "interacting_entities": "INTER",
        "type": "atom-atom"
    },

atom-plane interaction

    {
        "bgn": {
            "auth_asym_id": "A",
            "auth_atom_id": "O",
            "auth_seq_id": 523,
            "label_comp_id": "HOH",
            "pdbx_PDB_ins_code": " "
        },
        "contact": [
            "DONORPI"
        ],
        "distance": 3.9,
        "end": {
            "auth_asym_id": "A",
            "auth_atom_id": "C1A,C2A,C3A,C4A,NA",
            "auth_seq_id": 508,
            "label_comp_id": "HEM",
            "pdbx_PDB_ins_code": " "
        },
        "interacting_entities": "INTER",
        "type": "atom-plane"
    },

plane-plane interaction

{
        "bgn": {
            "auth_asym_id": "A",
            "auth_atom_id": "C1B,C2B,C3B,C4B,NB",
            "auth_seq_id": 508,
            "label_comp_id": "HEM",
            "pdbx_PDB_ins_code": " "
        },
        "contact": [
            "FT",
            "ET"
        ],
        "distance": 4.72,
        "end": {
            "auth_asym_id": "A",
            "auth_atom_id": "CD1,CD2,CE1,CE2,CG,CZ",
            "auth_seq_id": 435,
            "label_comp_id": "PHE",
            "pdbx_PDB_ins_code": " "
        },
        "interacting_entities": "INTER",
        "type": "plane-plane"
    },

group-group interaction

    {
        "bgn": {
            "auth_asym_id": "A",
            "auth_atom_id": "C,CA,N,O",
            "auth_seq_id": 308,
            "label_comp_id": "GLU",
            "pdbx_PDB_ins_code": " "
        },
        "contact": [
            "AMIDEAMIDE"
        ],
        "distance": 4.29,
        "end": {
            "auth_asym_id": "A",
            "auth_atom_id": "C,CA,N,O",
            "auth_seq_id": 310,
            "label_comp_id": "THR",
            "pdbx_PDB_ins_code": " "
        },
        "interacting_entities": "INTRA_BINDING_SITE",
        "type": "group-group"
    },

sonnybrilliant / arpeggio