PrimAITE/docs/source/simulation.rst

.. only:: comment

    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK


Simulation
==========


Contents
########

.. toctree::
   :maxdepth: 8

   simulation_structure
   simulation_components/network/base_hardware
   simulation_components/network/network_interfaces
   simulation_components/network/transport_to_data_link_layer
   simulation_components/network/nodes/host_node
   simulation_components/network/nodes/network_node
   simulation_components/network/nodes/router
   simulation_components/network/nodes/switch
   simulation_components/network/nodes/wireless_router
   simulation_components/network/nodes/firewall
   simulation_components/network/switch
   simulation_components/network/network
   simulation_components/system/internal_frame_processing
   simulation_components/system/sys_log
   simulation_components/system/pcap
   simulation_components/system/session_and_software_manager
   simulation_components/system/software
Add SimComponent core class 2023-07-28 14:49:21 +01:00			`.. only:: comment`

			`© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK`


#1715 - Added timestep int as a param to the apply_timestep function in core.py. Also added a reset_component_for_episode function. Updated docs with details of Link and NIC. 2023-07-31 20:05:36 +01:00			`Simulation`
			`==========`
Add SimComponent core class 2023-07-28 14:49:21 +01:00
#1706 - Finished up the Node and Switch MVP. Added full extensive documentation on what's happening at each step. 2023-08-08 20:22:18 +01:00
#1715 - Added timestep int as a param to the apply_timestep function in core.py. Also added a reset_component_for_episode function. Updated docs with details of Link and NIC. 2023-07-31 20:05:36 +01:00

			`Contents`
			`########`

			`.. toctree::`
			`:maxdepth: 8`

			`simulation_structure`
#1706 - Got the core Node class build and working with ARP and the ability to ping another node. Added some basic tests in. Next job is to create the Node subclasses. Then move ARP and ICMP into a service that is used by all nodes. 2023-08-02 21:54:21 +01:00			`simulation_components/network/base_hardware`
#2248 - Enhances the PrimAITE documentation, covering the Node, network interfaces, Session Manager, Software Manager, PCAP service, SysLog functionality, and network devices like Routers, Switches, Computers, and Switch Nodes. It details their roles, workflows, and integration within the simulation, focusing on frame processing, software management, and logging. The documentation also clarifies the frame reception process, including port checks and application-level dispatching, ensuring a thorough understanding of network operations within the simulation 2024-02-08 22:37:21 +00:00			`simulation_components/network/network_interfaces`
#1724 - Added documentation for the transport layer down to data link layer 2023-08-02 12:12:08 +01:00			`simulation_components/network/transport_to_data_link_layer`
#2248 - Enhances the PrimAITE documentation, covering the Node, network interfaces, Session Manager, Software Manager, PCAP service, SysLog functionality, and network devices like Routers, Switches, Computers, and Switch Nodes. It details their roles, workflows, and integration within the simulation, focusing on frame processing, software management, and logging. The documentation also clarifies the frame reception process, including port checks and application-level dispatching, ensuring a thorough understanding of network operations within the simulation 2024-02-08 22:37:21 +00:00			`simulation_components/network/nodes/host_node`
			`simulation_components/network/nodes/network_node`
			`simulation_components/network/nodes/router`
#2257: update sphinx version + cleaning up some errors + splitting configuration page into multiple pages 2024-02-16 16:14:36 +00:00			`simulation_components/network/nodes/switch`
#2205 - Added wireless router tests and documentation. Refactored some code based on PR suggestions. 2024-02-12 12:31:08 +00:00			`simulation_components/network/nodes/wireless_router`
#2205 - Introduced a Firewall class for enhanced network security and control, extending Router functionalities. Updated ACLRule to support IP ranges via wildcard masking for refined traffic filtering. Includes documentation updates. 2024-02-09 23:29:06 +00:00			`simulation_components/network/nodes/firewall`
#2459 back-sync b8 changes into core 2024-04-15 11:50:08 +01:00			`simulation_components/network/switch`
#1800 - Added more docstrings and rst docs. - Extended the .show functionality to enable markdown format too. 2023-09-01 16:58:21 +01:00			`simulation_components/network/network`
#1816 - Updated the DataManipulationBot to subclass DatabaseClient. Extended logging. Dropped the Link loading logging as it was clogging up the terminal output. 2023-09-11 16:15:03 +01:00			`simulation_components/system/internal_frame_processing`
#2248 - Enhances the PrimAITE documentation, covering the Node, network interfaces, Session Manager, Software Manager, PCAP service, SysLog functionality, and network devices like Routers, Switches, Computers, and Switch Nodes. It details their roles, workflows, and integration within the simulation, focusing on frame processing, software management, and logging. The documentation also clarifies the frame reception process, including port checks and application-level dispatching, ensuring a thorough understanding of network operations within the simulation 2024-02-08 22:37:21 +00:00			`simulation_components/system/sys_log`
			`simulation_components/system/pcap`
			`simulation_components/system/session_and_software_manager`
#1816 - Updated the DataManipulationBot to subclass DatabaseClient. Extended logging. Dropped the Link loading logging as it was clogging up the terminal output. 2023-09-11 16:15:03 +01:00			`simulation_components/system/software`