#1631 - Added the DEFCON 703 header to all possible files

docs/_templates/custom-class-template.rst

@@ -1,3 +1,7 @@
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
 ..
     Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.
 ..

docs/_templates/custom-module-template.rst

@@ -1,3 +1,7 @@
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
 ..
     Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.
 ..

docs/api.rst

@@ -1,3 +1,7 @@
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
 ..
    DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without
    which API documentation wouldn't get extracted from docstrings by the `sphinx.ext.autosummary` engine. It is hidden

docs/conf.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Configuration file for the Sphinx documentation builder.
 #
 # For the full list of built-in configuration values, see the documentation:

docs/index.rst

@@ -1,3 +1,7 @@
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
 Welcome to PrimAITE's documentation
 ====================================
 

docs/source/about.rst

@@ -1,4 +1,8 @@
-.. _about:
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
+.. _about:
 
 About PrimAITE
 ==============

docs/source/config.rst

@@ -1,3 +1,7 @@
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
 .. _config:
 
 The Config Files Explained

docs/source/custom_agent.rst

@@ -1,4 +1,8 @@
-Custom Agents
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
+Custom Agents
 =============
 
 

docs/source/dependencies.rst

@@ -1,3 +1,7 @@
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
 .. role::  raw-html(raw)
     :format: html
 

docs/source/getting_started.rst

@@ -1,3 +1,7 @@
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
 .. _getting-started:
 
 Getting Started

docs/source/glossary.rst

@@ -1,3 +1,7 @@
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
 Glossary
 =============
 

docs/source/migration_1.2_-_2.0.rst

@@ -1,3 +1,7 @@
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
 v1.2 to v2.0 Migration guide
 ============================
 

docs/source/primaite_session.rst

@@ -1,3 +1,7 @@
+.. only:: comment
+
+    Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+
 .. _run a primaite session:
 
 Run a PrimAITE Session
@@ -44,7 +48,8 @@ For example, when running a session at 17:30:00 on 31st January 2023, the sessio
 ``~/primaite/sessions/2023-01-31/2023-01-31_17-30-00/``.
 
 Loading a session
--------
+-----------------
+
 A previous session can be loaded by providing the **directory** of the previous session to either the ``primaite session`` command from the cli
 (See :func:`primaite.cli.session`), or by calling :func:`primaite.main.run` with session_path.
 

src/primaite/agents/__init__.py

@@ -1 +1,2 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 """Common interface between RL agents from different libraries and PrimAITE."""

src/primaite/agents/agent_abc.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 from __future__ import annotations
 
 import json

src/primaite/agents/hardcoded_abc.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import time
 from abc import abstractmethod
 from pathlib import Path

src/primaite/agents/hardcoded_acl.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 from typing import Any, Dict, List, Union
 
 import numpy as np

src/primaite/agents/hardcoded_node.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import numpy as np
 
 from primaite.agents.hardcoded_abc import HardCodedAgentSessionABC

src/primaite/agents/rllib.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 from __future__ import annotations
 
 import json

src/primaite/agents/sb3.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 from __future__ import annotations
 
 import json

src/primaite/agents/simple.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 from primaite.agents.hardcoded_abc import HardCodedAgentSessionABC
 from primaite.agents.utils import get_new_action, transform_action_acl_enum, transform_action_node_enum
 

src/primaite/agents/utils.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 from typing import Dict, List, Union
 
 import numpy as np

src/primaite/common/custom_typing.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 from typing import Type, Union
 
 from primaite.nodes.active_node import ActiveNode

src/primaite/config/__init__.py

@@ -1 +1,2 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 """Configuration parameters for running experiments."""

src/primaite/data_viz/__init__.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 """Utility to generate plots of sessions metrics after PrimAITE."""
 from enum import Enum
 

src/primaite/data_viz/session_plots.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 from pathlib import Path
 from typing import Dict, Optional, Union
 

src/primaite/environment/observations.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 """Module for handling configurable observation spaces in PrimAITE."""
 import logging
 from abc import ABC, abstractmethod

src/primaite/notebooks/__init__.py

@@ -1,5 +1,6 @@
-"""Contains default jupyter notebooks which demonstrate PrimAITE functionality."""
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+"""Contains default jupyter notebooks which demonstrate PrimAITE functionality."""
+
 import importlib.util
 import os
 import subprocess

src/primaite/pol/__init__.py

@@ -1,2 +1,2 @@
-"""Pattern of Life- Represents the actions of users on the network."""
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+"""Pattern of Life- Represents the actions of users on the network."""

src/primaite/primaite_session.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 """Main entry point to PrimAITE. Configure training/evaluation experiments and input/output."""
 from __future__ import annotations
 

src/primaite/setup/__init__.py

@@ -1,2 +1,2 @@
-"""Utilities to prepare the user's data folders."""
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+"""Utilities to prepare the user's data folders."""

src/primaite/setup/reset_example_configs.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import filecmp
 import os
 import shutil

src/primaite/transactions/__init__.py

@@ -1,2 +1,2 @@
-"""Record data of the system's state and agent's observations and actions."""
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+"""Record data of the system's state and agent's observations and actions."""

src/primaite/utils/__init__.py

@@ -1 +1,2 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 """Utilities for PrimAITE."""

src/primaite/utils/session_metadata_parser.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import json
 from pathlib import Path
 from typing import Union

src/primaite/utils/session_output_reader.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 from pathlib import Path
 from typing import Any, Dict, Tuple, Union
 

src/primaite/utils/session_output_writer.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import csv
 from logging import Logger
 from typing import Final, List, Tuple, TYPE_CHECKING, Union

tests/config/legacy_conversion/legacy_training_config.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Main Config File
 
 # Generic config values

tests/config/legacy_conversion/new_training_config.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Main Config File
 
 # Generic config values

tests/config/obs_tests/laydown.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 - item_type: PORTS
   ports_list:
     - port: '80'

tests/config/obs_tests/main_config_LINK_TRAFFIC_LEVELS.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/config/obs_tests/main_config_NODE_LINK_TABLE.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/config/obs_tests/main_config_NODE_STATUSES.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/config/obs_tests/main_config_without_obs.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/config/one_node_states_on_off_lay_down_config.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 - item_type: PORTS
   ports_list:
   - port: '21'

tests/config/one_node_states_on_off_main_config.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/config/ppo_not_seeded_training_config.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/config/ppo_seeded_training_config.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/config/single_action_space_fixed_blue_actions_main_config.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/config/single_action_space_lay_down_config.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 - item_type: PORTS
   ports_list:
   - port: '21'

tests/config/single_action_space_main_config.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/config/test_random_red_main_config.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/config/train_episode_step.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/config/training_config_main_rllib.yaml

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 # Training Config File
 
 # Sets which agent algorithm framework will be used.

tests/mock_and_patch/__init__.py

@@ -0,0 +1 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.

tests/mock_and_patch/get_session_path_mock.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import tempfile
 from datetime import datetime
 from pathlib import Path

tests/test_active_node.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 """Used to test Active Node functions."""
 import pytest
 

tests/test_observation_space.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 """Test env creation and behaviour with different observation spaces."""
 import numpy as np
 import pytest

tests/test_primaite_session.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import os
 
 import pytest

tests/test_red_random_agent_behaviour.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import pytest
 
 from primaite.config.lay_down_config import data_manipulation_config_path

tests/test_resetting_node.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 """Used to test Active Node functions."""
 import pytest
 

tests/test_reward.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import pytest
 
 from primaite import getLogger

tests/test_rllib_agent.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import pytest
 
 from primaite import getLogger

tests/test_seeding_and_deterministic_session.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import pytest as pytest
 
 from primaite.config.lay_down_config import dos_very_basic_config_path

tests/test_service_node.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 """Used to test Service Node functions."""
 import pytest
 

tests/test_session_loading.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import os.path
 import shutil
 import tempfile

tests/test_single_action_space.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import time
 
 import pytest

tests/test_train_eval_episode_steps.py

@@ -1,3 +1,4 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import pytest
 
 from primaite import getLogger