diff --git a/README.md b/README.md index 7dfe15bd..2265538a 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ PrimAITE presents the following features: ## Getting Started with PrimAITE -### 💫 Install & Run +### 💫 Installation **PrimAITE** is designed to be OS-agnostic, and thus should work on most variations/distros of Linux, Windows, and MacOS. Currently, the PrimAITE wheel can only be installed from GitHub. This may change in the future with release to PyPi. @@ -47,11 +47,6 @@ pip install https://github.com/Autonomous-Resilient-Cyber-Defence/PrimAITE/relea primaite setup ``` -**Run:** - -``` bash -primaite session -``` #### Unix @@ -75,12 +70,6 @@ pip install https://github.com/Autonomous-Resilient-Cyber-Defence/PrimAITE/relea primaite setup ``` -**Run:** - -``` bash -primaite session -``` - ### Developer Install from Source @@ -125,6 +114,29 @@ python3 -m pip install -e .[dev] primaite setup ``` +### Running PrimAITE + +Use the provided jupyter notebooks as a starting point to try running PrimAITE. They are automatically copied to your PrimAITE notebook folder when you run `primaite setup`. + +#### 1. Activate the virtual environment + +##### Windows (Powershell) +```powershell +.\venv\Scripts\activate +``` + +##### Unix +```bash +source venv/bin/activate +``` + +#### 2. Open jupyter notebook + +```bash +python -m jupyter notebook +``` +Then, click the URL provided by the jupyter command to open the jupyter application in your browser. You can also open notebooks in your IDE if supported. + ## 📚 Building documentation The PrimAITE documentation can be built with the following commands: diff --git a/src/primaite/config/_package_data/data_manipulation_marl.yaml b/src/primaite/config/_package_data/data_manipulation_marl.yaml index cb94a128..359d7c55 100644 --- a/src/primaite/config/_package_data/data_manipulation_marl.yaml +++ b/src/primaite/config/_package_data/data_manipulation_marl.yaml @@ -1458,7 +1458,7 @@ simulation: options: db_server_ip: 192.168.1.14 services: - - ty DNSClient + - type: DNSClient