Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/StakeEngine/math-sdk/llms.txt

Use this file to discover all available pages before exploring further.

​
System requirements

Python 3.12 or later is required. The stakeengine package declares python_requires=">=3.12" and will not install on earlier versions.
RequirementVersionNotes
Python>= 3.12Must be on your PATH as python3
pipany recentIncluded with Python 3.12+
MakeanyRecommended; simplifies setup and running games
Rust / CargostableOnly required for the optimization algorithm
If you have Make and Python 3.12+ installed, run: 
make setup
This executes the following steps in order:
  1. python3 -m venv env — creates a virtual environment at env/.
  2. pip install --upgrade pip — ensures pip is up to date inside the environment.
  3. pip install -r requirements.txt — installs all dependencies (numpy, zstandard, boto3, pytest, xlsxwriter, matplotlib, and others).
  4. pip install -e . — installs the stakeengine package in editable mode so local source changes take effect immediately.
After setup, activate the virtual environment before running scripts directly: 
source env/bin/activate
make run GAME=<game_id> activates the virtual environment automatically. Manual activation is only needed when you run Python scripts directly.

​
Manual installation

If you prefer not to use Make, follow these steps.
1

Create a virtual environment

python3 -m venv env
This creates an isolated Python environment at env/ in the project root.
2

Activate the virtual environment

source env/bin/activate
Your shell prompt will change to show (env) when the environment is active.
3

Install dependencies

python3 -m pip install -r requirements.txt
This installs all packages listed in requirements.txt, including:
  • numpy — array operations for reel and board math
  • zstandard — compressed .jsonl.zst book files
  • boto3 / botocore — optional S3 upload support
  • pytest — test runner
  • xlsxwriter — PAR sheet generation
  • matplotlib — analysis charts
  • python-dotenv — environment variable management
4

Install the package in editable mode

python3 -m pip install -e .
The -e flag installs the stakeengine package in editable (development) mode. Changes you make to the source files under src/ are reflected immediately without reinstalling.

​
Verify installation

Check that the package is listed: 
python3 -m pip list | grep stakeengine
Or confirm the import works: 
python3 -c "import stakeengine; print('OK')"

​
Installing Rust / Cargo

Rust and Cargo are only required if you plan to run the optimization algorithm that adjusts simulation weights to hit a target RTP. If you are only running simulations or inspecting output, you can skip this step. 
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Follow the on-screen prompts. After installation, restart your terminal and verify: 
cargo --version
See the Rust getting started guide for platform-specific instructions.

​
Deactivating the virtual environment

When you are done working, deactivate the virtual environment: 
deactivate

Build docs developers (and LLMs) love

Get started for freeTalk to us