scottk/oopt-gnpy
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/oopt-gnpy.git synced 2025-11-02 02:57:52 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

docs: add some latex fanciness

Browse Source 
Change-Id: I39348e0994fe576ce33d8b241ab9cedd0fd184c8
This commit is contained in:
Jan Kundrát
2021-05-31 18:00:58 +02:00
parent b6daa15356
commit 8fcead4294
1 changed files with 19 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/json.rst
View File

@@ -59,22 +59,25 @@ Fiber
The fiber library currently describes SSMF and NZDF but additional fiber types can be entered by the user following the same model: The fiber library currently describes SSMF and NZDF but additional fiber types can be entered by the user following the same model:
+----------------------+-----------+-----------------------------------------+ +----------------------+-----------+------------------------------------------+
| field | type | description | | field | type | description |
+======================+===========+=========================================+ +======================+===========+==========================================+
| ``type_variety`` | (string) | a unique name to ID the fiber in the | | ``type_variety`` | (string) | a unique name to ID the fiber in the |
| | | JSON or Excel template topology input | | | | JSON or Excel template topology input |
| | | file | | | | file |
+----------------------+-----------+-----------------------------------------+ +----------------------+-----------+------------------------------------------+
| ``dispersion`` | (number) | (s.m-1.m-1) | | ``dispersion`` | (number) | In :math:`s \times m^{-1} \times m^{-1}`.|
+----------------------+-----------+-----------------------------------------+ +----------------------+-----------+------------------------------------------+
| ``dispersion_slope`` | (number) | (s.m-1.m-1.m-1) | | ``dispersion_slope`` | (number) | In :math:`s \times m^{-1} \times m^{-1} |
+----------------------+-----------+-----------------------------------------+ | | | \times m^{-1}` |
| ``gamma`` | (number) | 2pi.n2/(lambda*Aeff) (w-1.m-1) | +----------------------+-----------+------------------------------------------+
+----------------------+-----------+-----------------------------------------+ | ``gamma`` | (number) | :math:`2\pi\times n^2/(\lambda*A_{eff})`,|
| | | in :math:`w^{-1} \times m^{-1}`. |
+----------------------+-----------+------------------------------------------+
| ``pmd_coef`` | (number) | Polarization mode dispersion (PMD) | | ``pmd_coef`` | (number) | Polarization mode dispersion (PMD) |
| | | coefficient. (s.sqrt(m)-1) | | | | coefficient. In |
+----------------------+-----------+-----------------------------------------+ | | | :math:`s\times\sqrt{m}^{-1}`. |
+----------------------+-----------+------------------------------------------+
Transceiver Transceiver
~~~~~~~~~~~ ~~~~~~~~~~~