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

Requirements
~~~~~~~~~~~~

* Python 3.8 or later
* NumPy
* Pandas
* PyYAML
* Matplotlib (for plotting)

From PyPI
~~~~~~~~~

The easiest way to install HydroRaVENS is via pip:

.. code-block:: bash

    pip install hydroravens

From Source (Development)
~~~~~~~~~~~~~~~~~~~~~~~~~

For development or contributing to the project:

.. code-block:: bash

    git clone https://github.com/MNiMORPH/hydroRaVENS.git
    cd hydroRaVENS
    pip install -e .

This installs the package in "editable" mode, so changes to the source code are 
reflected immediately without reinstalling.

Installing Documentation Dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To build documentation locally:

.. code-block:: bash

    pip install -r docs/requirements.txt
    cd docs
    make html

The HTML documentation will be in ``docs/_build/html/``.

Verification
~~~~~~~~~~~~

To verify your installation:

.. code-block:: python

    >>> import hydroravens
    >>> print(hydroravens.__version__)
    
    >>> # Create and initialize a model
    >>> model = hydroravens.Buckets()
    >>> print("Installation successful!")

Troubleshooting
~~~~~~~~~~~~~~~

**ImportError when importing hydroravens**

  Ensure you've run ``pip install -e .`` from the repository root.

**YAML parsing errors**

  Update PyYAML: ``pip install --upgrade pyyaml``

**Plotting doesn't work**

  Install Matplotlib: ``pip install matplotlib``

Next Steps
~~~~~~~~~~

Head to the :doc:`quickstart` guide to run your first model!