A behavior application written in Python for conducting PCMS experiments
To get set up for working on this repository, you should do the following:
- Sync the repository to a location of your choosing
- Navigate on your computer to the folder where you placed the repository
- If you so desire, create a Python virtual environment.
- Run the following command:
pip install --editable .
If you don't plan on doing any development, you can just install the app by running the command: pip install .
To build the documentation, you must have sphinx installed. To install sphinx, use the following command:
pip install sphinx
Once it has been installed, you can then build the documentation using the following command from the repository's root folder:
sphinx-build -M html docs/source docs/build
The structure of this library follows the following guide: https://github.com/yngvem/python-project-structure