diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 1d39346..25c29a7 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -45,3 +45,19 @@ From the repository root directory, run conda build . && conda install --use-local mdahole2 to build the package and install the local build. + +Installing hole2 +~~~~~~~~~~~~~~~~ + +``mdahole2`` requires the ``hole2`` executable to be installed. + +This is most easily done using ``conda``, ``mamba``, or a similar +package manager. For example, to install ``hole2`` using ``mamba``: + +.. code:: bash + + mamba install -c conda-forge hole2 + +Alternatively, ``hole2`` can be installed from the original HOLE_ website. + +.. _HOLE: http://www.holeprogram.org \ No newline at end of file