fix missing description of computed_number_of_channels

Signed-off-by: EstherLerouzic <[email protected]> Change-Id: I5c8d057dcdab535617eee8de3eccdd806cec403e
Orange-OpenSource · Jun 1, 2024 · 44040c4 · 44040c4
1 parent ee9af69
commit 44040c4
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/json.rst b/docs/json.rst
@@ -337,6 +337,12 @@ See ``delta_power_range_db`` for more explaination.
 |                                             |           | from `arXiv:1710.02225                      |
 |                                             |           | <https://arxiv.org/abs/1710.02225>`_).      |
 +---------------------------------------------+-----------+---------------------------------------------+
+| ``dispersion_tolerance``                    | (number)  | Optional. Pure number. Tuning parameter for |
+|                                             |           | ggn model solution. Default value is 1.     |
++---------------------------------------------+-----------+---------------------------------------------+
+| ``phase_shift_tolerance``                   | (number)  | Optional. Pure number. Tuning parameter for |
+|                                             |           | ggn model solution. Defaut value is 0.1.    |
++---------------------------------------------+-----------+---------------------------------------------+
 | ``nli_params.computed_channels``            | (list     | Optional. The exact channel indices         |
 |                                             | of        | (starting from 1) on which the NLI is       |
 |                                             | numbers)  | explicitly evaluated.                       |

diff --git a/gnpy/core/parameters.py b/gnpy/core/parameters.py
@@ -61,6 +61,8 @@ def __init__(self, method='gn_model_analytic', dispersion_tolerance=1, phase_shi
         :params dispersion_tolerance: tuning parameter for ggn model solution
         :params phase_shift_tolerance: tuning parameter for ggn model solution
         :params computed_channels: the NLI is evaluated for these channels and extrapolated for the others
+        :params computed_number_of_channels: the NLI is evaluated for this number of channels equally distributed
+        in the spectrum and extrapolated for the others
         """
         self.method = method.lower()
         self.dispersion_tolerance = dispersion_tolerance