.. gym-anm installation documentation

Installation
=============

:code:`gym-anm` requires Python 3.10+ and can run on Linux, MaxOS, and Windows. You can
install it through :ref:`from_pip` or :ref:`from source <from_source>`.

We recommend installing :code:`gym-anm` in a Python environment (e.g., `virtualenv
<https://virtualenv.pypa.io/en/stable/index.html>`_ or `conda <https://conda.io/en/latest/#>`_).

.. _from_pip:

pip
---
Using pip (preferably after activating your virtual environment): ::

    pip install gym-anm

.. _from_source:

Building from source
--------------------
Alternatively, you can build :code:`gym-anm` directly from source: ::

    git clone https://github.com/robinhenry/gym-anm.git
    cd gym-anm
    pip install -e .