Skip to main content

A Python interface for the HOLE suite tools to analyze an ion channel pore or transporter pathway as a function of time or arbitrary order parameters.

Project description

mdahole2

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

A Python interface for the HOLE suite tools to analyze an ion channel pore or transporter pathway as a function of time or arbitrary order parameters.

mdahole2 is bound by a Code of Conduct.

Installation

To build mdahole2 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.

Note that mdahole2 is only supported on Linux and macOS.

With conda

Ensure that you have conda installed.

Create a virtual environment and activate it:

conda create --name mdahole2
conda activate mdahole2

Install the development and documentation dependencies:

conda env update --name mdahole2 --file devtools/conda-envs/test_env.yaml --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 -e .

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

pip install -e ".[test,doc]"

Copyright

The mdahole2 source code is hosted at https://github.com/MDAnalysis/mdahole2 and is available under the GNU General Public License, version 3 (see the file LICENSE).

Copyright (c) 2022, The MDAnalysis Development Team and all contributors listed in the file AUTHORS

Acknowledgements

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

Project details


Download files

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

Source Distribution

mdahole2-0.5.0.tar.gz (3.7 MB view details)

Uploaded Source

Built Distribution

mdahole2-0.5.0-py3-none-any.whl (3.7 MB view details)

Uploaded Python 3

File details

Details for the file mdahole2-0.5.0.tar.gz.

File metadata

  • Download URL: mdahole2-0.5.0.tar.gz
  • Upload date:
  • Size: 3.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for mdahole2-0.5.0.tar.gz
Algorithm Hash digest
SHA256 39150588b9bc07ebc176bac30d9c3b0bd25003e2e2eac24b622f2a10e5352a1f
MD5 dfc443992f575889c3a717b7dc4f4d24
BLAKE2b-256 fc7a19b4b3ba44a326cfdbbb731e2fbfe8ceec005d3e302bffd1b43a146e6f32

See more details on using hashes here.

Provenance

The following attestation bundles were made for mdahole2-0.5.0.tar.gz:

Publisher: deploy.yaml on MDAnalysis/mdahole2

Attestations:

File details

Details for the file mdahole2-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: mdahole2-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 3.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for mdahole2-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6b7a9be247cd99331e8840c9012d0ed7a86874fe110983bbaed00eb39459e7a8
MD5 61d7b7a8d645e79e3e7c8761b4bbc01b
BLAKE2b-256 44874957d158a403b7853ef4e0142626375f8f4ddf49599ae2d2ad73834039e2

See more details on using hashes here.

Provenance

The following attestation bundles were made for mdahole2-0.5.0-py3-none-any.whl:

Publisher: deploy.yaml on MDAnalysis/mdahole2

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page