.. _spyrmsdkit:

************************************************
spyrmsdkit
************************************************

| 🖋️ **Authors**: `spyrmsdkit authors`_
| 🏠 **Project home:** https://github.com/RMeli/spyrmsdkit/
| 📖 **Documentation:** https://spyrmsd.readthedocs.io
| ⚖️ **License:** GPL-2.0-or-later
| 🔑 **Keywords:** spyrmsd, RMSD, symmetry-corrected RMSD, drug discovery
| 🚀 **Development status:** Production
| 📜 **Changelog:** https://github.com/RMeli/spyrmsdkit/blob/main/CHANGELOG.md
| 📑 **Publications:**
|    * https://doi.org/10.1186/s13321-020-00455-2
| 🧪 **Tests (latest):** |spyrmsdkit_latest| 
| 🧪 **Tests (develop):** |spyrmsdkit_develop| 
| **Description:**
| *spyrmsdkit allows to compute symmetry-corrected RMSDs with spyrmsd on MD trajectories*



Installation instructions
=========================


The source code of spyrmsdkit can be installed using the following:

.. code-block:: bash

    pip install git+https://github.com/RMeli/spyrmsdkit@main

.. _`spyrmsdkit authors`:
   https://github.com/RMeli/spyrmsdkit/blob/main/AUTHORS.md

.. |spyrmsdkit_latest| image:: https://img.shields.io/badge/latest-unavailable-inactive.svg
   :alt: spyrmsdkit develop CI status
   :target: https://github.com/MDAnalysis/MDAKits/actions

.. |spyrmsdkit_develop| image:: https://img.shields.io/badge/develop-passed-green.svg
   :alt: spyrmsdkit develop CI status
   :target: https://github.com/MDAnalysis/MDAKits/actions