sPyRMSD
Python tool for symmetry-corrected RMSD calculations.
If you find spyrmsd useful, please consider citing the following paper:
@article{spyrmsd2020,
Author = {Meli, Rocco and Biggin, Philip C.},
Journal = {Journal of Cheminformatics},
Number = {1},
Pages = {49},
Title = {spyrmsd: symmetry-corrected RMSD calculations in Python},
Volume = {12},
Year = {2020}
}
Installation
spyrmsd is available on PyPI and conda-forge and can be easily installed from source. See Dependencies for a description of all the dependencies.
Note: spyrmsd will install NetworkX (multi-platform). You can install graph-tool on macOS and Linux for higher performance.
PyPI
pip install spyrmsd
conda
conda install spyrmsd -c conda-forge
GitHub
git clone https://github.com/RMeli/spyrmsd.git
cd spyrmsd
pip install .
Dependencies
spyrmsd can be used both as a module or as a standalone tool.
Module
The following packages are required to use spyrmsd as a module:
Note: spyrmsd uses graph-tool by default but will fall back to NetworkX if the former is not installed (e.g. on Windows). However, in order to support cross-platform installation NetworkX is installed by default.
Standalone Tool
Additionally, one of the following packages is required to use spyrmsd as a standalone tool:
Note: RDKit is not available on PyPI (Why the RDKit isn't available on PyPi). See RDKit Installation for installation instructions.
Usage
Standalone
python -m spyrmsd.spyrmsd -h
usage: spyrmsd.py [-h] [-m] [-c] [--hydrogens] [-n] reference molecules [molecules ...]
Python RMSD tool.
positional arguments:
reference Reference file
molecules Input file(s)
optional arguments:
-h, --help show this help message and exit
-m, --minimize Minimize (fit)
-c, --center Center molecules at origin
--hydrogens Keep hydrogen atoms
-n, --nosymm No graph isomorphism
Module
from spyrmsd import rmsd
RMSD
The function rmsd.rmsd computes RMSD without symmetry correction. The atoms are expected to be in the same order for both molecules being compared (no atom matching is performed).
Symmetry-Corrected RMSD
The function rmsd.symmrmsd computes symmetry-corrected RMSD using molecular graph isomorphisms. Symmetry correction requires molecular adjacency matrices describing the connectivity but needs not the atoms to be in the same order.
Atom matching is performed according to the molecular graph. Therefore, this function should be used when atoms in the molecules being compared are not in the same order (even if there is not symmetry).
Development
To ensure code quality and consistency the following tools are used during development:
Copyright
Copyright (c) 2019-2020, Rocco Meli.
References
References are tracked with duecredit. Run the credits.sh script in order to print up-to-date references.
Acknowledgements
Project based on the Computational Molecular Science Python Cookiecutter version 1.1.
Metadata
Release files for spyrmsd 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| spyrmsd-0.4.0.tar.gz | 224.8 kB | Without provenance | Details for spyrmsd-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| spyrmsd-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for spyrmsd-0.4.0-py3-none-any.whl |
Total release size: 252.8 kB
Release files / spyrmsd-0.4.0.tar.gz
| Download URL | spyrmsd-0.4.0.tar.gz |
|---|---|
| Size | 224.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e3684dbb7fa354751fc3c0024276937e501fcf98c7c2ff34b515d659291393e5
|
|
BLAKE2b-256 checksum How to use checksums |
cdebe6616147d98cecdccfd1d8b0d15c0cb697217eee36e72a43d647f6a9df9c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.24.0
|
Release files / spyrmsd-0.4.0-py3-none-any.whl
| Download URL | spyrmsd-0.4.0-py3-none-any.whl |
|---|---|
| Size | 28.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d5ac6c0c3e2fc416996b72c415a78a22512a7e0ddaf3261d49f7ddb1f558dc96
|
|
BLAKE2b-256 checksum How to use checksums |
cdb1df4a15079bd939eb4fc61318ba89fbb6d7af254ee575dc23b7a1e0c45179
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.24.0
|
Security for spyrmsd 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.