1 module gnpy-eqpt-config {
3 namespace "gnpy:gnpy-eqpt-config";
8 "Telecom Infra Project OOPT PSE
12 "WG Web: <https://github.com/Telecominfraproject/oopt-gnpy>
13 contact: <mailto:ahmed.triki@orange.com>
14 contact: <mailto:esther.lerouzic@orange.com>
18 "Base YANG model for gnpy equipment library input -
19 The license used for all the yang files of GNPy is BSD 3-Clause License
23 Copyright (c) 2018, Telecom Infra Project
26 Redistribution and use in source and binary forms, with or without
27 modification, are permitted provided that the following conditions are met:
29 * Redistributions of source code must retain the above copyright notice, this
30 list of conditions and the following disclaimer.
32 * Redistributions in binary form must reproduce the above copyright notice,
33 this list of conditions and the following disclaimer in the documentation
34 and/or other materials provided with the distribution.
36 * Neither the name of the copyright holder nor the names of its
37 contributors may be used to endorse or promote products derived from
38 this software without specific prior written permission.
40 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
41 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
44 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
46 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
47 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
48 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
49 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.";
53 "draft for GNPy4TPCE preversion - non official version relevant for v2.4 GNPy file format";
55 "YANG model for api input for path computation with gnpy";
59 description "draft for experimental/2020-candi";
60 reference "Base YANG model for equipment library input for path computation with gnpy";
65 "first draft for GNPy4TPCE preversion - non official version relevant for v1.2 GNPy file format";
67 "YANG model for api input for path computation with gnpy";
70 identity edfa-type-def {
71 description "base identity for variable gain and fixed gain";
74 identity variable-gain{
76 description "'variable_gain' is a simplified model simulating a 2-coil
77 EDFA with internal, input and output VOAs. The NF vs gain response is calculated
78 accordingly based on the input parameters: nf_min, nf_max, and gain_flatmax. It
79 is not a simple interpolation but a 2-stage NF calculation.";
84 description "'fixed_gain' is a fixed gain model. NF == Cte == nf0 if gain_min < gain < gain_flatmax";
87 identity fiber-variety {
88 description "base identity for fiber variety";
91 identity transceiver-variety {
92 description "base identity for transceiver variety";
96 grouping variable-gain {
111 description "auto_design feature to optimize the amplifier output VOA. If true, output VOA is present
112 and will be used to push amplifier gain to its maximum, within EOL power margins.";
125 grouping no-type-def{
126 leaf advanced_config_from_json {
128 description " filename with json edfa";
139 //default [8.1e-4,6.142e-2,1.558,19.97] ;
143 grouping dual-stage {
147 leaf preamp_variety {
149 path "../../Edfa/type_variety";
152 leaf booster_variety {
154 path "../../Edfa/type_variety";
159 grouping edfa-common {
160 leaf allowed_for_design{
162 description "If false, the amplifier will not be picked by auto-design but it can still be used as a
163 manual input (from JSON or Excel template topology files.)";
188 choice type_of_model {
190 when "type_def = 'variable-gain'";
194 when "type_def = 'fixed-gain'";
198 when "type_def = 'no-type-def'";
202 when "type_def = 'openroadm'";
206 when "type_def = 'dual_stage'";
212 grouping common-fiber {
213 description "common parameters for fiber and raman fiber";
228 description "2pi.n2/(lambda*Aeff) (w-2.m-1)";
243 description "a unique name to ID the amplifier in the JSON/Excel template topology input file";
255 container raman_efficiency {
261 leaf-list frequency_offset {
273 leaf-list delta_power_range_db {
291 leaf max_fiber_lineic_loss_for_raman {
297 leaf target_extended_gain {
334 leaf target_pch_out_db {
349 container restrictions {
350 leaf-list preamp_variety_list {
353 leaf-list booster_variety_list {
385 leaf-list power_range_db {
410 description "a unique name to ID the transceiver in the JSON or Excel template topology input file";
412 container frequency {
425 description "Min/max frequency of transponder eg 191.35e12 and 196.1e12";
430 description "unique name of the mode";
437 description "baud_rate";
444 description "min required OSNR in 0.1nm (dB)";
451 description "min required OSNR in 0.1nm (dB)";
465 description "bit rate";
477 description "arbitrary unit";