update docstrings and changelog

QuantumSavory · Oct 4, 2024 · 12bf5f5 · 12bf5f5
1 parent 33d4b20
commit 12bf5f5
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,8 +3,10 @@
 ## v0.6.0 - 2024-09-13
 
 - Simplify one of the switch protocols to avoid dependence on GraphMatching.jl which does not install well on non-linux systems. Do not rely on the default `SimpleSwitchDiscreteProt` for the time being.
-- Interactive examples for network controller
-- Implement a network control protocol, a request generator and a request tracker along with new tags `EntanglementRequest`,`SwapRequest` and `DistributionRequest`
+- Implement a network control protocol that is connection-oriented, centralized and non-distributed
+- Implement protocols: request generator and request tracker for simulation with the above control protocol in an asynchronous way.
+- Add `PhysicalGraph` struct for storing network metadata as the simulation evolves.
+- New tags: `EntanglementRequest`,`SwapRequest`, `DistributionRequest` and `RequestCompletion`
 
 ## v0.5.0 - 2024-09-05
 

diff --git a/src/ProtocolZoo/ProtocolZoo.jl b/src/ProtocolZoo/ProtocolZoo.jl
@@ -525,7 +525,8 @@ end
 """
 $TYPEDEF
 
-A protocol running at a node, listening for incoming entanglement generation and swap requests
+A protocol running at a node, listening for incoming entanglement generation and swap requests and serving
+them in an asynchronous way, without waiting for the completion of the instantiated entanglement generation or swapping processes to complete
 
 $TYPEDFIELDS
 """
@@ -581,7 +582,7 @@ include("utils.jl")
 """
 $TYPEDEF
 
-Protocol for the simulation of request traffic for a controller in a connection-oriented network for bipartite entanglement distribution. The requests are considered to be arriving according to the Poisson model with rate λ, hence the inter-arrival time is
+Protocol for the simulation of request traffic for a controller in a connection-oriented network for bipartite entanglement distribution. The requests are considered to be generated according to the Poisson model with rate λ, hence the inter-arrival time is
 sampled from an exponential distribution. Physically, the request is generated at the source node(Alice) and is classically communicated to the node where the controller is located. Multiple `RequestGenerator`s can be instantiated for simulation with multiple
 user pairs in the same network.
 

diff --git a/src/ProtocolZoo/controllers.jl b/src/ProtocolZoo/controllers.jl
@@ -58,7 +58,7 @@ end
 $TYPEDEF
 
 A network control protocol that is connection oriented, non-distributed and centralized. The controller is located at one of the nodes in the network from where it messages all
-the other nodes when it receives an entanglement distribution request from the [`RequestGenerator`](@ref).
+the other nodes' [`RequestTracker`](@ref) protocols when it receives [`DistributionRequest`](@ref) from the [`RequestGenerator`](@ref).
 
 $TYPEDFIELDS
 

diff --git a/src/ProtocolZoo/utils.jl b/src/ProtocolZoo/utils.jl
@@ -2,7 +2,8 @@
 $TYPEDEF
 
 A struct containing the physical graph metadata for a network. The latest workload data is only available
-at the node where the [`RequestGenerator`](@ref) runs, but every node has access to a copy for referencing paths based on indices.
+at the node where the [`RequestGenerator`](@ref) runs, but every node has access to a copy for referencing paths based on indices
+passed through the `DistributionRequest` tag/message.
 
 $TYPEDFIELDS
 """