scottk/oopt-gnpy
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/oopt-gnpy.git synced 2025-10-30 17:47:50 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

fix link to example-data files in the documentation

Browse Source 
and of the class referenced in the documentation
example-data folder is not accessible from the
generated pages on readthedocs. So use hyperlinks
to the files  github repo.

Signed-off-by: EstherLerouzic <esther.lerouzic@orange.com>
Change-Id: I135e2cb0b0d28fecffcbcbfec9a9d6c8cb5c7347
This commit is contained in:
EstherLerouzic
2025-02-11 17:45:29 +01:00
parent 49aee5a4e8
commit 93186b26fb
3 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/json_instance_examples.rst
View File

@@ -364,13 +364,13 @@ backward compatibility.
The RamanFiber is a specialized variant of the regular Fiber, where the simulation
engine incorporates Raman amplification. The actual pump definitions must be
specified within the RamanFiber instance in the topology
(refer to the gnpy.core.elements.RamanFiber class).
(refer to the :mod:`gnpy.core.elements.RamanFiber` class).
More details can be found in :cite:curri_merit_2016.
Raman efficiency is scaled against the effective area using the default Raman
coefficient profile (g0 * A_ff_overlap), where g0 is a Raman coefficient profile
defined for a reference effective area (gnpy.core.parameters.DEFAULT_RAMAN_COEFFICIENT).
defined for a reference effective area (:mod:`gnpy.core.parameters.DEFAULT_RAMAN_COEFFICIENT`).
If a RamanFiber is defined in the library, a corresponding Fiber must also be defined
with the same type_variety.