Getting Started

This page details how to get started with mdakithole2.

Documentation

Documentation is hosted on Read the Docs.

Download source code

The mdakithole2 source code is hosted on GitHub and can be downloaded with

git clone git@github.com:MDAnalysis/hole2-mdakit.git

with an SSH key, or with

git clone https://github.com/MDAnalysis/hole2-mdakit.git

Build and installation

mdakithole2 is currently only installable from source (although hosting on conda-forge is planned). As such conda-build is required. To download this utility, invoke:

conda install conda-build

From the repository root directory, run

conda build . && conda install --use-local mdakithole2

to build the package and install the local build.