From 44040c4d0600691552e715a48e5b8ebb7e985d20 Mon Sep 17 00:00:00 2001 From: EstherLerouzic Date: Sat, 1 Jun 2024 09:11:56 +0200 Subject: [PATCH] fix missing description of computed_number_of_channels Signed-off-by: EstherLerouzic Change-Id: I5c8d057dcdab535617eee8de3eccdd806cec403e --- docs/json.rst | 6 ++++++ gnpy/core/parameters.py | 2 ++ 2 files changed, 8 insertions(+) diff --git a/docs/json.rst b/docs/json.rst index 6e536e6b7..b059a5a56 100644 --- a/docs/json.rst +++ b/docs/json.rst @@ -337,6 +337,12 @@ See ``delta_power_range_db`` for more explaination. | | | from `arXiv: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 index 1689c644c..851ee6e3e 100644 --- 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