solaise/simulation-base repository overview

⁠Simulation Framework

⁠Building the Images

TODO

⁠Running with docker-compose

⁠Requirements

The docker-compose.yml requires the following environment variables to be set.

• SMB_USERNAME
• SMB_PASSWORD

Alternativley, they can be specified on the command line with the -e KEY=VAL option.

If you don't want to keep adding these variables then you can use a .env file. Create a file called .env in the project root folder with the format below.

# Comment lines
SMB_USERNAME=username
SMB_PASSWORD=password

⁠Running the Simulation

To run the simulation we use the command

docker-compose run --rm --name my_simulation simulation <COMMAND> <ARGS>

For example to run the Daily Estimated Trade Report we would run the following:

docker-compose run --rm --name my_sim simulation run_main_report DailyEstimatedTradeReport.ipynb \
  --fail-fast \
  --auto-dated-folder \
  --auto-dated-files \
  -o /reports/execution \
  -i execution_param_filename=/reports/execution/Params.json