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

Follow these instructions to install **Neurostates**.

Prerequisites
-------------

Before installing, make sure you have the following:

- Python 3.9 or later.
- `pip` (Python's package installer).
- A virtual environment (optional, but recommended).

If you don't have Python installed, you can download it from the official website:
`https://www.python.org/downloads/ <https://www.python.org/downloads/>`_

Installing via pip
------------------

The easiest way to install **Neurostates** is through pip. To install it from the Python Package Index (PyPI), simply run:

.. code-block:: bash

   pip install neurostates

If you're using a virtual environment (recommended), activate the environment first, then run the pip command.

Installing in Development Mode
------------------------------

If you'd like to contribute to the development of **Neurostates**, you can install it in "development mode" by running:

.. code-block:: bash

   pip install -e .

This will install the project as an editable package, allowing you to make changes and have them take effect without reinstalling.