Skip to main content

CodeFactor PYPi GitHub ccdutils documentation ccdutils tests PyPI Downloads

pdbeccdutils

An RDKit-based python toolkit for parsing and processing small molecule definitions in wwPDB Chemical Component Dictionary and wwPDB The Biologically Interesting Molecule Reference Dictionary.pdbeccdutils provides streamlined access to all metadata of small molecules in the PDB and offers a set of convenient methods to compute various properties of small molecules using RDKIt such as 2D depictions, 3D conformers, physicochemical properties, matching common fragments and scaffolds, mapping to small-molecule databases using UniChem.

Features

  • gemmi CCD read/write.
  • Generation of 2D depictions (No image available generated if the flattening cannot be done) along with the quality check.
  • Generation of 3D conformations.
  • Fragment library search (PDBe hand-curated library, ENAMINE, DSI).
  • Chemical scaffolds (Murcko scaffold, Murcko general, BRICS).
  • Lightweight implementation of parity method by Jon Tyzack.
  • RDKit molecular properties per component.
  • UniChem mapping.
  • Generating complete representation of multiple Covalently Linked Components (CLC)

Dependencies

  • RDKit for small molecule representation. Presently tested with 2023.9.6
  • GEMMI for parsing mmCIF files.
  • scipy for depiction quality check.
  • numpy for molecular scaling.
  • networkx for bound-molecules.

Installation

create a virtual environment and install using pip

pip install pdbeccdutils

Contribution

We encourage you to contribute to this project. The package uses poetry for packaging and dependency management. You can develop locally using:

git clone https://github.com/PDBeurope/ccdutils.git
cd ccdutils
pip install poetry
poetry install --with tests,docs
pre-commit install

The pre-commit hook will run linting, formatting and update poetry.lock. The poetry.lock file will lock all dependencies and ensure that they match pyproject.toml versions.

To add a new dependency

# Latest resolvable version
poetry add <package>

# Optionally fix a version
poetry add <package>@<version>

To change a version of a dependency, either edit pyproject.toml and run:

poetry sync --with dev

or

poetry add <package>@<version>

Documentation

The documentation is generated using sphinx in sphinx_rtd_theme and hosted on GitHub Pages. To generate the documentation locally,

cd doc
poetry run sphinx-build -b html . _build/html

# See the documentation at http://localhost:8080.
python -m http.server 8080 -d _build/html

Metadata

Release files for pdbeccdutils 2.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pdbeccdutils 2.0.0
File Size Uploaded
pdbeccdutils-2.0.0.tar.gz 1.0 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for pdbeccdutils 2.0.0
File Interpreter ABI Platform
pdbeccdutils-2.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 2.2 MB

Release files / pdbeccdutils-2.0.0.tar.gz

Download URL pdbeccdutils-2.0.0.tar.gz
Size 1.0 MB
Tags Source
SHA-256 checksum
How to use checksums
8edfc396710b7e888e1beb20209c1de8e71714a33afa10961d0be0da23c1d682
BLAKE2b-256 checksum
How to use checksums
91860145048f3822a1949b4d61c3ecdb9549dc72cfff9d31737e84aee090bfaa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / pdbeccdutils-2.0.0-py3-none-any.whl

Download URL pdbeccdutils-2.0.0-py3-none-any.whl
Size 1.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
2bdc9db7ec0d3d691a7f6bc8786f051bf490df636ae19b088962c1536c86aa1e
BLAKE2b-256 checksum
How to use checksums
f9c9ed045edd1b45b37582bbba4021e15165876b71a57184b6ff05806d61341d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

2.0.0 This release

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.8.6

2 release files

0.8.5

2 release files

0.8.4

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6

2 release files

0.5.10

2 release files

0.5.9

2 release files

0.5.8

1 release file

0.5.7

1 release file

0.5.6

1 release file

0.5.5

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page