.. highlight:: shell

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


To install BrainAccess, run this command in your terminal while in BrainAccess directory:

.. code-block:: console

    $ pip install .

To install with all dependencies required for BCI examples run (python 3.10 only):

.. code-block:: console

    $ pip instal .[bci]

If you don't have `pip`_ installed, this `Python installation guide`_ or this `Anaconda environment installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
.. _Anaconda environment installation guide: https://docs.anaconda.com/anaconda/install/

=======
Setup
=======

Bluetooth connection setup
--------------------------

To connect the BrainAccess device:

1. Plug-in Bluetooth adapter. Skip this step using an integrated Bluetooth adapter.
2. Scan for the devices and use the name of the device to connect to it with SDK.
3. In the code enter the device name when connecting

    - Minimal EEG acquisition example
    - EEG measurement example

Configuration file
------------------

Root directory of the program running BrainAccess can contain,
``bacore.json`` file describing acquisition parameters.
If the file is not present, default parameters are used.

Main components:

- chunk_size: size of chunks to be acquired from core (Default: 25)
- logging parameters for debugging.
- model_path: custom location of models

The example file is provided in the root directory of BrainAccess package

.. include:: ./bacore.json
   :literal: