#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/config/lay_down_config.py

@@ -0,0 +1,69 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+from pathlib import Path
+from typing import Final
+
+from primaite import getLogger, USERS_CONFIG_DIR
+
+_LOGGER = getLogger(__name__)
+
+_EXAMPLE_LAY_DOWN: Final[Path] = USERS_CONFIG_DIR / "example_config" / "lay_down"
+
+
+def ddos_basic_one_config_path() -> Path:
+    """
+    The path to the example lay_down_config_1_DDOS_basic.yaml file.
+
+    :return: The file path.
+    """
+    path = _EXAMPLE_LAY_DOWN / "lay_down_config_1_DDOS_basic.yaml"
+    if not path.exists():
+        msg = f"Example config not found. Please run 'primaite setup'"
+        _LOGGER.critical(msg)
+        raise FileNotFoundError(msg)
+
+    return path
+
+
+def ddos_basic_two_config_path() -> Path:
+    """
+    The path to the example lay_down_config_2_DDOS_basic.yaml file.
+
+    :return: The file path.
+    """
+    path = _EXAMPLE_LAY_DOWN / "lay_down_config_2_DDOS_basic.yaml"
+    if not path.exists():
+        msg = f"Example config not found. Please run 'primaite setup'"
+        _LOGGER.critical(msg)
+        raise FileNotFoundError(msg)
+
+    return path
+
+
+def dos_very_basic_config_path() -> Path:
+    """
+    The path to the example lay_down_config_3_DOS_very_basic.yaml file.
+
+    :return: The file path.
+    """
+    path = _EXAMPLE_LAY_DOWN / "lay_down_config_3_DOS_very_basic.yaml"
+    if not path.exists():
+        msg = f"Example config not found. Please run 'primaite setup'"
+        _LOGGER.critical(msg)
+        raise FileNotFoundError(msg)
+
+    return path
+
+
+def data_manipulation_config_path() -> Path:
+    """
+    The path to the example lay_down_config_5_data_manipulation.yaml file.
+
+    :return: The file path.
+    """
+    path = _EXAMPLE_LAY_DOWN / "lay_down_config_5_data_manipulation.yaml"
+    if not path.exists():
+        msg = f"Example config not found. Please run 'primaite setup'"
+        _LOGGER.critical(msg)
+        raise FileNotFoundError(msg)
+
+    return path