Metadata-Version: 2.1
Name: qdx-py
Version: 0.3.1
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.7
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

# QDX-py

Python bindings to qdx-commons, built with [maturin / py03](https://pyo3.rs).

``` 
NAME
    qdx_py - QDX-Common utilities for python

PACKAGE CONTENTS
    qdx_py

FUNCTIONS
    concat(conformer_1_contents, conformer_2_contents)
        Takes two conformer json strings and concatenates them
    
    conformer_to_pdb(conformer_contents)
        Returns the pdb string for a qdx conformer json string
    
    formal_charge(conformer_contents, strictness)
        Charges standard amino acids given a conformer json string,
    
    fragment(conformer_contents, backbone_steps, terminal_fragment_sidechain_size=Ellipsis)
        Fragments a conformer, updating the fragment formal charges based on existing atom charges
    
    pdb_to_conformer(pdb_contents, keep_residues=Ellipsis, skip_residues=Ellipsis)
        Converts a pdb string into an array of qdx conformers as a json string
```

## Usage

``` python
import qdx_py
# get json string of conformer
conformer = qdx_py.pdb_to_conformer(open("../qdx-common/tests/data/6mj7.pdb").read())
# get pdb of conformer
pdb = qdx_py.conformer_to_pdb(conformer)
```

## Developing

``` sh
~ setup venv
maturin develop
python
~ import qdx_py
```

