#2912 - Merge in changes on target branch

2025-01-03 14:48:18 +00:00
parent ab2dd6ca27 eb91721518
commit e653afaa4c
407 changed files with 664 additions and 671 deletions
--- a/benchmark/benchmark.py
+++ b/benchmark/benchmark.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from typing import Any, Dict, Optional, Tuple

 from gymnasium.core import ObsType
--- a/benchmark/primaite_benchmark.py
+++ b/benchmark/primaite_benchmark.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import json
 import shutil
 from datetime import datetime
--- a/benchmark/report.py
+++ b/benchmark/report.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import json
 import sys
 from datetime import datetime
--- a/benchmark/utils.py
+++ b/benchmark/utils.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import platform
 from typing import Dict

--- a/docs/_templates/custom-class-template.rst
+++ b/docs/_templates/custom-class-template.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ..
    Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.
--- a/docs/_templates/custom-module-template.rst
+++ b/docs/_templates/custom-module-template.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ..
    Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -2,7 +2,7 @@

 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ..
   DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 # Configuration file for the Sphinx documentation builder.
 #
 # For the full list of built-in configuration values, see the documentation:
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 Welcome to PrimAITE's documentation
 ====================================
--- a/docs/source/action_masking.rst
+++ b/docs/source/action_masking.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 Action Masking
 **************
--- a/docs/source/config.rst
+++ b/docs/source/config.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 PrimAITE |VERSION| Configuration
 ********************************
--- a/docs/source/configuration/agents.rst
+++ b/docs/source/configuration/agents.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK


 ``agents``
--- a/docs/source/configuration/game.rst
+++ b/docs/source/configuration/game.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK


 ``game``
--- a/docs/source/configuration/io_settings.rst
+++ b/docs/source/configuration/io_settings.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK


 ``io_settings``
--- a/docs/source/configuration/simulation.rst
+++ b/docs/source/configuration/simulation.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK


 ``simulation``
--- a/docs/source/configuration/simulation/nodes/common/common.rst
+++ b/docs/source/configuration/simulation/nodes/common/common.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _Node Attributes:

--- a/docs/source/configuration/simulation/nodes/common/common_host_node_attributes.rst
+++ b/docs/source/configuration/simulation/nodes/common/common_host_node_attributes.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _common_host_node_attributes:

--- a/docs/source/configuration/simulation/nodes/common/common_network_node_attributes.rst
+++ b/docs/source/configuration/simulation/nodes/common/common_network_node_attributes.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _common_network_node_attributes:

--- a/docs/source/configuration/simulation/nodes/common/common_node_attributes.rst
+++ b/docs/source/configuration/simulation/nodes/common/common_node_attributes.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _common_node_attributes:

--- a/docs/source/configuration/simulation/nodes/common/node_type_list.rst
+++ b/docs/source/configuration/simulation/nodes/common/node_type_list.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ``type``
 --------
--- a/docs/source/configuration/simulation/nodes/computer.rst
+++ b/docs/source/configuration/simulation/nodes/computer.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _computer_configuration:

--- a/docs/source/configuration/simulation/nodes/firewall.rst
+++ b/docs/source/configuration/simulation/nodes/firewall.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _firewall_configuration:

--- a/docs/source/configuration/simulation/nodes/network_examples.rst
+++ b/docs/source/configuration/simulation/nodes/network_examples.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _network_examples:

--- a/docs/source/configuration/simulation/nodes/router.rst
+++ b/docs/source/configuration/simulation/nodes/router.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _router_configuration:

--- a/docs/source/configuration/simulation/nodes/server.rst
+++ b/docs/source/configuration/simulation/nodes/server.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _server_configuration:

--- a/docs/source/configuration/simulation/nodes/switch.rst
+++ b/docs/source/configuration/simulation/nodes/switch.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _switch_configuration:

--- a/docs/source/configuration/simulation/software/applications.rst
+++ b/docs/source/configuration/simulation/software/applications.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ``applications``
 ----------------
--- a/docs/source/configuration/simulation/software/services.rst
+++ b/docs/source/configuration/simulation/software/services.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ``services``
 ------------
--- a/docs/source/customising_scenarios.rst
+++ b/docs/source/customising_scenarios.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 Customising Agents
 ******************
--- a/docs/source/dependencies.rst
+++ b/docs/source/dependencies.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. role::  raw-html(raw)
    :format: html
--- a/docs/source/developer_tools.rst
+++ b/docs/source/developer_tools.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _Developer Tools:

--- a/docs/source/environment.rst
+++ b/docs/source/environment.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 RL Environments
 ***************
--- a/docs/source/example_notebooks.rst
+++ b/docs/source/example_notebooks.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _example jupyter notebooks:

--- a/docs/source/game_layer.rst
+++ b/docs/source/game_layer.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 PrimAITE Game layer
 *******************
--- a/docs/source/getting_started.rst
+++ b/docs/source/getting_started.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _getting-started:

--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 Glossary
 =============
--- a/docs/source/how_to_guides/extensible_rewards.rst
+++ b/docs/source/how_to_guides/extensible_rewards.rst
@@ -0,0 +1,57 @@
+.. only:: comment
+
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+
+.. _about:
+
+Extensible Rewards
+******************
+Extensible Rewards differ from the previous reward mechanism used in PrimAITE v3.x as new reward
+types can be added without requiring a change to the RewardFunction class in rewards.py (PrimAITE
+core repository).
+
+Changes to reward class structure.
+==================================
+
+Reward classes are inherited from AbstractReward (a sub-class of Pydantic's BaseModel).
+Within the reward class there is a ConfigSchema class responsible for ensuring the config file data
+is in the correct format. This also means there is little (if no) requirement for and `__init__`
+method. The `.from_config` method is no longer required as it's inherited from `AbstractReward`.
+Each class requires an identifier string which is used by the ConfigSchema class to verify that it
+hasn't previously been added to the registry.
+
+Inheriting from `BaseModel` removes the need for an `__init__` method but means that object
+attributes need to be passed by keyword.
+
+To add a new reward class follow the example below. Note that the type attribute in the
+`ConfigSchema` class should match the type used in the config file to define the reward.
+
+.. code-block:: Python
+
+class DatabaseFileIntegrity(AbstractReward, identifier="DATABASE_FILE_INTEGRITY"):
+    """Reward function component which rewards the agent for maintaining the integrity of a database file."""
+
+    config: "DatabaseFileIntegrity.ConfigSchema"
+    location_in_state: List[str] = [""]
+    reward: float = 0.0
+
+    class ConfigSchema(AbstractReward.ConfigSchema):
+        """ConfigSchema for DatabaseFileIntegrity."""
+
+        type: str = "DATABASE_FILE_INTEGRITY"
+        node_hostname: str
+        folder_name: str
+        file_name: str
+
+    def calculate(self, state: Dict, last_action_response: "AgentHistoryItem") -> float:
+        """Calculate the reward for the current state.
+        pass
+
+
+
+Changes to YAML file.
+=====================
+.. code:: YAML
+
+    There's no longer a need to provide a `dns_server` as an option in the simulation section
+    of the config file.
--- a/docs/source/node_sets.rst
+++ b/docs/source/node_sets.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _network_node_adder:

--- a/docs/source/notebooks/executed_notebooks.rst
+++ b/docs/source/notebooks/executed_notebooks.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _Executed Notebooks:

--- a/docs/source/primaite-dependencies.rst
+++ b/docs/source/primaite-dependencies.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 +-------------------+---------+------------------------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
 | Name              | Version | License                            | Description                                                                                           | URL                                                                |
--- a/docs/source/request_system.rst
+++ b/docs/source/request_system.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 Request System
 **************
--- a/docs/source/rewards.rst
+++ b/docs/source/rewards.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 Rewards
 #######
--- a/docs/source/simulation.rst
+++ b/docs/source/simulation.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK


 Simulation
--- a/docs/source/simulation_components/network/airspace.rst
+++ b/docs/source/simulation_components/network/airspace.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _airspace:

--- a/docs/source/simulation_components/network/base_hardware.rst
+++ b/docs/source/simulation_components/network/base_hardware.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 #############
 Base Hardware
--- a/docs/source/simulation_components/network/network.rst
+++ b/docs/source/simulation_components/network/network.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _network:

--- a/docs/source/simulation_components/network/network_interfaces.rst
+++ b/docs/source/simulation_components/network/network_interfaces.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 #################################
 Network Interface Hierarchy Model
--- a/docs/source/simulation_components/network/nodes/firewall.rst
+++ b/docs/source/simulation_components/network/nodes/firewall.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ########
 Firewall
--- a/docs/source/simulation_components/network/nodes/host_node.rst
+++ b/docs/source/simulation_components/network/nodes/host_node.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK


 #########
--- a/docs/source/simulation_components/network/nodes/network_node.rst
+++ b/docs/source/simulation_components/network/nodes/network_node.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ############
 Network Node
--- a/docs/source/simulation_components/network/nodes/router.rst
+++ b/docs/source/simulation_components/network/nodes/router.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ######
 Router
--- a/docs/source/simulation_components/network/nodes/switch.rst
+++ b/docs/source/simulation_components/network/nodes/switch.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ######
 Switch
--- a/docs/source/simulation_components/network/nodes/wireless_router.rst
+++ b/docs/source/simulation_components/network/nodes/wireless_router.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ######
 Wireless Router
--- a/docs/source/simulation_components/network/transport_to_data_link_layer.rst
+++ b/docs/source/simulation_components/network/transport_to_data_link_layer.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 Transport Layer to Data Link Layer
 ==================================
--- a/docs/source/simulation_components/system/applications/c2_suite.rst
+++ b/docs/source/simulation_components/system/applications/c2_suite.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _C2_Suite:

--- a/docs/source/simulation_components/system/applications/data_manipulation_bot.rst
+++ b/docs/source/simulation_components/system/applications/data_manipulation_bot.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _DataManipulationBot:

--- a/docs/source/simulation_components/system/applications/database_client.rst
+++ b/docs/source/simulation_components/system/applications/database_client.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _DatabaseClient:

--- a/docs/source/simulation_components/system/applications/dos_bot.rst
+++ b/docs/source/simulation_components/system/applications/dos_bot.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _DoSBot:

--- a/docs/source/simulation_components/system/applications/nmap.rst
+++ b/docs/source/simulation_components/system/applications/nmap.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _NMAP:

--- a/docs/source/simulation_components/system/applications/ransomware_script.rst
+++ b/docs/source/simulation_components/system/applications/ransomware_script.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _RansomwareScript:

--- a/docs/source/simulation_components/system/applications/web_browser.rst
+++ b/docs/source/simulation_components/system/applications/web_browser.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _WebBrowser:

--- a/docs/source/simulation_components/system/common/common_configuration.rst
+++ b/docs/source/simulation_components/system/common/common_configuration.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _Common Configuration:

--- a/docs/source/simulation_components/system/common/db_payload_list.rst
+++ b/docs/source/simulation_components/system/common/db_payload_list.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _Database Payload List:

--- a/docs/source/simulation_components/system/internal_frame_processing.rst
+++ b/docs/source/simulation_components/system/internal_frame_processing.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _internal_frame_processing:

--- a/docs/source/simulation_components/system/list_of_applications.rst
+++ b/docs/source/simulation_components/system/list_of_applications.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. toctree::
    :maxdepth: 1
--- a/docs/source/simulation_components/system/list_of_services.rst
+++ b/docs/source/simulation_components/system/list_of_services.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. toctree::
    :maxdepth: 1
--- a/docs/source/simulation_components/system/list_of_system_applications.rst
+++ b/docs/source/simulation_components/system/list_of_system_applications.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ``system applications``
 """""""""""""""""""""""
--- a/docs/source/simulation_components/system/list_of_system_services.rst
+++ b/docs/source/simulation_components/system/list_of_system_services.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 ``system services``
 """""""""""""""""""
--- a/docs/source/simulation_components/system/pcap.rst
+++ b/docs/source/simulation_components/system/pcap.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 PCAP
 ====
--- a/docs/source/simulation_components/system/services/database_service.rst
+++ b/docs/source/simulation_components/system/services/database_service.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _DatabaseService:

--- a/docs/source/simulation_components/system/services/dns_client.rst
+++ b/docs/source/simulation_components/system/services/dns_client.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _DNSClient:

--- a/docs/source/simulation_components/system/services/dns_server.rst
+++ b/docs/source/simulation_components/system/services/dns_server.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _DNSServer:

--- a/docs/source/simulation_components/system/services/ftp_client.rst
+++ b/docs/source/simulation_components/system/services/ftp_client.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _FTPClient:

--- a/docs/source/simulation_components/system/services/ftp_server.rst
+++ b/docs/source/simulation_components/system/services/ftp_server.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _FTPServer:

--- a/docs/source/simulation_components/system/services/ntp_client.rst
+++ b/docs/source/simulation_components/system/services/ntp_client.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _NTPClient:

--- a/docs/source/simulation_components/system/services/ntp_server.rst
+++ b/docs/source/simulation_components/system/services/ntp_server.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _NTPServer:

--- a/docs/source/simulation_components/system/services/terminal.rst
+++ b/docs/source/simulation_components/system/services/terminal.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _Terminal:

--- a/docs/source/simulation_components/system/services/web_server.rst
+++ b/docs/source/simulation_components/system/services/web_server.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _WebServer:

--- a/docs/source/simulation_components/system/session_and_software_manager.rst
+++ b/docs/source/simulation_components/system/session_and_software_manager.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 Session and Software Manager
 ============================
--- a/docs/source/simulation_components/system/software.rst
+++ b/docs/source/simulation_components/system/software.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 .. _software:

--- a/docs/source/simulation_components/system/sys_log.rst
+++ b/docs/source/simulation_components/system/sys_log.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 SysLog
 ======
--- a/docs/source/simulation_structure.rst
+++ b/docs/source/simulation_structure.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK


 Simulation Structure
--- a/docs/source/state_system.rst
+++ b/docs/source/state_system.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 Simulation State
 ================
--- a/docs/source/varying_config_files.rst
+++ b/docs/source/varying_config_files.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

 Defining variations in the config files
 =======================================
--- a/src/primaite/init.py
+++ b/src/primaite/init.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import datetime as datetime
 import logging
 import logging.config
--- a/src/primaite/_legacy/actions.py
+++ b/src/primaite/_legacy/actions.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 """
 This module contains the ActionManager class which belongs to the Agent class.

--- a/src/primaite/cli.py
+++ b/src/primaite/cli.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 """Provides a CLI using Typer as an entry point."""
 import logging
 import os
--- a/src/primaite/config/init.py
+++ b/src/primaite/config/init.py
@@ -1,2 +1,2 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 """Configuration parameters for running experiments."""
--- a/src/primaite/config/load.py
+++ b/src/primaite/config/load.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from pathlib import Path
 from typing import Dict, Final, Union

--- a/src/primaite/exceptions.py
+++ b/src/primaite/exceptions.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 class PrimaiteError(Exception):
    """The root PrimAITE Error."""

--- a/src/primaite/game/init.py
+++ b/src/primaite/game/init.py
@@ -1,2 +1,2 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 """PrimAITE Game Layer."""
--- a/src/primaite/game/agent/init.py
+++ b/src/primaite/game/agent/init.py
@@ -1 +1 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
--- a/src/primaite/game/agent/agent_log.py
+++ b/src/primaite/game/agent/agent_log.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import logging
 from pathlib import Path

--- a/src/primaite/game/agent/interface.py
+++ b/src/primaite/game/agent/interface.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 """Interface for agents."""
 from abc import ABC, abstractmethod
 from typing import Any, Dict, List, Optional, Tuple, TYPE_CHECKING
--- a/src/primaite/game/agent/observations/init.py
+++ b/src/primaite/game/agent/observations/init.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 # flake8: noqa
 # Pre-import all the observations when we load up the observations module so that they can be resolved by the parser.
 from primaite.game.agent.observations.acl_observation import ACLObservation
--- a/src/primaite/game/agent/observations/acl_observation.py
+++ b/src/primaite/game/agent/observations/acl_observation.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from ipaddress import IPv4Address
--- a/src/primaite/game/agent/observations/file_system_observations.py
+++ b/src/primaite/game/agent/observations/file_system_observations.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Dict, Iterable, List, Optional
--- a/src/primaite/game/agent/observations/firewall_observation.py
+++ b/src/primaite/game/agent/observations/firewall_observation.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Dict, List, Optional
--- a/src/primaite/game/agent/observations/host_observations.py
+++ b/src/primaite/game/agent/observations/host_observations.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Dict, List, Optional
--- a/src/primaite/game/agent/observations/link_observation.py
+++ b/src/primaite/game/agent/observations/link_observation.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Any, Dict, List
--- a/Show More
+++ b/Show More