Merge remote-tracking branch 'origin/dev' into feature/915_PRI-31_Packaging_Deployment

# Conflicts:
#	docs/source/about.rst
#	docs/source/config.rst
#	src/primaite/common/config_values_main.py
#	src/primaite/environment/primaite_env.py
#	src/primaite/main.py
#	tests/config/multidiscrete_obs_space_laydown_config.yaml
#	tests/config/obs_tests/laydown.yaml
#	tests/conftest.py
#	tests/test_observation_space.py

src/primaite/common/config_values_main.py

@@ -0,0 +1,91 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+"""The config class."""
+
+
+class ConfigValuesMain(object):
+    """Class to hold main config values."""
+
+    def __init__(self):
+        """Init."""
+        # Generic
+        self.agent_identifier = ""  # the agent in use
+        self.observation_config = None  # observation space config
+        self.num_episodes = 0  # number of episodes to train over
+        self.num_steps = 0  # number of steps in an episode
+        self.time_delay = 0  # delay between steps (ms) - applies to generic agents only
+        self.config_filename_use_case = ""  # the filename for the Use Case config file
+        self.session_type = ""  # the session type to run (TRAINING or EVALUATION)
+
+        # Environment
+        self.observation_space_high_value = (
+            0  # The high value for the observation space
+        )
+
+        # Reward values
+        # Generic
+        self.all_ok = 0
+        # Node Hardware State
+        self.off_should_be_on = 0
+        self.off_should_be_resetting = 0
+        self.on_should_be_off = 0
+        self.on_should_be_resetting = 0
+        self.resetting_should_be_on = 0
+        self.resetting_should_be_off = 0
+        self.resetting = 0
+        # Node Software or Service State
+        self.good_should_be_patching = 0
+        self.good_should_be_compromised = 0
+        self.good_should_be_overwhelmed = 0
+        self.patching_should_be_good = 0
+        self.patching_should_be_compromised = 0
+        self.patching_should_be_overwhelmed = 0
+        self.patching = 0
+        self.compromised_should_be_good = 0
+        self.compromised_should_be_patching = 0
+        self.compromised_should_be_overwhelmed = 0
+        self.compromised = 0
+        self.overwhelmed_should_be_good = 0
+        self.overwhelmed_should_be_patching = 0
+        self.overwhelmed_should_be_compromised = 0
+        self.overwhelmed = 0
+        # Node File System State
+        self.good_should_be_repairing = 0
+        self.good_should_be_restoring = 0
+        self.good_should_be_corrupt = 0
+        self.good_should_be_destroyed = 0
+        self.repairing_should_be_good = 0
+        self.repairing_should_be_restoring = 0
+        self.repairing_should_be_corrupt = 0
+        self.repairing_should_be_destroyed = (
+            0  # Repairing does not fix destroyed state - you need to restore
+        )
+        self.repairing = 0
+        self.restoring_should_be_good = 0
+        self.restoring_should_be_repairing = 0
+        self.restoring_should_be_corrupt = (
+            0  # Not the optimal method (as repair will fix corruption)
+        )
+        self.restoring_should_be_destroyed = 0
+        self.restoring = 0
+        self.corrupt_should_be_good = 0
+        self.corrupt_should_be_repairing = 0
+        self.corrupt_should_be_restoring = 0
+        self.corrupt_should_be_destroyed = 0
+        self.corrupt = 0
+        self.destroyed_should_be_good = 0
+        self.destroyed_should_be_repairing = 0
+        self.destroyed_should_be_restoring = 0
+        self.destroyed_should_be_corrupt = 0
+        self.destroyed = 0
+        self.scanning = 0
+        # IER status
+        self.red_ier_running = 0
+        self.green_ier_blocked = 0
+
+        # Patching / Reset
+        self.os_patching_duration = 0  # The time taken to patch the OS
+        self.node_reset_duration = 0  # The time taken to reset a node (hardware)
+        self.service_patching_duration = 0  # The time taken to patch a service
+        self.file_system_repairing_limit = 0  # The time take to repair a file
+        self.file_system_restoring_limit = 0  # The time take to restore a file
+        self.file_system_scanning_limit = 0  # The time taken to scan the file system