Python library for finding the optimal transformation(s) that makes two matrices as close as possible to each other.
Project description
Procrustes Python Library
The Procrustes library provides a set of functions for transforming a matrix to make it as similar as possible to a target matrix. For more information, visit Procrustes Documentation.
Citation
Please use the following citation in any publication using Procrustes library:
@article{Meng2022procrustes,
title = {Procrustes: A python library to find transformations that maximize the similarity between matrices},
author = {Fanwang Meng and Michael Richer and Alireza Tehrani and Jonathan La and Taewon David Kim and Paul W. Ayers and Farnaz Heidar-Zadeh},
journal = {Computer Physics Communications},
volume = {276},
number = {108334},
pages = {1--37},
year = {2022},
issn = {0010-4655},
doi = {https://doi.org/10.1016/j.cpc.2022.108334},
url = {https://www.sciencedirect.com/science/article/pii/S0010465522000522},
keywords = {Procrustes analysis, Orthogonal, Symmetric, Rotational, Permutation, Softassign},
}
Dependencies
The following dependencies are required to run Procrustes properly,
- Python >= 3.9: http://www.python.org/
- NumPy >= 1.21.5: http://www.numpy.org/
- SciPy >= 1.9.0: http://www.scipy.org/
To test Procrustes, the following dependencies are required,
- PyTest >= 8.3.0: https://docs.pytest.org/
- PyTest-Cov >= 5.0.0: https://pypi.org/project/pytest-cov/
Installation
It is recommended to install qc-procrustes
within a virtual environment.To create a virtual
environment, we can use the venv
module (Python 3.3+,
https://docs.python.org/3/tutorial/venv.html), miniconda
(https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html), or
pipenv
(https://pipenv.pypa.io/en/latest/).
Installing from PyPI
To install procrustes
with pip
, we can install the latest stable release from the Python Package Index (PyPI) as follows:
# install the stable release.
pip install qc-procrustes
Installing from The Prebuild Wheel Files
To download the prebuilt wheel files, visit the PyPI page and GitHub releases.
# download the wheel file first to your local machine
# then install the wheel file
pip install file_path/qc_procrustes-1.0.2a1-py3-none-any.whl
Installing from the Source Code
In addition, we can install the latest development version from the GitHub repository as follows:
# install the latest development version
pip install git+https://github.com/theochem/procrustes.git
We can also clone the repository to access the latest development version, test it and install it as follows:
# clone the repository
git clone git@github.com:theochem/procrustes.git
# change into the working directory
cd procrustes
# run the tests
python -m pytest .
# install the package
pip install .
More
See https://procrustes.qcdevs.org for full details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file qc_procrustes-1.1.0.tar.gz
.
File metadata
- Download URL: qc_procrustes-1.1.0.tar.gz
- Upload date:
- Size: 1.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ecf7b143c0becaa27b7a366eac13398f85fae949e67caa82527caccfe12ede8a |
|
MD5 | 5241eda1984b8c44b7d5ab29a3322d95 |
|
BLAKE2b-256 | 2737222549f2f2d6b5b83a87b1a4a01534c71ce01db4d27397b23a82b33fc6e1 |
File details
Details for the file qc_procrustes-1.1.0-py3-none-any.whl
.
File metadata
- Download URL: qc_procrustes-1.1.0-py3-none-any.whl
- Upload date:
- Size: 1.6 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb477e15527e5b5232c399360c07350de64ec97ce5271b703be7f86012690812 |
|
MD5 | e81b55753e6ec415bab8a9fd8fb489f7 |
|
BLAKE2b-256 | 6be7cc72c802ca2e102463015390cfc618535944d1b5e9ec97faacce883660dc |