Skip to content

Commit 956a99e

Browse files
committed
Major Documentation Overhaul.
1 parent b0a16a2 commit 956a99e

83 files changed

Lines changed: 1724 additions & 357 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

arg_scripts/routing_args.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ def __init__(self):
1818
self.span_len = 100.0 # Length of a span in km
1919
self.max_span = None # Maximum number of spans in the network
2020
self.connection_index = None # Keeping track of source destination index in precalculated routing
21-
self.path_index = None # Keeping track of index of selected path for spectrum assignment
21+
self.path_index = None # Keeps track of selected path indexes during spectrum assignment
2222

2323
def __repr__(self):
2424
return f"RoutingProps({self.__dict__})"

arg_scripts/snr_args.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# pylint: disable=too-few-public-methods
2-
32
class SNRProps:
43
"""
54
Main properties used for the snr_measurements.py script.

arg_scripts/stats_args.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def __init__(self):
2525
self.end_slot_list = list() # # Tracks the end slot allocated in a simulation
2626
self.modulation_list = list() # Tracks the modulation
2727
self.bandwidth_list = list() # # Tracks the bandwidth
28-
self.path_index_list = list()
28+
self.path_index_list = list() #Tracks the number of times a path was selected
2929

3030

3131
def __repr__(self):

data/json_input/example_mods/default_mod_format.json

Lines changed: 0 additions & 74 deletions
This file was deleted.
Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
{
2+
"DEFAULT": {
3+
"25": {
4+
"QPSK": {
5+
"max_length": 22160,
6+
"slots_needed": 1
7+
},
8+
"16-QAM": {
9+
"max_length": 9500,
10+
"slots_needed": 1
11+
},
12+
"64-QAM": {
13+
"max_length": 3664,
14+
"slots_needed": 1
15+
}
16+
},
17+
"50": {
18+
"QPSK": {
19+
"max_length": 11080,
20+
"slots_needed": 2
21+
},
22+
"16-QAM": {
23+
"max_length": 4750,
24+
"slots_needed": 1
25+
},
26+
"64-QAM": {
27+
"max_length": 1832,
28+
"slots_needed": 1
29+
}
30+
},
31+
"100": {
32+
"QPSK": {
33+
"max_length": 5540,
34+
"slots_needed": 4
35+
},
36+
"16-QAM": {
37+
"max_length": 2375,
38+
"slots_needed": 2
39+
},
40+
"64-QAM": {
41+
"max_length": 916,
42+
"slots_needed": 2
43+
}
44+
},
45+
"200": {
46+
"QPSK": {
47+
"max_length": 2770,
48+
"slots_needed": 8
49+
},
50+
"16-QAM": {
51+
"max_length": 1187,
52+
"slots_needed": 4
53+
},
54+
"64-QAM": {
55+
"max_length": 458,
56+
"slots_needed": 3
57+
}
58+
},
59+
"400": {
60+
"QPSK": {
61+
"max_length": 1385,
62+
"slots_needed": 16
63+
},
64+
"16-QAM": {
65+
"max_length": 594,
66+
"slots_needed": 8
67+
},
68+
"64-QAM": {
69+
"max_length": 229,
70+
"slots_needed": 6
71+
}
72+
}
73+
},
74+
"SNR_ASSUMPTIONS" : {
75+
"100": {
76+
"BPSK": {"max_length": 40660, "slots_needed": 1},
77+
"QPSK": {"max_length": 40670, "slots_needed": 1},
78+
"8-QAM": {"max_length": 40800, "slots_needed": 1},
79+
"16-QAM": {"max_length": 41000, "slots_needed": 1},
80+
"32-QAM": {"max_length": 41210, "slots_needed": 1},
81+
"64-QAM": {"max_length": 41460, "slots_needed": 1}
82+
},
83+
"200": {
84+
"BPSK": {"max_length": 40660, "slots_needed": 1},
85+
"QPSK": {"max_length": 40670, "slots_needed": 1},
86+
"8-QAM": {"max_length": 40800, "slots_needed": 1},
87+
"16-QAM": {"max_length": 41000, "slots_needed": 1},
88+
"32-QAM": {"max_length": 41210, "slots_needed": 1},
89+
"64-QAM": {"max_length": 41460, "slots_needed": 1}
90+
},
91+
"300": {
92+
"BPSK": {"max_length": 40660, "slots_needed": 1},
93+
"QPSK": {"max_length": 40670, "slots_needed": 1},
94+
"8-QAM": {"max_length": 40800, "slots_needed": 1},
95+
"16-QAM": {"max_length": 41000, "slots_needed": 1},
96+
"32-QAM": {"max_length": 41210, "slots_needed": 1},
97+
"64-QAM": {"max_length": 41460, "slots_needed": 1}
98+
},
99+
"400": {
100+
"BPSK": {"max_length": 40660, "slots_needed": 1},
101+
"QPSK": {"max_length": 40670, "slots_needed": 1},
102+
"8-QAM": {"max_length": 40800, "slots_needed": 1},
103+
"16-QAM": {"max_length": 41000, "slots_needed": 1},
104+
"32-QAM": {"max_length": 41210, "slots_needed": 1},
105+
"64-QAM": {"max_length": 41460, "slots_needed": 1}
106+
},
107+
"500": {
108+
"BPSK": {"max_length": 40660, "slots_needed": 1},
109+
"QPSK": {"max_length": 40670, "slots_needed": 1},
110+
"8-QAM": {"max_length": 40800, "slots_needed": 1},
111+
"16-QAM": {"max_length": 41000, "slots_needed": 1},
112+
"32-QAM": {"max_length": 41210, "slots_needed": 1},
113+
"64-QAM": {"max_length": 41460, "slots_needed": 1}
114+
},
115+
"600": {
116+
"BPSK": {"max_length": 40660, "slots_needed": 1},
117+
"QPSK": {"max_length": 40670, "slots_needed": 1},
118+
"8-QAM": {"max_length": 40800, "slots_needed": 1},
119+
"16-QAM": {"max_length": 41000, "slots_needed": 1},
120+
"32-QAM": {"max_length": 41210, "slots_needed": 1},
121+
"64-QAM": {"max_length": 41460, "slots_needed": 1}
122+
}
123+
},
124+
"XTAR_ASSUMPTIONS" : {
125+
126+
"50": {"QPSK": {"max_length": 10380, "slots_needed": 2}, "16-QAM": {"max_length": 4648, "slots_needed": 1},
127+
"64-QAM": {"max_length": 1752, "slots_needed": 1}},
128+
129+
"100": {"QPSK": {"max_length": 5190, "slots_needed": 3}, "16-QAM": {"max_length": 2324, "slots_needed": 2},
130+
"64-QAM": {"max_length": 876, "slots_needed": 1}},
131+
132+
"200": {"QPSK": {"max_length": 2595, "slots_needed": 5}, "16-QAM": {"max_length": 1162, "slots_needed": 3},
133+
"64-QAM": {"max_length": 438, "slots_needed": 2}},
134+
135+
"400": {"QPSK": {"max_length": 1298, "slots_needed": 10}, "16-QAM": {"max_length": 581, "slots_needed": 5},
136+
"64-QAM": {"max_length": 219, "slots_needed": 4}}
137+
}
138+
}

docs/args/args_modules.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ Argument Scripts
44
.. toctree::
55

66
config_args
7-
data_args
87
plot_args
98
rl_args
109
routing_args

0 commit comments

Comments
 (0)