Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

PathSimAnalysis

Latest release Last release tag GitHub commits since latest release (by date) for a branch
Status GH Actions Status codecov
Community Powered by MDAnalysis

Calculates the geometric similarity of molecular dynamics trajectories using path metrics such as the Hausdorff and Fréchet distances.

PathSimAnalysis is bound by a Code of Conduct.

Installation from packages

With conda from conda-forge

Ensure that you have conda installed.

You can install pathsimanalysis from the conda-forge channel with

conda install -c conda-forge pathsimanalysis

or alternatively with mamba if you have it installed:

mamba install -c conda-forge pathsimanalysis

Install from PyPI

The latest release of PathSimAnalysis is available on PyPI and can be installed with:

pip install pathsimanalysis

Installation from source

To build PathSimAnalysis from source, we highly recommend using virtual environments. If possible, we strongly recommend that you use Anaconda as your package manager. Below we provide instructions both for conda and for pip.

With conda

Ensure that you have conda installed.

Create a virtual environment and activate it:

conda create --name pathsimanalysis
conda activate pathsimanalysis

Install the development and documentation dependencies:

conda env update --name pathsimanalysis --file devtools/conda-envs/test_env.yaml
conda env update --name pathsimanalysis --file docs/requirements.yaml

Build this package from source:

pip install -e .

If you want to update your dependencies (which can be risky!), run:

conda update --all

And when you are finished, you can exit the virtual environment with:

conda deactivate

With pip

To build the package from source, run:

pip install .

If you want to create a development environment, install the dependencies required for tests and docs with:

pip install ".[test,doc]"

Copyright

The PathSimAnalysis source code is hosted at https://github.com/MDAnalysis/pathsimanalysis and is available under the Lesser GNU Public Licence, v2.1 or any higher version (see the file LICENSE).

Copyright (c) 2023, MDAnalysis

Acknowledgements

Project based on the MDAnalysis Cookiecutter version 0.1. Please cite MDAnalysis when using PathSimAnalysis in published work.

Download files

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

Source Distribution

pathsimanalysis-1.2.1rc1.tar.gz (44.1 kB view details)

Uploaded Source

Built Distribution

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

pathsimanalysis-1.2.1rc1-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file pathsimanalysis-1.2.1rc1.tar.gz.

File metadata

  • Download URL: pathsimanalysis-1.2.1rc1.tar.gz
  • Upload date:
  • Size: 44.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for pathsimanalysis-1.2.1rc1.tar.gz
Algorithm Hash digest
SHA256 b6b3306e4ca4f4b546e95fb8a78840b83953140ebbbebd6c94ee0b44c1e57e3d
MD5 2119a796bfdf6a2df4a79d80b20f6242
BLAKE2b-256 0e25b8c3b3ef8db51645f160998be6aad71cf3c34e0a260c4f49a216ee49463a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pathsimanalysis-1.2.1rc1.tar.gz:

Publisher: deploy.yaml on MDAnalysis/PathSimAnalysis

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

File details

Details for the file pathsimanalysis-1.2.1rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for pathsimanalysis-1.2.1rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 9723755e83af91da909a165091bd5d7c3404838468e6f9e993e81cf39ad77f78
MD5 2b3e5abfd321bd256d6694b356168639
BLAKE2b-256 818699fa649c61af11e258850b0319839723ae5ddc43a174217dd655ae2ef1fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pathsimanalysis-1.2.1rc1-py3-none-any.whl:

Publisher: deploy.yaml on MDAnalysis/PathSimAnalysis

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 Sentry Error logging StatusPage Status page