helanal 0.1.0

A package to characterise the geometry of protein helicies.

helanal

Latest release
Status
Community

A package to characterise the geometry of protein helicies.

helanal is bound by a Code of Conduct.

Installation

To build helanal 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 helanal
conda activate helanal

Install the development and documentation dependencies:

conda env update --name helanal --file devtools/conda-envs/test_env.yaml
conda env update --name helanal --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 helanal source code is hosted at https://github.com/MDAnalysis/helanal and is available under the GNU General Public License, version 2 (see the file LICENSE).

Copyright (c) 2024, Your name (or your organization/company/team)

Acknowledgements

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