refactor build_network: create a separate function to add elements

separate function that adds element, from function that configure them

Signed-off-by: EstherLerouzic <esther.lerouzic@orange.com>
Change-Id: Ica332223bdf7fc599cb007d7513d7cd62d9c5f9c

gnpy/core/network.py

@@ -245,13 +245,11 @@ def set_egress_amplifier(network, this_node, equipment, pref_ch_db, pref_total_d
         visited_nodes = []
         while not (isinstance(node, elements.Roadm) or isinstance(node, elements.Transceiver)):
             # go through all nodes in the OMS (loop until next Roadm instance)
-            try:
-                next_node = next(network.successors(node))
-            except StopIteration:
-                raise NetworkTopologyError(f'{type(node).__name__} {node.uid} is not properly connected, please check network topology')
+            next_node = get_next_node(node, network)
             visited_nodes.append(node)
             if next_node in visited_nodes:
-                raise NetworkTopologyError(f'Loop detected for {type(node).__name__} {node.uid}, please check network topology')
+                raise NetworkTopologyError(f'Loop detected for {type(node).__name__} {node.uid}, '
+                                           + 'please check network topology')
             if isinstance(node, elements.Edfa):
                 node_loss = span_loss(network, prev_node)
                 voa = node.out_voa if node.out_voa else 0
@@ -499,7 +497,7 @@ def add_roadm_preamp(network, roadm):
 
 
 def add_inline_amplifier(network, fiber):
-    next_node = next(network.successors(fiber))
+    next_node = get_next_node(fiber, network)
     if isinstance(next_node, elements.Fiber) or isinstance(next_node, elements.RamanFiber):
         # no amplification for fused spans or TRX
         network.remove_edge(fiber, next_node)
@@ -543,6 +541,17 @@ def calculate_new_length(fiber_length, bounds, target_length):
         return (length1, n_spans1)
 
 
+def get_next_node(node, network):
+    """get_next node else raise tha appropriate error
+    """
+    try:
+        next_node = next(network.successors(node))
+        return next_node
+    except StopIteration:
+        raise NetworkTopologyError(
+            f'{type(node).__name__} {node.uid} is not properly connected, please check network topology')
+
+
 def split_fiber(network, fiber, bounds, target_length, equipment):
     new_length, n_spans = calculate_new_length(fiber.params.length, bounds, target_length)
     if n_spans == 1:
@@ -587,10 +596,7 @@ def split_fiber(network, fiber, bounds, target_length, equipment):
 
 def add_connector_loss(network, fibers, default_con_in, default_con_out, EOL):
     for fiber in fibers:
-        try:
-            next_node = next(network.successors(fiber))
-        except StopIteration:
-            raise NetworkTopologyError(f'Fiber {fiber.uid} is not properly connected, please check network topology')
+        next_node = get_next_node(fiber, network)
         if fiber.params.con_in is None:
             fiber.params.con_in = default_con_in
         if fiber.params.con_out is None:
@@ -605,10 +611,7 @@ def add_fiber_padding(network, fibers, padding):
                          for fiber in network.predecessors(n)
                          if isinstance(fiber, elements.Fiber))"""
     for fiber in fibers:
-        try:
-            next_node = next(network.successors(fiber))
-        except StopIteration:
-            raise NetworkTopologyError(f'Fiber {fiber.uid} is not properly connected, please check network topology')
+        next_node = get_next_node(fiber, network)
         if isinstance(next_node, elements.Fused):
             continue
         this_span_loss = span_loss(network, fiber)
@@ -622,46 +625,54 @@ def add_fiber_padding(network, fibers, padding):
                 first_fiber.params.att_in = first_fiber.params.att_in + padding - this_span_loss
 
 
-def build_network(network, equipment, pref_ch_db, pref_total_db, no_insert_edfas=False):
+def add_missing_elements_in_network(network, equipment):
+    """Autodesign network: add missing elements. split fibers if their length is too big
+    add ROADM preamp or booster and inline amplifiers between fibers
+    """
     default_span_data = equipment['Span']['default']
     max_length = int(convert_length(default_span_data.max_length, default_span_data.length_units))
     min_length = max(int(default_span_data.padding / 0.2 * 1e3), 50_000)
     bounds = range(min_length, max_length)
     target_length = max(min_length, min(max_length, 90_000))
+    fibers = [f for f in network.nodes() if isinstance(f, elements.Fiber)]
+    for fiber in fibers:
+        split_fiber(network, fiber, bounds, target_length, equipment)
+    roadms = [r for r in network.nodes() if isinstance(r, elements.Roadm)]
+    for roadm in roadms:
+        add_roadm_preamp(network, roadm)
+        add_roadm_booster(network, roadm)
+    fibers = [f for f in network.nodes() if isinstance(f, elements.Fiber)]
+    for fiber in fibers:
+        add_inline_amplifier(network, fiber)
 
-    # set roadm loss for gain_mode before to build network
+
+def add_missing_fiber_attributes(network, equipment):
+    """Fill in connector loss with default values. Add the padding loss is required.
+    EOL is added as a connector loss
+    """
+    default_span_data = equipment['Span']['default']
     fibers = [f for f in network.nodes() if isinstance(f, elements.Fiber)]
     add_connector_loss(network, fibers, default_span_data.con_in, default_span_data.con_out, default_span_data.EOL)
     # don't group split fiber and add amp in the same loop
     # =>for code clarity (at the expense of speed):
-
-    roadms = [r for r in network.nodes() if isinstance(r, elements.Roadm)]
-    transceivers = [t for t in network.nodes() if isinstance(t, elements.Transceiver)]
-    if not no_insert_edfas:
-        for fiber in fibers:
-            split_fiber(network, fiber, bounds, target_length, equipment)
-
-        for roadm in roadms:
-            add_roadm_preamp(network, roadm)
-            add_roadm_booster(network, roadm)
-
-        fibers = [f for f in network.nodes() if isinstance(f, elements.Fiber)]
-        for fiber in fibers:
-            add_inline_amplifier(network, fiber)
-
     add_fiber_padding(network, fibers, default_span_data.padding)
 
+
+def build_network(network, equipment, pref_ch_db, pref_total_db, set_connector_losses=True):
+    """Set roadm equalization target and amplifier gain and power
+    """
+    roadms = [r for r in network.nodes() if isinstance(r, elements.Roadm)]
+    transceivers = [t for t in network.nodes() if isinstance(t, elements.Transceiver)]
+
+    if set_connector_losses:
+        add_missing_fiber_attributes(network, equipment)
+    # set roadm equalization targets first
     for roadm in roadms:
         set_roadm_per_degree_targets(roadm, network)
+    # then set amplifiers gain, delta_p and out_voa on each OMS
     for roadm in roadms + transceivers:
         set_egress_amplifier(network, roadm, equipment, pref_ch_db, pref_total_db)
     for roadm in roadms:
         set_roadm_input_powers(network, roadm, equipment, pref_ch_db)
     for fiber in [f for f in network.nodes() if isinstance(f, (elements.Fiber, elements.RamanFiber))]:
         set_fiber_input_power(network, fiber, equipment, pref_ch_db)
-
-    # trx = [t for t in network.nodes() if isinstance(t, elements.Transceiver)]
-    # for t in trx:
-    #     next_node = next(network.successors(t), None)
-    #     if next_node and not isinstance(next_node, elements.Roadm):
-    #         set_egress_amplifier(network, t, equipment, 0, pref_total_db)

gnpy/tools/cli_examples.py

@@ -19,7 +19,7 @@ import gnpy.core.ansi_escapes as ansi_escapes
 from gnpy.core.elements import Transceiver, Fiber, RamanFiber
 from gnpy.core.equipment import trx_mode_params
 import gnpy.core.exceptions as exceptions
-from gnpy.core.network import build_network
+from gnpy.core.network import build_network, add_missing_elements_in_network
 from gnpy.core.parameters import SimParams
 from gnpy.core.utils import db2lin, lin2db, automatic_nch
 from gnpy.topology.request import (ResultElement, jsontocsv, compute_path_dsjctn, requests_aggregation,
@@ -208,19 +208,29 @@ def transmission_main_example(args=None):
     print(f'There are {nb_channels} channels propagating')
     power_mode = equipment['Span']['default'].power_mode
     print('\n'.join([f'Power mode is set to {power_mode}',
-                     f'=> it can be modified in eqpt_config.json - Span']))
+                     '=> it can be modified in eqpt_config.json - Span']))
+    if not args.no_insert_edfas:
+        try:
+            add_missing_elements_in_network(network, equipment)
+        except exceptions.NetworkTopologyError as e:
+            print(f'{ansi_escapes.red}Invalid network definition:{ansi_escapes.reset} {e}')
+            sys.exit(1)
+        except exceptions.ConfigurationError as e:
+            print(f'{ansi_escapes.red}Configuration error:{ansi_escapes.reset} {e}')
+            sys.exit(1)
 
     # Keep the reference channel for design: the one from SI, with full load same channels
     pref_ch_db = lin2db(req.power * 1e3)  # reference channel power / span (SL=20dB)
     pref_total_db = pref_ch_db + lin2db(req.nb_channel)  # reference total power / span (SL=20dB)
     try:
-        build_network(network, equipment, pref_ch_db, pref_total_db, args.no_insert_edfas)
+        build_network(network, equipment, pref_ch_db, pref_total_db)
     except exceptions.NetworkTopologyError as e:
         print(f'{ansi_escapes.red}Invalid network definition:{ansi_escapes.reset} {e}')
         sys.exit(1)
     except exceptions.ConfigurationError as e:
         print(f'{ansi_escapes.red}Configuration error:{ansi_escapes.reset} {e}')
         sys.exit(1)
+
     path = compute_constrained_path(network, req)
 
     spans = [s.params.length for s in path if isinstance(s, RamanFiber) or isinstance(s, Fiber)]
@@ -330,17 +340,28 @@ def path_requests_run(args=None):
     # Build the network once using the default power defined in SI in eqpt config
     # TODO power density: db2linp(ower_dbm": 0)/power_dbm": 0 * nb channels as defined by
     # spacing, f_min and f_max
+    if not args.no_insert_edfas:
+        try:
+            add_missing_elements_in_network(network, equipment)
+        except exceptions.NetworkTopologyError as e:
+            print(f'{ansi_escapes.red}Invalid network definition:{ansi_escapes.reset} {e}')
+            sys.exit(1)
+        except exceptions.ConfigurationError as e:
+            print(f'{ansi_escapes.red}Configuration error:{ansi_escapes.reset} {e}')
+            sys.exit(1)
+
     p_db = equipment['SI']['default'].power_dbm
     p_total_db = p_db + lin2db(automatic_nch(equipment['SI']['default'].f_min,
                                              equipment['SI']['default'].f_max, equipment['SI']['default'].spacing))
     try:
-        build_network(network, equipment, p_db, p_total_db, args.no_insert_edfas)
+        build_network(network, equipment, p_db, p_total_db)
     except exceptions.NetworkTopologyError as e:
         print(f'{ansi_escapes.red}Invalid network definition:{ansi_escapes.reset} {e}')
         sys.exit(1)
     except exceptions.ConfigurationError as e:
         print(f'{ansi_escapes.red}Configuration error:{ansi_escapes.reset} {e}')
         sys.exit(1)
+
     if args.save_network is not None:
         save_network(network, args.save_network)
         print(f'{ansi_escapes.blue}Network (after autodesign) saved to {args.save_network}{ansi_escapes.reset}')

tests/test_parser.py

@@ -24,7 +24,7 @@ from xlrd import open_workbook
 import pytest
 from copy import deepcopy
 from gnpy.core.utils import automatic_nch, lin2db
-from gnpy.core.network import build_network
+from gnpy.core.network import build_network, add_missing_elements_in_network
 from gnpy.core.exceptions import ServiceError
 from gnpy.topology.request import (jsontocsv, requests_aggregation, compute_path_dsjctn, deduplicate_disjunctions,
                                    compute_path_with_disjunction, ResultElement, PathRequest)
@@ -71,6 +71,7 @@ def test_auto_design_generation_fromxlsgainmode(tmpdir, xls_input, expected_json
     """tests generation of topology json and that the build network gives correct results in gain mode"""
     equipment = load_equipment(eqpt_filename)
     network = load_network(xls_input, equipment)
+    add_missing_elements_in_network(network, equipment)
     # in order to test the Eqpt sheet and load gain target,
     # change the power-mode to False (to be in gain mode)
     equipment['Span']['default'].power_mode = False