World Quant Brain - Agent

Code for creating and submitting alphas for World Quant Brain

Set-up

Install Python 3.10 or above and install necessary dependencies:

pip install -r requirements.txt -r requirements-dev.txt
# Install brain package in editable mode
pip install -e .

Set platform credentials by copying file .env.example into .env and setting the variables.

After that you can run the main code as:

wq-brain

Make file

As an alternative you can use the Makefile to set up the environment. The following command

make install

will create virtual environment in venv/ folder and install all required packages.

Development

For development of code and commiting into git repository, run following command before making any commits:

pre-commit install

Databse Migrations

1. Set DATABASE_URL in .env file
2. Create new migration:

./db_migrate.sh new my_migration_name

2. Update migrations file
3. Execute migrations

./db_migrate.sh up

Running Using Docker

Build

docker build -t brain:latest .

Run

docker run -d --name brain-container --restart=always brain:latest

Monitor

docker logs -f brain-container