diff --git a/.dockerignore b/.dockerignore index d37ac870..b46d4cbc 100644 --- a/.dockerignore +++ b/.dockerignore @@ -5,14 +5,18 @@ .pytest_cache .ruff_cache .vscode +dist/ docs/ +examples/ figures/ +logs/ mlruns/ +notebooks/ +NetSecGameAgents/ tests/ trajectories/ -NetSecGameAgents/ -notebooks/ readme_images/ tests/ *trajectories*.json -README.md \ No newline at end of file +README.md +mkdocs.yml \ No newline at end of file diff --git a/README.md b/README.md index 00cefef9..ab640482 100755 --- a/README.md +++ b/README.md @@ -120,7 +120,7 @@ When running in the Docker container, the NetSecGame can be started with: docker run -it --rm \ -v $(pwd)/examples/example_task_configuration.yaml:/aidojo/netsecenv_conf.yaml \ -v $(pwd)/logs:/aidojo/logs \ - -p 9000:9000 stratosphereips/netsecgame:lastest + -p 9000:9000 stratosphereips/netsecgame ``` optionally, you can set the logging level with `--debug_level=["DEBUG", "INFO", "WARNING", "CRITICAL"]` (defaul=`"INFO"`): @@ -128,7 +128,7 @@ optionally, you can set the logging level with `--debug_level=["DEBUG", "INFO", docker run -it --rm \ -v $(pwd)/examples/example_task_configuration.yaml:/aidojo/netsecenv_conf.yaml \ -v $(pwd)/logs:/aidojo/logs \ - -p 9000:9000 aidojo-local-test:latest \ + -p 9000:9000 stratosphereips/netsecgame \ --debug_level="WARNING" ``` diff --git a/docs/index.md b/docs/index.md index bd9c38cb..cf64a337 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,7 +23,6 @@ conda create --name aidojo python==3.12.10 ```bash conda activate aidojo ``` - After the virtual environment is activated, install using pip: ```bash pip install -e . @@ -33,9 +32,9 @@ The NetSecGame can be run in a Docker container. You can build the image locally ```bash docker build -t aidojo-nsg-coordinator:latest . ``` -or use the availabe image from [Dockerhub](https://hub.docker.com/r/lukasond/aidojo-coordinator). +or use the available image from [Dockerhub](https://hub.docker.com/r/stratosphereips/netsecgame). ```bash -docker pull lukasond/aidojo-coordinator:1.0.2 +docker pull stratosphereips/netsecgame ``` ## Quick Start A task configuration needs to be specified to start the NetSecGame (see [Configuration](configuration.md)). For the first step, the example task configuration is recommended: @@ -112,9 +111,18 @@ Upon which the game server is created on `localhost:9000` to which the agents ca When running in the Docker container, the NetSecGame can be started with: ```bash docker run -it --rm \ - -v $(pwd)/examples/example_config.yaml:/aidojo/netsecenv_conf.yaml \ + -v $(pwd)/examples/example_task_configuration.yaml:/aidojo/netsecenv_conf.yaml \ -v $(pwd)/logs:/aidojo/logs \ - -p 9000:9000 lukasond/aidojo-coordinator:1.0.2 + -p 9000:9000 stratosphereips/netsecgame +``` +optionally, you can set the logging level with `--debug_level=["DEBUG", "INFO", "WARNING", "CRITICAL"]` (defaul=`"INFO"`): + +```bash +docker run -it --rm \ + -v $(pwd)/examples/example_task_configuration.yaml:/aidojo/netsecenv_conf.yaml \ + -v $(pwd)/logs:/aidojo/logs \ + -p 9000:9000 stratosphereips/netsecgame \ + --debug_level="WARNING" ``` ## Documentation diff --git a/pyproject.toml b/pyproject.toml index 2001841b..318382db 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,7 +43,7 @@ dependencies = [ "tenacity==8.5.0", "typing-inspect==0.9.0", "typing_extensions==4.12.2", - "cyst-core @ git+https://github.com/AI-Dojo-Public/cyst-core.git@master" + "cyst-core>=0.5.0" ] requires-python = ">=3.12" diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 629ca25f..00000000 --- a/requirements.txt +++ /dev/null @@ -1,37 +0,0 @@ -beartype==0.17.2 -cachetools==5.3.2 -casefy==0.1.7 -cyst==0.3.4 -cyst-core==0.5.0 -dictionaries==0.0.2 -exceptiongroup==1.2.0 -Faker==23.2.1 -importlib-metadata==7.0.1 -iniconfig==2.0.0 -Jinja2==3.1.3 -jsonlines==4.0.0 -jsonpickle==3.0.2 -kaleido==0.2.1 -MarkupSafe==2.1.5 -mypy-extensions==1.0.0 -netaddr==1.2.1 -networkx==3.2.1 -numpy==1.26.4 -packaging==23.2 -plotly==5.22.0 -pluggy==1.4.0 -plum-dispatch==2.2.2 -py-flags==1.1.4 -pyaml==23.12.0 -pyserde==0.13.2 -pytest==8.0.1 -python-dateutil==2.8.2 -PyYAML==6.0.1 -redis==3.5.3 -rejson==0.5.6 -semver==3.0.2 -six==1.16.0 -tomli==2.0.1 -typing-inspect==0.9.0 -typing_extensions==4.9.0 -zipp==3.17.0