Change scheduler naming (#188)

Author: abbiemery

docs/images/tickit-overview-with-system-component.svg

@@ -22,7 +22,7 @@ System Simulation
 
 System simulation components are themselves entire tickit simulations. They
 contain their own device simulation components and a scheduler for orchestrating
-them. However, the scheduler in a system component acts as a slave scheduler
+them. However, the scheduler in a system component acts as a nested scheduler
 which is driven by the master scheduler in the top level of the simulation
 it belongs to.
 
@@ -75,7 +75,7 @@ The Overall Simulation
 
 A simulation containing both types of component will look something like this:
 
-.. figure:: ../../images/tickit-simple-overview-with-system-simulation.svg
+.. figure:: ../../images/tickit-overview-with-system-component.svg
     :align: center
 
 

docs/images/tickit-simple-overview-with-system-simulation.svg

@@ -20,7 +20,7 @@ Glossary
         unpredictable internal changes.
 
     System Simulation
-        A system simulation is a component which wraps a slave scheduler and a
+        A system simulation is a component which wraps a nested scheduler and a
         collection of components, allowing for infinitely nested systems.
 
     Device Simulation

docs/user/explanations/components.rst

@@ -85,11 +85,11 @@ This is the internal API reference for tickit
                 ``tickit.core.management.schedulers.master``
                 --------------------------------------------
 
-            .. automodule:: tickit.core.management.schedulers.slave
+            .. automodule:: tickit.core.management.schedulers.nested
                 :members:
 
-                ``tickit.core.management.schedulers.slave``
-                -------------------------------------------
+                ``tickit.core.management.schedulers.nested``
+                --------------------------------------------
 
 
         .. automodule:: tickit.core.management.event_router

docs/user/explanations/glossary.rst

@@ -35,7 +35,7 @@ class Component:
     An interface for types which implement stand-alone simulation components.
     Components define the top level building blocks of a tickit simulation (examples
     include the DeviceComponent which host a device and corresponding adapter or a
-    SystemComponent which hosts a SlaveScheduler and internal Components).
+    SystemComponent which hosts a NestedScheduler and internal Components).
     """
 
     name: ComponentID

docs/user/reference/api.rst

@@ -9,7 +9,7 @@
 from tickit.core.adapter import AdapterContainer
 from tickit.core.components.component import BaseComponent, Component, ComponentConfig
 from tickit.core.management.event_router import InverseWiring
-from tickit.core.management.schedulers.slave import SlaveScheduler
+from tickit.core.management.schedulers.nested import NestedScheduler
 from tickit.core.state_interfaces.state_interface import StateConsumer, StateProducer
 from tickit.core.typedefs import Changes, ComponentID, ComponentPort, PortID, SimTime
 from tickit.utils.topic_naming import output_topic
@@ -19,9 +19,9 @@
 
 @dataclass
 class SystemComponent(BaseComponent):
-    """A component containing a slave scheduler and several components.
+    """A component containing a nested scheduler and several components.
 
-    A component which acts as a nested tickit simulation by wrapping a slave scheduler
+    A component which acts as a nested tickit simulation by wrapping a NestedScheduler
     and a set of internal components, this component delegates core behaviour to the
     components within it, whilst outputting their requests for wakeups and interrupts.
     """
@@ -49,7 +49,7 @@ async def run_forever(
         blocks until and of the components or the scheduler complete.
         """
         inverse_wiring = InverseWiring.from_component_configs(self.components)
-        self.scheduler = SlaveScheduler(
+        self.scheduler = NestedScheduler(
             inverse_wiring,
             state_consumer,
             state_producer,
@@ -75,10 +75,10 @@ async def run_forever(
             await asyncio.wait(self._tasks)
 
     async def on_tick(self, time: SimTime, changes: Changes) -> None:
-        """Delegates core behaviour to the slave scheduler.
+        """Delegates core behaviour to the nested scheduler.
 
         An asynchronous method which delegates core behaviour of computing changes and
-        determining a callback period to the slave scheduler and sends the resulting
+        determining a callback period to the nested scheduler and sends the resulting
         Output.
 
         Args:

src/tickit/core/components/component.py

@@ -20,8 +20,8 @@
 LOGGER = logging.getLogger(__name__)
 
 
-class SlaveScheduler(BaseScheduler):
-    """A slave scheduler which orchestrates nested tickit simulations."""
+class NestedScheduler(BaseScheduler):
+    """A scheduler which orchestrates nested tickit simulations."""
 
     def __init__(
         self,
@@ -31,7 +31,7 @@ def __init__(
         expose: Dict[PortID, ComponentPort],
         raise_interrupt: Callable[[], Awaitable[None]],
     ) -> None:
-        """Slave scheduler constructor which adds wiring and saves values for reference.
+        """NestedScheduler constructor which adds wiring and saves values for reference.
 
         Args:
             wiring (Union[Wiring, InverseWiring]): A wiring or inverse wiring object
@@ -40,10 +40,10 @@ def __init__(
                 by the component.
             state_producer (Type[StateProducer]): The state producer class to be used
                 by the component.
-            expose (Dict[PortID, ComponentPort]): A mapping of slave scheduler
+            expose (Dict[PortID, ComponentPort]): A mapping of nested scheduler
                 outputs to internal component ports.
             raise_interrupt (Callable[[], Awaitable[None]]): A callback to request that
-                the slave scheduler is updated immediately.
+                the nested scheduler is updated immediately.
         """
         wiring = self.add_exposing_wiring(wiring, expose)
         super().__init__(wiring, state_consumer, state_producer)
@@ -57,22 +57,22 @@ def add_exposing_wiring(
         wiring: Union[Wiring, InverseWiring],
         expose: Dict[PortID, ComponentPort],
     ) -> InverseWiring:
-        """Adds wiring to expose slave scheduler outputs.
+        """Adds wiring to expose nested scheduler outputs.
 
-        Adds wiring to expose slave scheduler outputs, this is performed creating a
+        Adds wiring to expose nested scheduler outputs, this is performed creating a
         mock "expose" component with inverse wiring set by expose.
 
         Args:
             wiring (Union[Wiring, InverseWiring]): A wiring or inverse wiring object
                 representing the connections between components in the system.
-            expose (Dict[PortID, ComponentPort]): A mapping of slave scheduler
+            expose (Dict[PortID, ComponentPort]): A mapping of nested scheduler
                 outputs to internal component ports.
 
         Returns:
             InverseWiring:
                 An inverse wiring object representing the connections between
                 components in the system and the "expose" component which acts as the
-                slave scheduler output.
+                nested scheduler output.
         """
         if isinstance(wiring, Wiring):
             wiring = InverseWiring.from_wiring(wiring)
@@ -109,7 +109,7 @@ async def on_tick(
 
         An asynchronous method which determines which components within the simulation
         require being woken up, sets the input changes for use by the "external" mock
-        component, performs a tick, determines the period in which the slave scheduler
+        component, performs a tick, determines the period in which the nested scheduler
         should next be updated, and returns the changes collated by the "expose" mock
         component.
 
@@ -122,7 +122,7 @@ async def on_tick(
             Tuple[Changes, Optional[SimTime]]:
                 A tuple of a mapping of the changed exposed outputs and their new
                 values and optionally a duration in simulation time after which the
-                slave scheduler should be called again.
+                nested scheduler should be called again.
         """
         wakeup_components = {
             component for component, when in self.wakeups.items() if when <= time
@@ -163,7 +163,7 @@ async def schedule_interrupt(self, source: ComponentID) -> None:
     async def handle_component_exception(self, message: ComponentException) -> None:
         """Handle exceptions raised from components by shutting down the simulation.
 
-        If a component inside a system simulation produces an exception, the slave
+        If a component inside a system simulation produces an exception, the nested
         scheduler will produce a message to all components it contains to cause them
         to cancel any running component tasks (adapter tasks). Afterwards the scheduler
         stores the ComponentException message, allowing its associated system simulation