Skip to main content

A light-weight software package with expertise in handling Reaction Data and Molecular (including transitions states) Conformers.

Project description

RDMC Logo

Reaction Data and Molecular Conformer

Documentation CI codecov Anaconda Cloud PyPI MIT license

A light-weight software package with expertise in handling Reaction Data and Molecular (including transitions states) Conformers.

Installation

The package can be easily installed with conda or mamba with

conda install -c xiaoruidong rdmc

You can also install RDMC from the source code:

git clone https://github.com/xiaoruidong/rdmc;
cd RDMC;
conda env create -f environment.yml;
conda activate rdmc;
python -m pip install -e --no-deps -vv ./;

There are two major modules in RDMC:

rdtools

It has a collections of functions that can be directly operated on to RDKit native objects. Most of them can be regarded as a modified version of a RDKit native operation but with simplified imports, more intuitive usage, and more robustness implementation. They are distributed in submodules, each named by its relevance field and objects. It is best used in cases where efficiency is a major conern and the task you required is relatively simple. Here are some highlights in rdtools:

  • viewers in rdtools.view. These viewers greatly extend RDKit's default Ipython 3D viewer, with the capability of viewing animations and interaction with conformers.
  • generate_resonance_structures in rdtools.resonance is able to generate resonance structures for radical molecules that is not capable by the original RDKit.
  • mol_from_smiles in rdtools.conversion make sure the created molecule has an atom ordering consistent with the atom mapping
  • mol_from_xyz supports two backends openbabel as well as xyz2mol for molecule connectivity perception. If both native backends fail (e.g., cannot be sanitized, or wrong charge or multiplicity), rdtools also provided a heuristic fix tool fix_mol in rdtools.fix to help fix the molecules if possible.

rdmc

It can be regarded as a midware between RDKit/rdtools basic operations and complicated workflows. Mol (Previously, RDKitMol) and Reaction are the most important classes.

  • Mol (known as RDKitMol previously) is a child class of RWMol, which means that you can directly use it with RDKit's native functions, but also integrated a lot of tools in rdtools, so you can directly use them as class methods. The appended methods not only provides convenience in usage, but also make sure the output molecule objects, if applicable, is still a rdmc.Mol object. While many RDKit functions will just output Chem.Mol which is no longer editable, breaking the flow of your molecule operations.
  • Reaction provides intuitive APIs for getting bond analysis, reaction comparison, visualization, etc.

For detailed APIs, please check the documentation.

Demos

Feel free to check demos in the ipython/, some of them are also available on the Google Colab:

Requirements

  • To use rdtools, you only needs numpy and rdkit at minimum. You can install optional dependencies: scipy for better resonance structure generation for polycyclic molecules, py3dmol to use the amazing 3D viewers, openbabel to extend rdmc's xyz perception cability.
  • To use rdmc, the dependencies are basically the same as rdtools, but we do recommend installing all optional dependencies for a better experience. Besides, to plot curves and figures for data, you can install matplotlib; to play around with the log parsers you should consider install cclib and ipywidgets. And to start computations in conformer_generation, you need to have xtb and orca (which are free to academia) installed to get some serious results.

Project details


Download files

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

Source Distribution

rdmc-1.0.0.tar.gz (210.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rdmc-1.0.0-py3-none-any.whl (280.6 kB view details)

Uploaded Python 3

File details

Details for the file rdmc-1.0.0.tar.gz.

File metadata

  • Download URL: rdmc-1.0.0.tar.gz
  • Upload date:
  • Size: 210.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for rdmc-1.0.0.tar.gz
Algorithm Hash digest
SHA256 41080ffcdeb7dae029db52238ad67383929697f34c58dec4790ee531b76fe5b1
MD5 48d1d13843eb128e8af369977771b753
BLAKE2b-256 208fe68a9d8f428e882230a264b9b49747f71c08da4ea74d2f910c375b0bb9c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for rdmc-1.0.0.tar.gz:

Publisher: pypi_build.yaml on xiaoruiDong/RDMC

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rdmc-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: rdmc-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 280.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for rdmc-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a4c864ea207b61edbf9b987e3806558c0efa4b8d1dcce877bdb6af45f20138c
MD5 625738bf36a2ce07b7d9b74559bf8400
BLAKE2b-256 e44194d83a51ea615ce6467e588cf7f8fd8284ccc7a8acdac1b6f8431f23686d

See more details on using hashes here.

Provenance

The following attestation bundles were made for rdmc-1.0.0-py3-none-any.whl:

Publisher: pypi_build.yaml on xiaoruiDong/RDMC

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page