qns.entity.monitor package

Submodules

qns.entity.monitor.monitor module

class qns.entity.monitor.monitor.Monitor(name: str | None = None, network=None)

Bases: Entity

add_attribution(name: str, calculate_func: Callable[[Simulator, Any, Event | None], Any]) → None

Set an attribution that will be recorded. For example, an attribution could be the throughput, or the fidelity.

Parameters:

• name (str) – the column’s name, e.g., fidelity, throughput, time …

• calculate_func (Callable[[Simulator, Optional[QuantumNetwork], Optional[Event]]) – a function to calculate the value, it has three input parameters (Simulator, QuantumNetwork, Event), and it returns the value.

Usage:

m = Monitor()

# record the event happening time m.add_attribution(“time”, lambda s,n,e: e.t)

# get the ‘name’ attribution of the last node m.add_attribution(“count”, lambda s,network,e: network.nodes[-1].name)

at_event(event_type) → None

Watch network status whenever the event happends

Parameters:

event_type (Event) – the watching event

Usage:

# record network status when a node receives a qubit m.at_event(RecvQubitPacket)

at_finish() → None

Watch the final status after the simulation.

Usage:

m.at_finish()

at_period(period_time: float) → None

Watch network status at a constant period.

Parameters:

period_time (float) – the period of watching network status [s]

Usage:

# record network status every 3 seconds. m.at_period(3)

at_start() → None

Watch the initial status before the simulation starts.

Usage:

m.at_start()

calculate_date(event: Event)

get_date()

Get the collected data.

Returns:

the collected data, as a pd.DataFrame.

handle(event: Event) → None

handle is called to process an receiving Event.

Parameters:

event (qns.simulator.event.Event) – the event that send to this entity

install(simulator: Simulator) → None

install is called before simulator runs to initialize or set initial events

Parameters:

simulator (qns.simulator.simulator.Simulator) – the simulator

class qns.entity.monitor.monitor.MonitorEvent(t: Time | None, monitor, name: str | None = None, by: Any | None = None)

Bases: Event

the event that notify the monitor to write down network status

invoke() → None

Invoke the event, should be implemented

Module contents

class qns.entity.monitor.Monitor(name: str | None = None, network=None)

Bases: Entity

add_attribution(name: str, calculate_func: Callable[[Simulator, Any, Event | None], Any]) → None

Set an attribution that will be recorded. For example, an attribution could be the throughput, or the fidelity.

Parameters:

• name (str) – the column’s name, e.g., fidelity, throughput, time …

• calculate_func (Callable[[Simulator, Optional[QuantumNetwork], Optional[Event]]) – a function to calculate the value, it has three input parameters (Simulator, QuantumNetwork, Event), and it returns the value.

Usage:

m = Monitor()

# record the event happening time m.add_attribution(“time”, lambda s,n,e: e.t)

# get the ‘name’ attribution of the last node m.add_attribution(“count”, lambda s,network,e: network.nodes[-1].name)

at_event(event_type) → None

Watch network status whenever the event happends

Parameters:

event_type (Event) – the watching event

Usage:

# record network status when a node receives a qubit m.at_event(RecvQubitPacket)

at_finish() → None

Watch the final status after the simulation.

Usage:

m.at_finish()

at_period(period_time: float) → None

Watch network status at a constant period.

Parameters:

period_time (float) – the period of watching network status [s]

Usage:

# record network status every 3 seconds. m.at_period(3)

at_start() → None

Watch the initial status before the simulation starts.

Usage:

m.at_start()

calculate_date(event: Event)

get_date()

Get the collected data.

Returns:

the collected data, as a pd.DataFrame.

handle(event: Event) → None

handle is called to process an receiving Event.

Parameters:

event (qns.simulator.event.Event) – the event that send to this entity

install(simulator: Simulator) → None

install is called before simulator runs to initialize or set initial events

Parameters:

simulator (qns.simulator.simulator.Simulator) – the simulator

class qns.entity.monitor.MonitorEvent(t: Time | None, monitor, name: str | None = None, by: Any | None = None)

Bases: Event

the event that notify the monitor to write down network status

invoke() → None

Invoke the event, should be implemented