README.rst

Python library for Cybersickness susceptibility testing

Getting Started

# clone the repository
git clone https://github.com/project-cssi/cssi-core.git

# change the directory
cd cssi-core

# install dependencies and build the project
make

CSSI Algorithm

The following algorithm was used in the cssi.core module to calculate the final CSSI Score.

Configuration

The host application must provide a configuration file and the name should be passed when instantiating the CSSI module. If no config name is passed in, the library tries to read the config from the default file name i.e config.cssi.

following is the format of a sample configuration file.

[run]
plugins =
    cssi_plugin_heart_rate

[latency]
latency_weight = 50
latency_boundary = 3

[sentiment]
sentiment_weight = 30

[questionnaire]
questionnaire_weight = 20

[cssi_plugin_heart_rate]
weight = 0

Publications

The following publications have been made with respect to this project.

Type	Title	Link
Review Paper	Early Prediction of Cybersickness in Virtual, Augmented & Mixed Reality Applications: A Review	Researchgate

Releases

Please read the RELEASES.rst guideline to learn about the process for releasing the project.

Changelog

Please refer CHANGELOG.md to learn about the latest improvements, breaking changes and bug fixes.

Built with

        

Contributing

Please read CONTRIBUTING.rst for contributing guidelines and to learn about our code of conduct.

Contributors

License