Ensure you are using <= python@3.8

Create and activate a virtual environment

python3 -m venv <env_name>
source <env_name>/bin/activate

Install dependencies:

python3 -m pip install --upgrade pip
pip3 install -r requirements.txt

Install node dependencies: npm install --no-optional

Create a .env file and add DB_HOST and DB_PASSWORD vars for the development database.

Run server in dev: DJANGO_ENV=development DEBUG=True python manage.py runserver

TIP: add an alias for the above command to your shell config file (.bashrc, .zshrc, etc.)

alias bsw="DJANGO_ENV=development DEBUG=True python manage.py runserver"

Error installing sass with pip:

ERROR: Failed building wheel for sass

Install cython and try again

pip3 install cython
pip3 install -r requirements.txt

Error installing psycopg2 Error: pg_config executable not found. - Install postgresql brew install postgresql

Error running the server - /bin/sh: command not found: sass - npm install -g sass

python manage.py flush

python manage.py loaddata benchmarks/fixtures/fixture-benchmarkreferences.json
python manage.py loaddata benchmarks/fixtures/fixture-benchmarktypes.json
python manage.py loaddata benchmarks/fixtures/fixture-benchmarkinstances.json
python manage.py loaddata benchmarks/fixtures/fixture-users.json
python manage.py loaddata benchmarks/fixtures/fixture-submissions.json
python manage.py loaddata benchmarks/fixtures/fixture-modelreferences.json
python manage.py loaddata benchmarks/fixtures/fixture-models.json
python manage.py loaddata benchmarks/fixtures/fixture-scores.json

If you need to reset the database and all migrations (relevant after changing models.py):

1. delete db.sqlite3
2. python manage.py makemigrations
3. python manage.py migrate

1. save website locally (Ctrl+S http://localhost:8000)
2. replace http://localhost:8000/#* with # (when saved with Chrome)
3. replace http://localhost:8000/benchmarks/fixtures/img/icon.png with https://s3.amazonaws.com/www.brain-score.org/icon.png
4. delete the svg from <div id="brain-score">
5. In compare.js, replace the static json link /benchmarks/fixtures/fixture-scores-javascript.json with https://s3.us-east-2.amazonaws.com/brain-score.web-mock/fixture-scores-javascript.json or fixture-scores-javascript.json
6. upload Brain-Score.html, Brain-Score_files and fixture-scores-javascript.json to S3 (account id ****75, bucket www.brain-score.org)

See deployment.md