Running the Novaland Project Locally¶
This guide explains how to set up and run the Novaland oTree project on your local machine for development and testing purposes.
Requirements¶
Before proceeding, ensure that you have the following installed:
Python 3.12
Git
pip (Python package installer)
Virtual environment support (optional but recommended)
Step-by-Step Setup¶
Clone the repository
First, clone the Novaland project repository to your local machine:
git clone https://github.com/EmpPowiUDE/novaland2.git cd novaland2
Create a virtual environment
It is recommended to use a virtual environment to manage dependencies:
python3.12 -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate
Install dependencies
All required Python packages are listed in the requirements.txt file:
pip install -r requirements.txt
Run the oTree development server
Once everything is installed, start the local server:
otree devserverThis will launch a local server at http://localhost:8000, which you can open in your browser.
Optional Configuration¶
If you want to run a specific session configuration, you can append its name:
otree devserver SESSION_CONFIG_NAME=novaland_experiment
To reset the database (removes all previous data):
otree resetdb
Useful Files and Folders¶
settings.py — main configuration file for session settings, installed apps, and environment variables
main/ — contains the core logic for the Novaland experiment, including HTML pages, Python logic, and templates
data/ — contains YAML files such as vignette_q.yaml and corrupt_endings.yaml for question templates and storyline branching
Troubleshooting¶
If you encounter module not found errors, make sure your virtual environment is activated.
If port 8000 is busy, you can specify another port:
otree devserver --port 8001
For full documentation on oTree: https://otree.readthedocs.io