Quickstart

Cloning the repository

git clone git@github.com:umbralcalc/stochadex.git
cd stochadex

Building and running the binary

# Update the go modules
go mod tidy

# Build the binary
go build -o bin/ ./cmd/stochadex

# Run your config
./bin/stochadex --config ./cfg/example_config.yaml

Running over websocket

# Run the stochadex with a socket config
./bin/stochadex --config ./cfg/example_config.yaml \
    --socket ./cfg/socket.yaml

Building and running the containerised version (may need sudo)

# Build the stochadex container
docker build -t stochadex -f Dockerfile.stochadex .

# Run the binary in the container with your configs
docker run -p 2112:2112 stochadex --config ./cfg/example_config.yaml \
    --socket ./cfg/socket.yaml

Example analysis notebooks