Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Cyrus recommends that all PDBs used with the Cyrus Engine API are first passed through this endpoint. prior to use.

Inputs

...

Table of Contents

Quickstart

Command Line Examples

Clean a PDB file

...

  • CLI argument: --pdb-file input.pdb

  • Python submit() argument: pdb-file="input.pdb"

Command Line Examples

Clean a PDB file::

Code Block
cyrus engine submit clean-pdb input_file.pdb

Clean a PDB from RCSB for chains A and B

Code Block
cyrus engine submit clean-pdb input_file.pdb--pdb-id 3hmx --chains A,B

Python Examples

Clean a PDB file:

Code Block
languagepy
from engine.clean_pdb.client import CleanPdbClient

client = CleanPdbClient()
job_id = client.submit(pdb_path="input.pdb")

Inputs

Either a PDB file or a published PDB ID (ex. 1ubq)

Options

  • --pdb-file

    • Input PDB file

    • CLI argument: --pdb-file input.pdb

    • Python submit() argument: pdb-file="input.pdb"

  • --pdb-id

    • PDB ID to download from RCSB (if not providing input PDB)

  • --chains

    • Comma separated list

    • List of chain IDs to include in output, or all to download all chains

    • default = all

Outputs

  • full_structure.pdb -- A cleaned PDB file