Getting Started
===============

Installation
------------

Install hermpy from `PyPI`_:

.. _`PyPI`: https://pypi.org/project/hermpy/

.. code-block:: shell

        pip install hermpy
        # or uv add ... etc.

or install from source (only recommended for development):

.. tab-set::

    .. tab-item:: https

        .. code-block:: shell

                git clone https://github.com/daraghhollman/hermpy
                pip install ./hermpy

                # Or make it editable with '-e'
                pip install -e ./hermpy

    .. tab-item:: ssh

        .. code-block:: shell

                git clone git@github.com:daraghhollman/hermpy.git
                pip install ./hermpy

                # Or make it editable with '-e'
                pip install -e ./hermpy


Quick Start
-----------

These docs are a work in progress.