| Name | sashlab-stress JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | A collection of scripts that run common stress tasks |
| upload_time | 2024-10-18 21:42:58 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT |
| keywords |
cli
psychology
stress
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# SASHLab Stress CLI
## Overview
**SASHLab Stress** is a collection of scripts that run common stress-inducing tasks, designed for use in psychology experiments or stress-response testing. The CLI is intended to facilitate the application of various stress protocols in a streamlined manner.
## Features
The current script will run the available stress task for specified durations and save the output to an easily mungable CSV file.
### Current stressors
- **Mental Arithmetic Task**:
- A mental subtraction task where participants subtract digits under time pressure. Task difficulty adjusts based on streaks of correct or incorrect answers (streak length is 3).
- **Negative/Neutral Speech Task**:
- A speech task where participants are asked to recall either negative or neutral experiences. The task condition (negative or neutral) is determined by the user.
### Planned stressors
- Digit Span
- Nonsense Syllable
## Installation
Ensure you have Python 3.12 or newer. To install the CLI, run:
```sh
pip install sashlab-stress
```
## Usage
For the best results, ensure your terminal is pointed to the folder where you'd like participant data to be stored:
```sh
cd <path/to/your/project/data>
```
Run the main functionality of **SASHLab Stress** with default options:
```sh
sashlab_stress
```
### Examples
- To run the **mental arithmetic stress task**:
```sh
sashlab_stress --time-limit 600 --trial-time 20 --path ./data
```
- To run the **negative/neutral speech task** in neutral condition:
```sh
sashlab_stress --task-type neg-neu-speech --condition 1 --time-limit 600 --path ./data
```
- To show help and view available commands:
```sh
sashlab_stress --help
```
## Options
- `--task-type`: The kind of task to run, either the mental subtraction task ('mental-subtraction') or the negative/neutral speech task ('neg-neu-speech').
- **Type**: `str`
- **Default**: `mental-subtraction`
- **Example**: `--task-type neg-neu-speech` (runs the speech task)
- `--time-limit`: Set the time limit for the entire session in seconds.
- **Type**: `int`
- **Default**: `300` seconds (5 minutes)
- **Example**: `--time-limit 600` (Sets the session duration to 10 minutes)
- `--trial-time`: Specify the maximum duration allowed for each individual trial before it times out due to lack of interaction.
- **Type**: `int`
- **Default**: `15` seconds
- **Example**: `--trial-time 20` (Sets each trial timeout to 20 seconds)
- `--path`: Provide the path where session data will be saved.
- **Type**: `path`
- **Default**: Current working directory (`cwd`)
- **Example**: `--path ./data` (Saves session data to a folder named "data" in the current directory)
- `--condition`: Set the condition for the speech task, with 0 representing negative condition and 1 representing neutral condition.
- **Type**: `int`
- **Default**: `0` (Negative condition)
- **Example**: `--condition 1` (Runs the task in neutral condition)
## Dependencies
This project relies on the following packages:
- **black** (>=24.8.0): For code formatting.
- **inputimeout** (>=1.0.4): For handling time-based input during tasks.
- **keyboard** (>=0.13.5): To capture keyboard events during tasks.
All dependencies will be installed automatically with the package.
## Requirements
- Python 3.12 or higher
- Operating System: OS Independent
## Contributing
Contributions are welcome! If you have ideas for new stress tasks or improvements, feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/spider-z3r0/sashlab_stress/).
## Authors
- **Kevin O'Malley** - [kevomalley743@gmail.com](mailto:kevomalley743@gmail.com)
- **Sandra O'Brien** - [sandra.obrien@ul.ie](mailto:sandra.obrien@ul.ie)
## License
This project is licensed under the MIT License
Raw data
{
"_id": null,
"home_page": null,
"name": "sashlab-stress",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "CLI, psychology, stress",
"author": null,
"author_email": "Kevin O'Malley <kevomalley743@gmail.com>, Sandra O'Brien <sandra.obrien@ul.ie>",
"download_url": "https://files.pythonhosted.org/packages/08/53/7c7dd3aae45f4d4751813f612934650a0755d782f3d2af442d3af81ccfcf/sashlab_stress-0.1.5.tar.gz",
"platform": null,
"description": "\n\n# SASHLab Stress CLI\n\n## Overview\n\n**SASHLab Stress** is a collection of scripts that run common stress-inducing tasks, designed for use in psychology experiments or stress-response testing. The CLI is intended to facilitate the application of various stress protocols in a streamlined manner.\n\n## Features\n\nThe current script will run the available stress task for specified durations and save the output to an easily mungable CSV file.\n\n### Current stressors\n\n- **Mental Arithmetic Task**:\n - A mental subtraction task where participants subtract digits under time pressure. Task difficulty adjusts based on streaks of correct or incorrect answers (streak length is 3).\n\n- **Negative/Neutral Speech Task**:\n - A speech task where participants are asked to recall either negative or neutral experiences. The task condition (negative or neutral) is determined by the user.\n\n### Planned stressors\n\n- Digit Span \n- Nonsense Syllable \n\n## Installation\nEnsure you have Python 3.12 or newer. To install the CLI, run:\n\n```sh\npip install sashlab-stress\n```\n\n## Usage\nFor the best results, ensure your terminal is pointed to the folder where you'd like participant data to be stored:\n\n```sh\ncd <path/to/your/project/data>\n```\n\nRun the main functionality of **SASHLab Stress** with default options:\n\n```sh\nsashlab_stress\n```\n\n### Examples\n\n- To run the **mental arithmetic stress task**:\n\n ```sh \n sashlab_stress --time-limit 600 --trial-time 20 --path ./data\n ```\n\n- To run the **negative/neutral speech task** in neutral condition:\n\n ```sh\n sashlab_stress --task-type neg-neu-speech --condition 1 --time-limit 600 --path ./data\n ```\n\n- To show help and view available commands:\n\n ```sh \n sashlab_stress --help\n ```\n\n## Options\n\n- `--task-type`: The kind of task to run, either the mental subtraction task ('mental-subtraction') or the negative/neutral speech task ('neg-neu-speech').\n - **Type**: `str`\n - **Default**: `mental-subtraction`\n - **Example**: `--task-type neg-neu-speech` (runs the speech task)\n\n- `--time-limit`: Set the time limit for the entire session in seconds.\n - **Type**: `int`\n - **Default**: `300` seconds (5 minutes)\n - **Example**: `--time-limit 600` (Sets the session duration to 10 minutes)\n\n- `--trial-time`: Specify the maximum duration allowed for each individual trial before it times out due to lack of interaction.\n - **Type**: `int`\n - **Default**: `15` seconds\n - **Example**: `--trial-time 20` (Sets each trial timeout to 20 seconds)\n\n- `--path`: Provide the path where session data will be saved.\n - **Type**: `path`\n - **Default**: Current working directory (`cwd`)\n - **Example**: `--path ./data` (Saves session data to a folder named \"data\" in the current directory)\n\n- `--condition`: Set the condition for the speech task, with 0 representing negative condition and 1 representing neutral condition.\n - **Type**: `int`\n - **Default**: `0` (Negative condition)\n - **Example**: `--condition 1` (Runs the task in neutral condition)\n\n## Dependencies\nThis project relies on the following packages:\n- **black** (>=24.8.0): For code formatting.\n- **inputimeout** (>=1.0.4): For handling time-based input during tasks.\n- **keyboard** (>=0.13.5): To capture keyboard events during tasks.\n\nAll dependencies will be installed automatically with the package.\n\n## Requirements\n- Python 3.12 or higher\n- Operating System: OS Independent\n\n## Contributing\nContributions are welcome! If you have ideas for new stress tasks or improvements, feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/spider-z3r0/sashlab_stress/).\n\n## Authors\n- **Kevin O'Malley** - [kevomalley743@gmail.com](mailto:kevomalley743@gmail.com)\n- **Sandra O'Brien** - [sandra.obrien@ul.ie](mailto:sandra.obrien@ul.ie)\n\n## License\nThis project is licensed under the MIT License\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A collection of scripts that run common stress tasks",
"version": "0.1.5",
"project_urls": null,
"split_keywords": [
"cli",
" psychology",
" stress"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2635d506666aeb1f98363078d23d2e1bf9f3827f041f2a73a578a9e9ce62fab",
"md5": "6949ef639c2a4f49bc18c7fe76337f42",
"sha256": "8031b7e24b87fa15e4dfae6daa26eb137e2126184c21f933eef1a5ee0521c07c"
},
"downloads": -1,
"filename": "sashlab_stress-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6949ef639c2a4f49bc18c7fe76337f42",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 12540,
"upload_time": "2024-10-18T21:42:57",
"upload_time_iso_8601": "2024-10-18T21:42:57.279497Z",
"url": "https://files.pythonhosted.org/packages/a2/63/5d506666aeb1f98363078d23d2e1bf9f3827f041f2a73a578a9e9ce62fab/sashlab_stress-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "08537c7dd3aae45f4d4751813f612934650a0755d782f3d2af442d3af81ccfcf",
"md5": "ed46241cae5ac3f5cdb45ead6996071b",
"sha256": "cc0fa19240c72e4fa54cc443c8dcab1f209dcc21a38a88b4d9381c8e5bc9dfdb"
},
"downloads": -1,
"filename": "sashlab_stress-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "ed46241cae5ac3f5cdb45ead6996071b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 68074,
"upload_time": "2024-10-18T21:42:58",
"upload_time_iso_8601": "2024-10-18T21:42:58.317146Z",
"url": "https://files.pythonhosted.org/packages/08/53/7c7dd3aae45f4d4751813f612934650a0755d782f3d2af442d3af81ccfcf/sashlab_stress-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-18 21:42:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sashlab-stress"
}
