Excel (XLS, XLSX) input files

gnpy-transmission-example gives the possibility to use an excel input file instead of a json file. The program then will generate the corresponding json file for you.

The file named ‘meshTopologyExampleV2.xls’ is an example.

In order to work the excel file MUST contain at least 2 sheets:

  • Nodes

  • Links

(In progress) The File MAY contain an additional sheet:

  • Eqt

  • Service

Nodes sheet

Nodes sheet contains nine columns. Each line represents a ‘node’ (ROADM site or an in line amplifier site ILA or a Fused):

City (Mandatory) ; State ; Country ; Region ; Latitude ; Longitude ; Type

  • City is used for the name of a node of the graph. It accepts letters, numbers,underscore,dash, blank… (not exhaustive). The user may want to avoid commas for future CSV exports.

    City name MUST be unique

  • Type is not mandatory.

    • If not filled, it will be interpreted as an ‘ILA’ site if node degree is 2 and as a ROADM otherwise.

    • If filled, it can take “ROADM”, “FUSED” or “ILA” values. If another string is used, it will be considered as not filled. FUSED means that ingress and egress spans will be fused together.

  • State, Country, Region are not mandatory. “Region” is a holdover from the CORONET topology reference file CORONET_Global_Topology.xlsx. CORONET separates its network into geographical regions (Europe, Asia, Continental US.) This information is not used by gnpy.

  • Longitude, Latitude are not mandatory. If filled they should contain numbers.

  • Booster_restriction and Preamp_restriction are not mandatory. If used, they must contain one or several amplifier type_variety names separated by ‘ | ‘. This information is used to restrict types of amplifiers used in a ROADM node during autodesign. If a ROADM booster or preamp is already specified in the Eqpt sheet , the field is ignored. The field is also ignored if the node is not a ROADM node.

There MUST NOT be empty line(s) between two nodes lines

Eqpt sheet

The equipment sheet (named “Eqpt”) is optional. If provided, it specifies types of boosters and preamplifiers for all ROADM degrees of all ROADM nodes, and for all ILA nodes.

This sheet contains twelve columns:

                 <--           east cable from a to z                  --> <--        west from z to a                          -->
Node A ; Node Z ; amp type ; att_in ; amp gain ; tilt ; att_out ; delta_p ; amp type ; att_in ; amp gain ; tilt ; att_out ; delta_p

If the sheet is present, it MUST have as many lines as there are egress directions of ROADMs defined in Links Sheet, and all ILAs.

For example, consider the following list of links (A, B and C being a ROADM and amp# ILAs):

A    - amp1
amp1 - amp2
Amp2 - B
A    - amp3
amp3 - C
then Eqpt sheet should contain:

  • one line for each ILAs: amp1, amp2, amp3

  • one line for each one-degree ROADM (B and C in this example)

  • two lines for each two-degree ROADM (just the ROADM A)

A    - amp1
amp1 - amp2
Amp2 - B
A    - amp3
amp3 - C
B    - amp2
C    - amp3

In case you already have filled Nodes and Links sheets create_eqpt_sheet.py can be used to automatically create a template for the mandatory entries of the list.

$ cd $(gnpy-example-data)
$ python create_eqpt_sheet.py meshTopologyExampleV2.xls

This generates a text file meshTopologyExampleV2_eqt_sheet.txt whose content can be directly copied into the Eqt sheet of the excel file. The user then can fill the values in the rest of the columns.

  • Node A is mandatory. It is the name of the node (as listed in Nodes sheet). If Node A is a ‘ROADM’ (Type attribute in sheet Node), its number of occurence must be equal to its degree. If Node A is an ‘ILA’ it should appear only once.

  • Node Z is mandatory. It is the egress direction from the Node A site. Multiple Links between the same Node A and NodeZ is not supported.

  • amp type is not mandatory. If filled it must contain types listed in eqpt_config.json in “Edfa” list “type_variety”. If not filled it takes “std_medium_gain” as default value. If filled with fused, a fused element with 0.0 dB loss will be placed instead of an amplifier. This might be used to avoid booster amplifier on a ROADM direction.

  • amp_gain is not mandatory. It is the value to be set on the amplifier (in dB). If not filled, it will be determined with design rules in the convert.py file. If filled, it must contain positive numbers.

  • att_in and att_out are not mandatory and are not used yet. They are the value of the attenuator at input and output of amplifier (in dB). If filled they must contain positive numbers.

  • tilt, in dB, is not mandatory. It is the target gain tilt over the full amplfifier bandwidth and is defined with regard to wavelength, i.e. negative tilt means lower gain for higher wavelengths (lower frequencies). If not filled, the default value is 0.

  • delta_p, in dBm, is not mandatory. If filled it is used to set the output target power per channel at the output of the amplifier, if power_mode is True. The output power is then set to power_dbm + delta_power.

# to be completed #

(in progress)

Service sheet

Service sheet is optional. It lists the services for which path and feasibility must be computed with gnpy-path-request.

Service sheet must contain 11 columns:

route id ; Source ; Destination ; TRX type ; Mode ; System: spacing ; System: input power (dBm) ; System: nb of channels ;  routing: disjoint from ; routing: path ; routing: is loose?

  • route id is mandatory. It must be unique. It is the identifier of the request. It can be an integer or a string (do not use blank or dash or coma)

  • Source is mandatory. It is the name of the source node (as listed in Nodes sheet). Source MUST be a ROADM node. (TODO: relax this and accept trx entries)

  • Destination is mandatory. It is the name of the destination node (as listed in Nodes sheet). Source MUST be a ROADM node. (TODO: relax this and accept trx entries)

  • TRX type is mandatory. They are the variety type and selected mode of the transceiver to be used for the propagation simulation. These modes MUST be defined in the equipment library. The format of the mode is used as the name of the mode. (TODO: maybe add another mode id on Transceiver library ?). In particular the mode selection defines the channel baudrate to be used for the propagation simulation.

  • mode is optional. If not specified, the program will search for the mode of the defined transponder with the highest baudrate fitting within the spacing value.

  • System: spacing is mandatory. Spacing is the channel spacing defined in GHz difined for the feasibility propagation simulation, assuming system full load.

  • System: input power (dBm) ; System: nb of channels are optional input defining the system parameters for the propagation simulation.

    • input power is the channel optical input power in dBm

    • nb of channels is the number of channels to be used for the simulation.

  • routing: disjoint from ; routing: path ; routing: is loose? are optional.

    • disjoint from: identifies the requests from which this request must be disjoint. If filled it must contain request ids separated by ‘ | ‘

    • path: is the set of ROADM nodes that must be used by the path. It must contain the list of ROADM names that the path must cross. TODO : only ROADM nodes are accepted in this release. Relax this with any type of nodes. If filled it must contain ROADM ids separated by ‘ | ‘. Exact names are required.

    • is loose? ‘no’ value means that the list of nodes should be strictly followed, while any other value means that the constraint may be relaxed if the node is not reachable.

  • path bandwidth is mandatory. It is the amount of capacity required between source and destination in Gbit/s. Value should be positive (non zero). It is used to compute the amount of required spectrum for the service.