transrot


Nametransrot JSON
Version 0.0.1 PyPI version JSON
download
home_pageNone
SummaryLightweight Python package to calculate translational vector and rotational matrix between two sets of 3D coordinates
upload_time2024-06-25 09:34:56
maintainerNone
docs_urlNone
authorNone
requires_python>=3
licenseNone
keywords science chemistry biology drug-design
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            transrot
========


Description
-----------

**transrot**  is a lightweight Python package to calculate the translation vector and rotational matrix between two sets of 3D coordinates. This transformation can be applied to another set of coordinates


Installation
------------

.. code-block:: bash

    pip install transrot


How To?
-------

.. code-block:: bash
    
    from transrot import TransRot
    import numpy as np
    
    # Get your (n, 3) array of coordinates
    coords1 = np.random.random((5, 3))
    coords2 = np.random.random((5, 3))
    coords3 = np.random.random((5, 3))
    
    # Initialize the class
    transformation = TransRot(
        coords1=coords1,
        coords2=coords2
    )
    
    # Calculate rotational matrix and translational vector that aligns coords1 to coords2
    transformation.fit()
    
    # Transform a set of coordinates with the calculated transformation
    transformed_coords = transformation.transform(coords3)

Issues
------

If you have found a bug, please open an issue on the `GitHub Issues <https://github.com/ale94mleon/transrot/issues>`_.

Funding
---------

This project received funding from `Marie Skłodowska-Curie Actions <https://cordis.europa.eu/project/id/860592>`__. It was developed in the 
`Computational Biophysics Group <https://biophys.uni-saarland.de/>`__ of `Saarland University <https://www.uni-saarland.de/en/home.html>`__.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "transrot",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": null,
    "keywords": "science, chemistry, biology, drug-design",
    "author": null,
    "author_email": "Alejandro Mart\u00ednez-Le\u00f3n <ale94mleon@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/54/3e/c2c839aa421176df1c93928997551ef0d858a273a0c4c0f25300d59f4bb8/transrot-0.0.1.tar.gz",
    "platform": null,
    "description": "transrot\n========\n\n\nDescription\n-----------\n\n**transrot**  is a lightweight Python package to calculate the translation vector and rotational matrix between two sets of 3D coordinates. This transformation can be applied to another set of coordinates\n\n\nInstallation\n------------\n\n.. code-block:: bash\n\n    pip install transrot\n\n\nHow To?\n-------\n\n.. code-block:: bash\n    \n    from transrot import TransRot\n    import numpy as np\n    \n    # Get your (n, 3) array of coordinates\n    coords1 = np.random.random((5, 3))\n    coords2 = np.random.random((5, 3))\n    coords3 = np.random.random((5, 3))\n    \n    # Initialize the class\n    transformation = TransRot(\n        coords1=coords1,\n        coords2=coords2\n    )\n    \n    # Calculate rotational matrix and translational vector that aligns coords1 to coords2\n    transformation.fit()\n    \n    # Transform a set of coordinates with the calculated transformation\n    transformed_coords = transformation.transform(coords3)\n\nIssues\n------\n\nIf you have found a bug, please open an issue on the `GitHub Issues <https://github.com/ale94mleon/transrot/issues>`_.\n\nFunding\n---------\n\nThis project received funding from `Marie Sk\u0142odowska-Curie Actions <https://cordis.europa.eu/project/id/860592>`__. It was developed in the \n`Computational Biophysics Group <https://biophys.uni-saarland.de/>`__ of `Saarland University <https://www.uni-saarland.de/en/home.html>`__.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Lightweight Python package to calculate translational vector and rotational matrix between two sets of 3D coordinates",
    "version": "0.0.1",
    "project_urls": {
        "Hompage": "https://github.com/ale94mleon/transrot",
        "Issues": "https://github.com/ale94mleon/tutorial/transrot"
    },
    "split_keywords": [
        "science",
        " chemistry",
        " biology",
        " drug-design"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5d82b480144d8c26d5572e692e290be874334e13d7a58f9f4e3e15986fa23545",
                "md5": "902fd29b4ffdfd912a205190224898fd",
                "sha256": "1a6ee536e1b251f75399c7bacac56d43682c2c661b2ac1fa789ddc61a2c566be"
            },
            "downloads": -1,
            "filename": "transrot-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "902fd29b4ffdfd912a205190224898fd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3",
            "size": 4113,
            "upload_time": "2024-06-25T09:34:55",
            "upload_time_iso_8601": "2024-06-25T09:34:55.563040Z",
            "url": "https://files.pythonhosted.org/packages/5d/82/b480144d8c26d5572e692e290be874334e13d7a58f9f4e3e15986fa23545/transrot-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "543ec2c839aa421176df1c93928997551ef0d858a273a0c4c0f25300d59f4bb8",
                "md5": "c14566fec912775da12d4e92268d3fa5",
                "sha256": "0ffc2413c2994a25df0f403009980d4fb1e054e81f64a425050e7ec4bec6d480"
            },
            "downloads": -1,
            "filename": "transrot-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "c14566fec912775da12d4e92268d3fa5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 3985,
            "upload_time": "2024-06-25T09:34:56",
            "upload_time_iso_8601": "2024-06-25T09:34:56.463730Z",
            "url": "https://files.pythonhosted.org/packages/54/3e/c2c839aa421176df1c93928997551ef0d858a273a0c4c0f25300d59f4bb8/transrot-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-25 09:34:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ale94mleon",
    "github_project": "transrot",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "transrot"
}
        
Elapsed time: 2.99604s