gym-csle-stopping-game 0.9.5

OpenAI gym reinforcement learning environment of a Dynkin (Optimal stopping) game in CSLE

gym-csle-stopping-game

An OpenAI gym reinforcement learning environment that represents the optimal stopping game described in Intrusion Prevention Through Optimal Stopping and Learning Security Strategies through Game Play and Optimal Stopping

Requirements

• Python 3.8+
• csle-base
• csle-common
• csle-attacker
• csle-defender
• csle-collector
• gymnasium for specifying the RL environment API

Development Requirements

• Python 3.8+
• flake8 (for linting)
• flake8-rst-docstrings (for linting docstrings)
• tox (for automated testing)
• pytest (for unit tests)
• pytest-cov (for unit test coverage)
• pytest-mock (for mocking tests)
• pytest-grpc (for grpc tests)
• mypy (for static typing)
• mypy-extensions (for static typing)
• mypy-protobuf (for static typing)
• types-PyYaml (for static typing)
• types-paramiko (for static typing)
• types-protobuf (for static typing)
• types-requests (for static typing)
• types-urllib3 (for static typing)
• sphinx (for API documentation)
• sphinxcontrib-napoleon (for API documentation)
• sphinx-rtd-theme (for API documentation)

Installation

# install from pip
pip install gym-csle-stopping-game==<version>
# local install from source
$ pip install -e gym-csle-stopping-game
# or (equivalently):
make install
# force upgrade deps
$ pip install -e gym-csle-stopping-game --upgrade
# git clone and install from source
git clone https://github.com/Kim-Hammar/csle
cd csle/simulation-system/libs/gym-csle-stopping-game
pip3 install -e .
# Install development dependencies
$ pip install -r requirements_dev.txt

Development tools

Install all development tools at once:

make install_dev

or

pip install -r requirements_dev.txt

API documentation

This section contains instructions for generating API documentation using sphinx.

Latest Documentation

The latest documentation is available at https://kim-hammar.github.io/csle//docs/gym-csle-stopping-game

Generate API Documentation

First make sure that the CSLE_HOME environment variable is set:

echo $CSLE_HOME

Then generate the documentation with the commands:

cd docs
sphinx-apidoc -f -o source/ ../src/gym_csle_stopping_game/
make html

To update the official documentation at https://kim-hammar.github.io/csle/, copy the generated HTML files to the documentation folder:

cp -r build/html ../../../../docs/_docs/gym-csle-stopping-game

To run all documentation commands at once, use the command:

make docs

Static code analysis

To run the Python linter, execute the following command:

flake8 .
# or (equivalently):
make lint

To run the mypy type checker, execute the following command:

mypy .
# or (equivalently):
make types

Unit tests

To run the unit tests, execute the following command:

pytest
# or (equivalently):
make unit_tests

To run tests of a specific test suite, execute the following command:

pytest -k "ClassName"

To generate a coverage report, execute the following command:

pytest --cov=gym_csle_stopping_game

Run tests and code analysis in different python environments

To run tests and code analysis in different python environemnts, execute the following command:

tox
# or (equivalently):
make tests

Create a new release and publish to PyPi

First build the package by executing:

python3 -m build
# or (equivalently)
make build

After running the command above, the built package is available at ./dist.

Push the built package to PyPi by running:

python3 -m twine upload dist/*
# or (equivalently)
make push

To run all commands for the release at once, execute:

make release

Author & Maintainer

Kim Hammar [e-mail]

Copyright and license

LICENSE

Creative Commons

(C) 2020-2025, Kim Hammar