#915 - Created app dirs and set as constants in the top-level init.

- renamed _config_values_main to training_config.py and renamed the ConfigValuesMain class to TrainingConfig.
Moved training_config.py to src/primaite/config/training_config.py
- Renamed all training config yaml file keys to make creating an instance of TrainingConfig easier.
Moved action_type and num_steps over to the training config.
- Decoupled the training config and lay down config.
- Refactored main.py so that it can be ran from CLI and can take a training config path and a lay down config path.
- refactored all outputs so that they save to the session dir.
- Added some necessary setup scripts that handle creating app dirs, fronting example config files to the user, fronting demo notebooks to the user, performing clean-up in between installations etc.
- Added functions that attempt to retrieve the file path of users example config files that have been fronted by the primaite setup.
- Added logging config and a getLogger function in the top-level init.
- Refactored all logs entries logged to use a logger using the primaite logging config.
- Added basic typer CLI for doing things like setup, viewing logs, viewing primaite version, running a basic session.
- Updated test to use new features and config structures.
- Began updating docs. More to do here.

src/primaite/nodes/active_node.py

@@ -3,7 +3,6 @@
 import logging
 from typing import Final
 
-from primaite.common.config_values_main import ConfigValuesMain
 from primaite.common.enums import (
     FileSystemState,
     HardwareState,
@@ -11,6 +10,7 @@ from primaite.common.enums import (
     Priority,
     SoftwareState,
 )
+from primaite.config.training_config import TrainingConfig
 from primaite.nodes.node import Node
 
 _LOGGER: Final[logging.Logger] = logging.getLogger(__name__)
@@ -29,7 +29,7 @@ class ActiveNode(Node):
         ip_address: str,
         software_state: SoftwareState,
         file_system_state: FileSystemState,
-        config_values: ConfigValuesMain,
+        config_values: TrainingConfig,
     ):
         """
         Init.

src/primaite/nodes/node.py

@@ -2,8 +2,8 @@
 """The base Node class."""
 from typing import Final
 
-from primaite.common.config_values_main import ConfigValuesMain
 from primaite.common.enums import HardwareState, NodeType, Priority
+from primaite.config.training_config import TrainingConfig
 
 
 class Node:
@@ -16,7 +16,7 @@ class Node:
         node_type: NodeType,
         priority: Priority,
         hardware_state: HardwareState,
-        config_values: ConfigValuesMain,
+        config_values: TrainingConfig,
     ):
         """
         Init.
@@ -34,7 +34,7 @@ class Node:
         self.priority = priority
         self.hardware_state: HardwareState = hardware_state
         self.resetting_count: int = 0
-        self.config_values: ConfigValuesMain = config_values
+        self.config_values: TrainingConfig = config_values
 
     def __repr__(self):
         """Returns the name of the node."""

src/primaite/nodes/passive_node.py

@@ -1,7 +1,7 @@
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 """The Passive Node class (i.e. an actuator)."""
-from primaite.common.config_values_main import ConfigValuesMain
 from primaite.common.enums import HardwareState, NodeType, Priority
+from primaite.config.training_config import TrainingConfig
 from primaite.nodes.node import Node
 
 
@@ -15,7 +15,7 @@ class PassiveNode(Node):
         node_type: NodeType,
         priority: Priority,
         hardware_state: HardwareState,
-        config_values: ConfigValuesMain,
+        config_values: TrainingConfig,
     ):
         """
         Init.

src/primaite/nodes/service_node.py

@@ -3,7 +3,6 @@
 import logging
 from typing import Dict, Final
 
-from primaite.common.config_values_main import ConfigValuesMain
 from primaite.common.enums import (
     FileSystemState,
     HardwareState,
@@ -12,6 +11,7 @@ from primaite.common.enums import (
     SoftwareState,
 )
 from primaite.common.service import Service
+from primaite.config.training_config import TrainingConfig
 from primaite.nodes.active_node import ActiveNode
 
 _LOGGER: Final[logging.Logger] = logging.getLogger(__name__)
@@ -30,7 +30,7 @@ class ServiceNode(ActiveNode):
         ip_address: str,
         software_state: SoftwareState,
         file_system_state: FileSystemState,
-        config_values: ConfigValuesMain,
+        config_values: TrainingConfig,
     ):
         """
         Init.