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

This section provides instructions for installing the `hardware_rc` package.

The package includes many dependencies, but are all automatically installed with the package.

Installation
------------
To install the `hardware_rc` package, you can use pip. It is recommended to create 
a virtual environment before installing the package to avoid conflicts with other packages.

// Create a virtual environment (optional but recommended)

.. code-block:: bash

    # Create a virtual environment (optional but recommended)
    python -m venv hardware_rc_env
    source hardware_rc_env/bin/activate  # On Windows, use `hardware_rc_env\Scripts\activate`


// Install the package

.. code-block:: bash

    pip install hardware_rc



Dependencies
------------
The `hardware_rc` package has the following dependencies:
    - JAX: For efficient numerical computations and automatic differentiation.
    - Gymnasium: For reinforcement learning environments.
    - NumPy: For numerical operations.
    - Matplotlib: For plotting and visualization.
    - Pillow: For gif creating.
    - Optax: For optimization algorithms.
    - Pygame: For rendering environments.