-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Matbii can be install as a pip package and run directly with python.
pip install matbii
python -m matbii -c <CONFIG FILE> -<OTHER OPTIONS>
This is the simplest and quickest way to get started, but it will limit the configuration of the system. If you want to run more complex human-attention experiments (or otherwise) this will require coding (to varying degrees). That said, we have developed this version of matbii to be as configurable as possible without requiring coding knowledge. To get started with configuration with this simple install see here.
NOTE: Windows users may require an additional manual install on first time step to avoid the following error: TODO, see FAQ for details.
To run more interesting experiments, a local install is recommended, this is much the same.
- clone from github
git clone https://github.com/dicelab-rhul/matbii.git
- install with pip (locally) - assuming you have python installed and a virtual environment set up (Recommended).
pip install -e ./matbii
FAQ: You should be installing the folder that contains the pyproject.toml file
This will install all required dependencies.
The most important argument that matbii will receive is the -c argument which specifies the path of the main configuration file. This option and others are discussed in detail here.
The __main__.py file is the entry point of matbii (when using python -m matbii). It contains lots of interesting code that will be relevant to you if you want to adapt matbii for your own purposes.
What do we mean by "adapt matbii"?
- implement your own guidance strategy in an
Agent, see here. - implement your own tasks or extending/modifying the existing tasks, see here.
- make use of new devices (e.g. EEG), see eyetracking](https://github.com/dicelab-rhul/matbii/wiki/Eyetracking) for inspiration.
- add configuration options
Get familiar with configuring matbii for your experiments, see configuration and tasks.