Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

BioBB_structure_checking performs MDWeb structure checking tool set as a command line utility.

Project description

Codacy Badge

Structure Checking from MDWeb

check_structure performs MDWeb structure checking set as a command line utility.

It includes some structure manipulation options like selecting models or chains, removing components of the system, completing missing atoms, and some quality checking as residue quirality, amide orientation, or vdw clashes.

usage: check_structure [-h] [-i INPUT_STRUCTURE_PATH]
                       [--file_format FILE_FORMAT] [--sequence FASTA_SEQ_PATH]
                       [--pdb_server PDB_SERVER] [--cache_dir CACHE_DIR_PATH]
                       [--res_lib RES_LIBRARY_PATH]
                       [--data_lib DATA_LIBRARY_PATH]
                       [-o OUTPUT_STRUCTURE_PATH] [--json JSON_OUTPUT_PATH]
                       [--quiet] [--limit ATOM_LIMIT] [--debug] [--force_save]
                       [--check_only] [--non_interactive] [--version]
                       command ...

positional arguments:
  command               Command to execute (help: check_structure commands)
  options               Specific command options

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT_STRUCTURE_PATH, --input INPUT_STRUCTURE_PATH Input structure. Formats PDB|mmCIF. Remote pdb:{pdbid}.
                        Biounits pdb:{pdbid}.{bn}. Biounits require MMB server
                        Output structure. PDB Format
                        Summary activities on a json file
  --file_format FILE_FORMAT
                        Format for retrieving structures (default=mmCif|pdb|xml)
  --sequence FASTA_SEQ_PATH
                        Canonical sequence in FASTA format, pdb_chain[,chain] in header
  --pdb_server PDB_SERVER
                        Remote server for retrieving structures (default|MMB)
  --cache_dir CACHE_DIR_PATH
                        Path for structure's cache directory (default: ./tmpPDB)
  --res_lib RES_LIBRARY_PATH
                        Override settings default residue library (AMBER prep format)
  --data_lib DATA_LIBRARY_PATH
                        Override settings default data library
  --quiet               Reduces output, removing labels and progress info
  --limit ATOM_LIMIT    Limit on number of atoms, 0: nolimit
  --debug               Add debug information
  --force_save          Force saving an output file even if no modification
  --check_only          Perform checks only, structure is not modified
  --non_interactive     Do not prompt for missing parameters
  --version             show program's version number and exit

Available commands:

commands:     Help on available commands
command_list: Run all tests from conf file
checkall:     Perform all checks without fixes
fixall:       Performs a default fix (v1.2)
load:         Stores structure on local cache and provide basic statistics

1. System Configuration
models [--select model_num]
    Detect/Select Models
chains [--select chain_ids]
    Detect/Select Chains
inscodes [--renum]
    Detects residues with insertion codes. No fix provided.
altloc [--select occupancy| alt_id | list of res_id:alt_id]
    Detect/Select Alternative Locations
metals [--remove All | None | Met_ids_list | Residue_list]
    Detect/Remove Metals
ligands [--remove All | None | Res_type_list | Residue_list]
    Detect/Remove Ligands
water [--remove Yes|No]
    Remove Water molecules
rem_hydrogen [--remove Yes|No]
    Remove Hydrogen atoms from structure
mutateside [--mut mutation_list] [--no_check_clashes]
    Mutate side chain with minimal atom replacement. Allows multiple mutations.
    Check generated clashes except --no_check_clashes set
add_hydrogen [--add_mode auto | pH | list | interactive | interactive_his] [--no_fix_side] [--keep_h]
    Add Hydrogen Atoms. Auto: std changes at pH 7.0. His->Hie. pH: set pH value
    list: Explicit list as [*:]HisXXHid, Interactive[_his]: Prompts for all selectable residues
    Fixes missing side chain atoms unless --no_fix_side is set
    Existing hydrogen atoms are remove before adding new ones unless --keep_h set.

2. Fix Structure Errors

amide  [--fix All|None|Residue List] [--no_recheck]
    Detect/Fix Amide atoms Assignment
    Amide contacts are recheck unless --no_recheck
chiral [--fix All|None|Residue List] [--no_check_clashes]
    Detect/Fix Improper quirality
    Checks generated clashes unless --no_check_clashes set
fixside [--fix All |None|Residue List] [--no_check_clashes]
    Complete side chains
    Checks generated clashes unless --no_check_clashes set
backbone [--fix_atoms All|None|Residue List]
         [--fix_main All|None|Break list]
         [--add_caps All|None|Break list]
    Analyze main chain missing atoms and fragments.
    --fix_atoms O, OXT atoms can be fixed
    --fix_main Missing fragments filled using comparative modelling (Modeller License needed)
    --add_caps Adds ACE and NME residues as necessary, preserving existing atoms
    Rechecks beckbone on each op unless --no_recheck is set.
    Generated clashes are checked unless --no_check_clashes

3. Structure Warnings

cistransbck Analyzes cis-trans dihedrals on backbone atoms
getss      Detect SS Bonds
clashes    Steric clashes (Severe, Apolar, Polar Donors, Polar Acceptors,
           Ionic Positive, Ionic Negative)


  • python 3.7
  • biopython 1.76
  • numpy
  • biobb_structure_manager 3.0.1
  • modeller 9.23 (optional)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for biobb-structure-checking, version 3.0.2
Filename, size File type Python version Upload date Hashes
Filename, size biobb_structure_checking-3.0.2-py3-none-any.whl (36.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size biobb_structure_checking-3.0.2.tar.gz (36.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page