/SPyCi-PDB

Structural Python (Back) Calculator Interface for PDBs

Primary LanguagePythonApache License 2.0Apache-2.0

SPyCi-PDB

https://github.com/julie-forman-kay-lab/SPyCi-PDB/blob/0e7b60d50a021d741dd7db4e2b9fbb9605fec95b/docs/spycipdb_ascii1.png

Test Status Documentation Status JOSS Paper Zenodo Archive

Structural Python (Back) Calculator Interface for PDBs

Goal: User friendly Python3 based interface to generate back-calculated experimental data for singular and multiple (ensembles of) PDB structures.

Back-Calculators: The current back calculators integrated are:

  1. PRE, NOE, J-Coupling, smFRET: Internal
  2. Chemical shifts (CS): UCBShift
  3. SAXS: CRYSOLv3
  4. Hydrodynamic Radius (Rh): HullRad
  5. Residual Dipolar Couplings (RDC): PALES

Please note for third-party software, installation instructions have been fully documented and tested for Linux Ubuntu Focal Fossa (20.04.X LTS) and Bionic Beaver (18.04.X LTS).

To make new requests and/or additions, please see docs/contributing.rst.

Developer Notes: project CI based on @joaomcteixeira's Python-Project-Skeleton template. Developed as a standalone program with integration into the IDPConformerGenerator platform in mind.

Documentation

More detailed documentation can be found at: https://spyci-pdb.readthedocs.io/en/stable/

Within the repository you can find:

  1. Installation instructions in docs/installation.rst.
  2. Usage instructions in docs/usage.rst.
  3. See also the examples in the example/ folder.

How to Cite

If you use SPyCi-PDB, please cite:

Liu et al., (2023). SPyCi-PDB: A modular command-line interface for back-calculating experimental datatypes of protein structures.. Journal of Open Source Software, 8(85), 4861, https://doi.org/10.21105/joss.04861

Version

v0.3.15