Generation of files for Requin Experiment 2023
This project allows the generation of files used in the experiment described in the 2024 International Conference on Human-Computer Interaction (HCII) presentation "Piloting continuous neurophysiological monitoring for adapted training of public safety officers".
You can install the project via the following command:
git clone https://github.com/ThalesGroup/requin-2023-experiment.git
pip install -e .
Note that the oldest version of Python that this project has been tested on is 3.10, while the newest version is 3.12.
After installing the project as a package, you can run the code in the CLI.
For example:
gen_matbii_events output_matbii
will generate the XML configuration files for MATB-II in a folder called "output_matbii".
This project uses pytest for testing. After installing the project and its dependencies, you can run the tests by simply executing pytest in the project root directory.
However, the recommended way to run tests is using tox, which will take care of setting up a virtual environment with the correct dependencies for testing. If you haven't installed tox, you can do so with pip install tox.
Once tox is installed, you can run the tests with the following command:
tox
This will run all tests and report the results.
Contributions of all kinds are welcomed. For detailed information on how to contribute, please refer to our Contributor's Guide, including instructions on how to report issues, build and improve the documentation, submit changes, etc.
This project has been set up using PyScaffold 4.5. For details and usage information on PyScaffold see https://pyscaffold.org/.