CogPsychoPy

An Awesome PsychoPy Blueprint to Jumpstart Your Experiments!

Report Bug . Request Feature

Table Of Contents

• About CogPsychoPy
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Authors
• Acknowledgements

About CogPsychoPy

• Your time should be focused on creating an amazing experiment and not studying the PsychoPy documentation.
• Easy to refactor and scaling for complex experiments
• You should element DRY principles to the rest of your life 😄

• Using psychopys Handlers: TrialHandler and ExperimentHandler
• Using an yml file for the experiment config and conditions: Human readable and easy to edit
• Export the data using psychopy: CSV, Log file, and backup .psydata
• Template for using the staircase handler: QuestPlus example
• How to test experiments: PsychoPy Runner

Of course, no one template will serve all experiments since your needs may be different. Feel free to suggest changes by forking this repo and creating a pull request or opening an issue.

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With PsychoPy.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

TODO: Update this section.

This is an example of how to list things you need to use the software and how to install them.

• miniconda or micromamba

npm install npm@latest -g

Installation

TODO: Update the installation guide

1. Clone the repo

git clone https://github.com/your_username_/Project-Name.git

2. Install NPM packages

npm install

3. Enter your API in config.js

const API_KEY = 'ENTER YOUR API';

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• dominikue - Cognitive Science Student - dominikue - **

Acknowledgements

• README Othneil Drew