Usage
=====

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

To begin using `neuroptimiser`, follow these steps:

1. **Clone the Repository**:

    .. code-block:: bash

        git clone https://github.com/neuroptimiser/neuroptimiser.git
        cd neuroptimiser

2. **Create and Activate a Virtual Environment**:

    .. code-block:: bash

        python3 -m venv .venv
        source .venv/bin/activate

3. **Install Dependencies**:

    .. code-block:: bash

        pip install -r requirements.txt


.. note::

    Once `neuroptimiser` is available on PyPI, you will be able to install it directly using:

    .. code-block:: bash

        pip install neuroptimiser


Examples
--------

Explore the following examples to understand how to utilise `neuroptimiser`:

.. toctree::
    :maxdepth: 1

    examples/Example0
    examples/Example1
    examples/Example2

Further Reading
---------------

For more detailed information, refer to the following sections:

- :doc:`installation`
- :doc:`api`
- :doc:`contributing`