CI: Build and upload a PyPI package upon tagging

Change-Id: Idcd84a9f8e03ffc4ea27b37add8e5e59d1da7509

.codecov.yml

@@ -1 +1,9 @@
 comment: off
+coverage:
+  status:
+    project:
+      default:
+        threshold: 5%
+    patch:
+      default:
+        only_pulls: true

.github/pull_request_template.md

@@ -1,7 +1,7 @@
 # Thanks for contributing to GNPy
 
 If it isn't much trouble, please send your contribution as patches to our Gerrit.
-Here's [how to submit patches](https://review.gerrithub.io/Documentation/intro-gerrit-walkthrough-github.html), and here's a [list of stuff we are currently working on](https://review.gerrithub.io/p/Telecominfraproject/oopt-gnpy/+/dashboard/main:main).
+Here's [how to submit patches](https://review.gerrithub.io/Documentation/intro-gerrit-walkthrough-github.html), and here's a [list of stuff we are currently working on](https://review.gerrithub.io/q/project:Telecominfraproject/oopt-gnpy+status:open).
 Just sign in via your existing GitHub account.
 
 However, if you feel more comfortable with filing GitHub PRs, we can work with that too.

.github/workflows/main.yml

@@ -0,0 +1,87 @@
+on:
+  push:
+  pull_request:
+    branches:
+      - master
+
+name: CI
+
+jobs:
+  build:
+    name: Tox test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: fedora-python/tox-github-action@v0.4
+        with:
+          tox_env: ${{ matrix.tox_env }}
+          dnf_install: ${{ matrix.dnf_install }}
+    strategy:
+      matrix:
+        tox_env:
+          - py38
+          - py39
+        include:
+          - tox_env: docs
+            dnf_install: graphviz
+
+  pypi:
+    needs: build
+    if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v') }}
+    name: PyPI packaging
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v2
+        name: Install Python
+        with:
+          python-version: '3.9'
+      - uses: casperdcl/deploy-pypi@bb869aafd89f657ceaafe9561d3b5584766c0f95
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          pip: wheel -w dist/ --no-deps .
+          upload: true
+
+  docker:
+    needs: build
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v'))
+    name: Docker image
+    runs-on: ubuntu-latest
+    steps:
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: jktjkt
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Extract tag name
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+        id: extract_pretty_git
+        run: echo ::set-output name=GIT_DESC::$(git describe --tags)
+      - name: Build and push a container
+        uses: docker/build-push-action@v2
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+        with:
+          context: .
+          push: true
+          tags: |
+            telecominfraproject/oopt-gnpy:dev-${{ steps.extract_pretty_git.outputs.GIT_DESC }}
+            telecominfraproject/oopt-gnpy:master
+      - name: Extract tag name
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+        id: extract_tag_name
+        run: echo ::set-output name=GIT_DESC::${GITHUB_REF/refs\/tags\//}
+      - name: Build and push a container
+        uses: docker/build-push-action@v2
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+        with:
+          context: .
+          push: true
+          tags: |
+            telecominfraproject/oopt-gnpy:${{ steps.extract_tag_name.outputs.GIT_DESC }}

.readthedocs.yml

@@ -1,4 +1,5 @@
 build:
     image: latest
 python:
-    version: 3.6
+    version: 3.8
+requirements_file: docs/requirements.txt

.travis.yml

@@ -14,6 +14,7 @@ script:
   - pip install --editable .
   - pip install pytest-cov rstcheck
   - pytest --cov-report=xml --cov=gnpy -v
+  - pip install -r docs/requirements.txt
   - rstcheck --ignore-roles cite *.rst
   - sphinx-build -W --keep-going docs/ x-throwaway-location
 after_success:

.zuul.yaml

@@ -11,7 +11,7 @@
             vars:
               coverage_job_name_previous: tox-py38-cover-previous
               coverage_job_name_current: tox-py38-cover
-        - tox-linters-diff:
+        - tox-linters-diff-n-report:
             voting: false
         - tox-py36-el8
         - tox-docs-f32

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.7-slim
+FROM python:3.9-slim
 COPY . /oopt-gnpy
 WORKDIR /oopt-gnpy
 RUN apt update; apt install -y git

README.md

@@ -0,0 +1,29 @@
+# GNPy: Optical Route Planning and DWDM Network Optimization
+
+[![Install via pip](https://img.shields.io/pypi/v/gnpy)](https://pypi.org/project/gnpy/)
+[![Python versions](https://img.shields.io/pypi/pyversions/gnpy)](https://pypi.org/project/gnpy/)
+[![Documentation status](https://readthedocs.org/projects/gnpy/badge/?version=master)](http://gnpy.readthedocs.io/en/master/?badge=master)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Telecominfraproject/oopt-gnpy/build)](https://github.com/Telecominfraproject/oopt-gnpy/actions/workflows/main.yml)
+[![Gerrit](https://img.shields.io/badge/patches-via%20Gerrit-blue)](https://review.gerrithub.io/q/project:Telecominfraproject/oopt-gnpy+is:open)
+[![Contributors](https://img.shields.io/github/contributors-anon/Telecominfraproject/oopt-gnpy)](https://github.com/Telecominfraproject/oopt-gnpy/graphs/contributors)
+[![Code Quality via LGTM.com](https://img.shields.io/lgtm/grade/python/github/Telecominfraproject/oopt-gnpy)](https://lgtm.com/projects/g/Telecominfraproject/oopt-gnpy/)
+[![Code Coverage via codecov](https://img.shields.io/codecov/c/github/Telecominfraproject/oopt-gnpy)](https://codecov.io/gh/Telecominfraproject/oopt-gnpy)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3458319.svg)](https://doi.org/10.5281/zenodo.3458319)
+
+GNPy is an open-source, community-developed library for building route planning and optimization tools in real-world mesh optical networks.
+We are a consortium of operators, vendors, and academic researchers sponsored via the [Telecom Infra Project](http://telecominfraproject.com)'s [OOPT/PSE](https://telecominfraproject.com/open-optical-packet-transport) working group.
+Together, we are building this tool for rapid development of production-grade route planning tools which is easily extensible to include custom network elements and performant to the scale of real-world mesh optical networks.
+
+![GNPy with an OLS system](docs/images/GNPy-banner.png)
+
+## Quick Start
+
+Install either via [Docker](docs/install.rst#install-docker), or as a [Python package](docs/install.rst#install-pip).
+Read our [documentation](https://gnpy.readthedocs.io/), learn from the demos, and [get in touch with us](https://github.com/Telecominfraproject/oopt-gnpy/discussions).
+
+This example demonstrates how GNPy can be used to check the expected SNR at the end of the line by varying the channel input power:
+
+[![Running a simple simulation example](https://telecominfraproject.github.io/oopt-gnpy/docs/images/transmission_main_example.svg)](https://asciinema.org/a/252295)
+
+GNPy can do much more, including acting as a Path Computation Engine, tracking bandwidth requests, or advising the SDN controller about a best possible path through a large DWDM network.
+Learn more about this [in the documentation](https://gnpy.readthedocs.io/).

README.rst

@@ -1,248 +0,0 @@
-.. image:: docs/images/GNPy-banner.png
-   :width: 100%
-   :align: left
-   :alt: GNPy with an OLS system
-
-====================================================================
-`gnpy`: mesh optical network route planning and optimization library
-====================================================================
-
-|pypi| |docs| |travis| |doi| |contributors| |codacy-quality| |codecov|
-
-**`gnpy` is an open-source, community-developed library for building route
-planning and optimization tools in real-world mesh optical networks.**
-
-`gnpy <http://github.com/telecominfraproject/oopt-gnpy>`__ is:
---------------------------------------------------------------
-
-- a sponsored project of the `OOPT/PSE <https://telecominfraproject.com/open-optical-packet-transport/>`_ working group of the `Telecom Infra Project <http://telecominfraproject.com>`_
-- fully community-driven, fully open source library
-- driven by a consortium of operators, vendors, and academic researchers
-- intended for rapid development of production-grade route planning tools
-- easily extensible to include custom network elements
-- performant to the scale of real-world mesh optical networks
-
-Documentation: https://gnpy.readthedocs.io
-
-Get In Touch
-~~~~~~~~~~~~
-
-There are `weekly calls <https://telecominfraproject.workplace.com/events/702894886867547/>`__ about our progress.
-Newcomers, users and telecom operators are especially welcome there.
-We encourage all interested people outside the TIP to `join the project <https://telecominfraproject.com/apply-for-membership/>`__.
-
-How to Install
---------------
-
-Install either via `Docker <docs/install.rst#install-docker>`__, or as a `Python package <docs/install.rst#install-pip>`__.
-
-Instructions for First Use
---------------------------
-
-``gnpy`` is a library for building route planning and optimization tools.
-
-It ships with a number of example programs. Release versions will ship with
-fully-functional programs.
-
-    **Note**: *If you are a network operator or involved in route planning and
-    optimization for your organization, please contact project maintainer Jan
-    Kundrát <jan.kundrat@telecominfraproject.com>. gnpy is looking for users with
-    specific, delineated use cases to drive requirements for future
-    development.*
-
-This example demonstrates how GNPy can be used to check the expected SNR at the end of the line by varying the channel input power:
-
-.. image:: https://telecominfraproject.github.io/oopt-gnpy/docs/images/transmission_main_example.svg
-   :width: 100%
-   :align: left
-   :alt: Running a simple simulation example
-   :target: https://asciinema.org/a/252295
-
-By default, this script operates on a single span network defined in
-`gnpy/example-data/edfa_example_network.json <gnpy/example-data/edfa_example_network.json>`_
-
-You can specify a different network at the command line as follows. For
-example, to use the CORONET Global network defined in
-`gnpy/example-data/CORONET_Global_Topology.json <gnpy/example-data/CORONET_Global_Topology.json>`_:
-
-.. code-block:: shell-session
-
-    $ gnpy-transmission-example $(gnpy-example-data)/CORONET_Global_Topology.json
-
-It is also possible to use an Excel file input (for example
-`gnpy/example-data/CORONET_Global_Topology.xls <gnpy/example-data/CORONET_Global_Topology.xls>`_).
-The Excel file will be processed into a JSON file with the same prefix.
-Further details about the Excel data structure are available `in the documentation <docs/excel.rst>`__.
-
-The main transmission example will calculate the average signal OSNR and SNR
-across network elements (transceiver, ROADMs, fibers, and amplifiers)
-between two transceivers selected by the user. Additional details are provided by doing ``gnpy-transmission-example -h``. (By default, for the CORONET Global
-network, it will show the transmission of spectral information between Abilene and Albany)
-
-This script calculates the average signal OSNR = |OSNR| and SNR = |SNR|.
-
-.. |OSNR| replace:: P\ :sub:`ch`\ /P\ :sub:`ase`
-.. |SNR| replace:: P\ :sub:`ch`\ /(P\ :sub:`nli`\ +\ P\ :sub:`ase`)
-
-|Pase| is the amplified spontaneous emission noise, and |Pnli| the non-linear
-interference noise.
-
-.. |Pase| replace:: P\ :sub:`ase`
-.. |Pnli| replace:: P\ :sub:`nli`
-
-Further Instructions for Use
-----------------------------
-
-Simulations are driven by a set of `JSON <docs/json.rst>`__ or `XLS <docs/excel.rst>`__ files.
-
-The ``gnpy-transmission-example`` script propagates a spectrum of channels at 32 Gbaud, 50 GHz spacing and 0 dBm/channel. 
-Launch power can be overridden by using the ``--power`` argument.
-Spectrum information is not yet parametrized but can be modified directly in the ``eqpt_config.json`` (via the ``SpectralInformation`` -SI- structure) to accommodate any baud rate or spacing.
-The number of channel is computed based on ``spacing`` and ``f_min``, ``f_max`` values.
-
-An experimental support for Raman amplification is available:
-
-.. code-block:: shell-session
-
-     $ gnpy-transmission-example \
-       $(gnpy-example-data)/raman_edfa_example_network.json \
-       --sim $(gnpy-example-data)/sim_params.json --show-channels
-
-Configuration of Raman pumps (their frequencies, power and pumping direction) is done via the `RamanFiber element in the network topology <gnpy/example-data/raman_edfa_example_network.json>`_.
-General numeric parameters for simulaiton control are provided in the `gnpy/example-data/sim_params.json <gnpy/example-data/sim_params.json>`_.
-
-Use ``gnpy-path-request`` to request several paths at once:
-
-.. code-block:: shell-session
-
-     $ cd $(gnpy-example-data)
-     $ gnpy-path-request -o output_file.json \
-       meshTopologyExampleV2.xls meshTopologyExampleV2_services.json
-
-This program operates on a network topology (`JSON <docs/json.rst>`__ or `Excel <docs/excel.rst>`__ format), processing the list of service requests (JSON or XLS again).
-The service requests and reply formats are based on the `draft-ietf-teas-yang-path-computation-01 <https://tools.ietf.org/html/draft-ietf-teas-yang-path-computation-01>`__ with custom extensions (e.g., for transponder modes).
-An example of the JSON input is provided in file `service-template.json`, while results are shown in `path_result_template.json`.
-
-Important note: ``gnpy-path-request`` is not a network dimensionning tool: each service does not reserve spectrum, or occupy ressources such as transponders. It only computes path feasibility assuming the spectrum (between defined frequencies) is loaded with "nb of channels" spaced by "spacing" values as specified in the system parameters input in the service file, each cannel having the same characteristics in terms of baudrate, format,... as the service transponder. The transceiver element acts as a "logical starting/stopping point" for the spectral information propagation. At that point it is not meant to represent the capacity of add drop ports.
-As a result transponder type is not part of the network info. it is related to the list of services requests.
-
-The current version includes a spectrum assigment features that enables to compute a candidate spectrum assignment for each service based on a first fit policy. Spectrum is assigned based on service specified spacing value, path_bandwidth value and selected mode for the transceiver. This spectrum assignment includes a basic capacity planning capability so that the spectrum resource is limited by the frequency min and max values defined for the links. If the requested services reach the link spectrum capacity, additional services feasibility are computed but marked as blocked due to spectrum reason.
-
-
-Contributing
-------------
-
-``gnpy`` is looking for additional contributors, especially those with experience
-planning and maintaining large-scale, real-world mesh optical networks.
-
-To get involved, please contact Jan Kundrát
-<jan.kundrat@telecominfraproject.com> or Gert Grammel <ggrammel@juniper.net>.
-
-``gnpy`` contributions are currently limited to members of `TIP
-<http://telecominfraproject.com>`_. Membership is free and open to all.
-
-See the `Onboarding Guide
-<https://github.com/Telecominfraproject/gnpy/wiki/Onboarding-Guide>`_ for
-specific details on code contributions, or just `upload patches to our Gerrit
-<https://review.gerrithub.io/Documentation/intro-gerrit-walkthrough-github.html>`_.
-
-See `AUTHORS.rst <AUTHORS.rst>`_ for past and present contributors.
-
-Project Background
-------------------
-
-Data Centers are built upon interchangeable, highly standardized node and
-network architectures rather than a sum of isolated solutions. This also
-translates to optical networking. It leads to a push in enabling multi-vendor
-optical network by disaggregating HW and SW functions and focusing on
-interoperability. In this paradigm, the burden of responsibility for ensuring
-the performance of such disaggregated open optical systems falls on the
-operators. Consequently, operators and vendors are collaborating in defining
-control models that can be readily used by off-the-shelf controllers. However,
-node and network models are only part of the answer. To take reasonable
-decisions, controllers need to incorporate logic to simulate and assess optical
-performance. Hence, a vendor-independent optical quality estimator is required.
-Given its vendor-agnostic nature, such an estimator needs to be driven by a
-consortium of operators, system and component suppliers.
-
-Founded in February 2016, the Telecom Infra Project (TIP) is an
-engineering-focused initiative which is operator driven, but features
-collaboration across operators, suppliers, developers, integrators, and
-startups with the goal of disaggregating the traditional network deployment
-approach. The group’s ultimate goal is to help provide better connectivity for
-communities all over the world as more people come on-line and demand more
-bandwidth- intensive experiences like video, virtual reality and augmented
-reality.
-
-Within TIP, the Open Optical Packet Transport (OOPT) project group is chartered
-with unbundling monolithic packet-optical network technologies in order to
-unlock innovation and support new, more flexible connectivity paradigms.
-
-The key to unbundling is the ability to accurately plan and predict the
-performance of optical line systems based on an accurate simulation of optical
-parameters. Under that OOPT umbrella, the Physical Simulation Environment (PSE)
-working group set out to disrupt the planning landscape by providing an open
-source simulation model which can be used freely across multiple vendor
-implementations.
-
-.. |docs| image:: https://readthedocs.org/projects/gnpy/badge/?version=master
-  :target: http://gnpy.readthedocs.io/en/master/?badge=master
-  :alt: Documentation Status
-  :scale: 100%
-
-.. |travis| image:: https://travis-ci.com/Telecominfraproject/oopt-gnpy.svg?branch=master
-  :target: https://travis-ci.com/Telecominfraproject/oopt-gnpy
-  :alt: Build Status via Travis CI
-  :scale: 100%
-
-.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3458319.svg
-  :target: https://doi.org/10.5281/zenodo.3458319
-  :alt: DOI
-  :scale: 100%
-
-.. |contributors| image:: https://img.shields.io/github/contributors-anon/Telecominfraproject/oopt-gnpy
-  :target: https://github.com/Telecominfraproject/oopt-gnpy/graphs/contributors
-  :alt: Code Contributors via GitHub
-  :scale: 100%
-
-.. |codacy-quality| image:: https://img.shields.io/lgtm/grade/python/github/Telecominfraproject/oopt-gnpy
-  :target: https://lgtm.com/projects/g/Telecominfraproject/oopt-gnpy/
-  :alt: Code Quality via LGTM.com
-  :scale: 100%
-
-.. |codecov| image:: https://img.shields.io/codecov/c/github/Telecominfraproject/oopt-gnpy
-  :target: https://codecov.io/gh/Telecominfraproject/oopt-gnpy
-  :alt: Code Coverage via codecov
-  :scale: 100%
-
-.. |pypi| image:: https://img.shields.io/pypi/v/gnpy
-  :target: https://pypi.org/project/gnpy/
-  :alt: Install via PyPI
-  :scale: 100%
-
-
-TIP OOPT/PSE & PSE WG Charter
------------------------------
-
-We believe that openly sharing ideas, specifications, and other intellectual
-property is the key to maximizing innovation and reducing complexity
-
-TIP OOPT/PSE's goal is to build an end-to-end simulation environment which
-defines the network models of the optical device transfer functions and their
-parameters.  This environment will provide validation of the optical
-performance requirements for the TIP OLS building blocks.
-
-- The model may be approximate or complete depending on the network complexity.
-  Each model shall be validated against the proposed network scenario.
-- The environment must be able to process network models from multiple vendors,
-  and also allow users to pick any implementation in an open source framework.
-- The PSE will influence and benefit from the innovation of the DTC, API, and
-  OLS working groups.
-- The PSE represents a step along the journey towards multi-layer optimization.
-
-License
--------
-
-``gnpy`` is distributed under a standard BSD 3-Clause License.
-
-See `LICENSE <LICENSE>`__ for more details.

docs/about-project.md

@@ -0,0 +1,58 @@
+(about-gnpy)=
+# About the project
+
+GNPy is a sponsored project of the [OOPT/PSE](https://telecominfraproject.com/open-optical-packet-transport/) working group of the [Telecom Infra Project](http://telecominfraproject.com).
+
+There are weekly calls about our progress.
+Newcomers, users and telecom operators are especially welcome there.
+We encourage all interested people outside the TIP to [join the project](https://telecominfraproject.com/apply-for-membership/) and especially to [get in touch with us](https://github.com/Telecominfraproject/oopt-gnpy/discussions).
+
+## Contributing
+
+`gnpy` is looking for additional contributors, especially those with experience planning and maintaining large-scale, real-world mesh optical networks.
+
+To get involved, please contact [Jan Kundrát](mailto:jan.kundrat@telecominfraproject.com) or [Gert Grammel](mailto:ggrammel@juniper.net).
+
+`gnpy` contributions are currently limited to members of [TIP](http://telecominfraproject.com).
+Membership is free and open to all.
+
+See the [Onboarding Guide](https://github.com/Telecominfraproject/gnpy/wiki/Onboarding-Guide) for specific details on code contributions, or just [upload patches to our Gerrit](https://review.gerrithub.io/Documentation/intro-gerrit-walkthrough-github.html).
+Here is [what we are currently working on](https://review.gerrithub.io/q/project:Telecominfraproject/oopt-gnpy+status:open).
+
+## Project Background
+
+Data Centers are built upon interchangeable, highly standardized node and network architectures rather than a sum of isolated solutions.
+This also translates to optical networking.
+It leads to a push in enabling multi-vendor optical network by disaggregating HW and SW functions and focusing on interoperability.
+In this paradigm, the burden of responsibility for ensuring the performance of such disaggregated open optical systems falls on the operators.
+Consequently, operators and vendors are collaborating in defining control models that can be readily used by off-the-shelf controllers.
+However, node and network models are only part of the answer.
+To take reasonable decisions, controllers need to incorporate logic to simulate and assess optical performance.
+Hence, a vendor-independent optical quality estimator is required.
+Given its vendor-agnostic nature, such an estimator needs to be driven by a consortium of operators, system and component suppliers.
+
+Founded in February 2016, the Telecom Infra Project (TIP) is an engineering-focused initiative which is operator driven, but features collaboration across operators, suppliers, developers, integrators, and startups with the goal of disaggregating the traditional network deployment approach.
+The group’s ultimate goal is to help provide better connectivity for communities all over the world as more people come on-line and demand more bandwidth-intensive experiences like video, virtual reality and augmented reality.
+
+Within TIP, the Open Optical Packet Transport (OOPT) project group is chartered with unbundling monolithic packet-optical network technologies in order to unlock innovation and support new, more flexible connectivity paradigms.
+
+The key to unbundling is the ability to accurately plan and predict the performance of optical line systems based on an accurate simulation of optical parameters.
+Under that OOPT umbrella, the Physical Simulation Environment (PSE) working group set out to disrupt the planning landscape by providing an open source simulation model which can be used freely across multiple vendor implementations.
+
+## TIP OOPT/PSE & PSE WG Charter
+
+We believe that openly sharing ideas, specifications, and other intellectual property is the key to maximizing innovation and reducing complexity
+
+TIP OOPT/PSE's goal is to build an end-to-end simulation environment which defines the network models of the optical device transfer functions and their parameters.
+This environment will provide validation of the optical performance requirements for the TIP OLS building blocks.
+
+- The model may be approximate or complete depending on the network complexity.
+Each model shall be validated against the proposed network scenario.
+- The environment must be able to process network models from multiple vendors, and also allow users to pick any implementation in an open source framework.
+- The PSE will influence and benefit from the innovation of the DTC, API, and OLS working groups.
+- The PSE represents a step along the journey towards multi-layer optimization.
+
+License
+-------
+
+GNPy is distributed under a standard BSD 3-Clause License.

docs/concepts.rst

@@ -237,7 +237,7 @@ GNPy supports several different noise models with varying level of accuracy.
 When in doubt, contact your vendor's technical support and ask them to :ref:`contribute their equipment descriptions<extending-edfa>` to GNPy.
 
 The most accurate noise models describe the resulting NF of an EDFA as a third-degree polynomial.
-GNPy understands polynomials as a NF-yielding function of the :ref:`gain difference from the optimal gain<ext-nf-model-polynomial-NF>`, or as a function of the input power resulting in an :ref:`incremental OSNR as used in OpenROADM<ext-nf-model-polynomial-OSNR-OpenROADM>`.
+GNPy understands polynomials as a NF-yielding function of the :ref:`gain difference from the optimal gain<ext-nf-model-polynomial-NF>`, or as a function of the input power resulting in an incremental OSNR as used in :ref:`OpenROADM inline amplifiers<ext-nf-model-polynomial-OSNR-OpenROADM>` and :ref:`OpenROADM booster/preamps in the ROADMs<ext-nf-model-noise-mask-OpenROADM>`.
 For scenarios where the vendor has not yet contributed an accurate EDFA NF description to GNPy, it is possible to approximate the characteristics via an operator-focused, min-max NF model.
 
 .. _nf-model-min-max-NF:

docs/conf.py

@@ -34,10 +34,15 @@ extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.mathjax',
               'sphinx.ext.githubpages',
               'sphinxcontrib.bibtex',
-              'pbr.sphinxext',
               'sphinx.ext.graphviz',
+              'myst_parser',
               ]
 
+myst_enable_extensions = [
+    "deflist",
+    "dollarmath",
+]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/excel.rst

@@ -185,7 +185,8 @@ This generates a text file meshTopologyExampleV2_eqt_sheet.txt  whose content ca
 - *att_in* and *att_out* are not mandatory and are not used yet. They are the value of the attenuator at input and output of amplifier (in dB).
   If filled they must contain positive numbers.
 
-- *tilt* --TODO--
+- **tilt**, in dB, is not mandatory. It is the target gain tilt over the full amplfifier bandwidth and is defined with regard to wavelength, i.e. negative tilt means lower gain
+  for higher wavelengths (lower frequencies). If not filled, the default value is 0.
 
 - **delta_p**, in dBm,  is not mandatory. If filled it is used to set the output target power per channel at the output of the amplifier, if power_mode is True. The output power is then set to power_dbm + delta_power.
 

docs/extending.rst

@@ -42,16 +42,31 @@ In that case, use:
 
 .. _ext-nf-model-polynomial-OSNR-OpenROADM:
 
-Polynomial OSNR (OpenROADM-style)
-*********************************
+Polynomial OSNR (OpenROADM-style for inline amplifier)
+******************************************************
 
-This model is useful for amplifiers compliant to the OpenROADM specification for ILA.
-In OpenROADM, amplifier performance is evaluated via its incremental OSNR, which is a function of the input power.
+This model is useful for amplifiers compliant to the OpenROADM specification for ILA (an in-line amplifier).
+The amplifier performance is evaluated via its incremental OSNR, which is a function of the input power.
 
 .. math::
 
     \text{OSNR}_\text{inc}(P_\text{in}) = \text{a}P_\text{in}^3 + \text{b}P_\text{in}^2 + \text{c}P_\text{in} + \text{d}
 
+.. _ext-nf-model-noise-mask-OpenROADM:
+
+Noise mask (OpenROADM-style for combined preamp and booster)
+************************************************************
+
+Unlike GNPy which simluates the preamplifier and the booster separately as two amplifiers for best accuracy, the OpenROADM specification mandates a certain performance level for a combination of these two amplifiers.
+For the express path, the effective noise mask comprises the preamplifier and the booster.
+When terminating a channel, the same effective noise mask is mandated for a combination of the preamplifier and the drop stage.
+
+GNPy emulates this specification via two special NF models:
+
+- The ``openroadm_preamp`` NF model for preamplifiers.
+  This NF model provides all of the linear impairments to the signal, including those which are incured by the booster in a real network.
+- The ``openroadm_booster`` NF model is a special "zero noise" faux amplifier in place of the booster.
+
 .. _ext-nf-model-min-max-NF:
 
 Min-max NF

docs/index.rst

@@ -8,11 +8,13 @@ in real-world mesh optical networks. It is based on the Gaussian Noise Model.
 .. toctree::
    :maxdepth: 4
 
+   intro
    concepts
    install
    json
    excel
    extending
+   about-project
    model
    gnpy-api
 

docs/intro.rst

@@ -0,0 +1,95 @@
+.. _intro:
+
+Introduction
+============
+
+``gnpy`` is a library for building route planning and optimization tools.
+
+It ships with a number of example programs. Release versions will ship with
+fully-functional programs.
+
+    **Note**: *If you are a network operator or involved in route planning and
+    optimization for your organization, please contact project maintainer Jan
+    Kundrát <jan.kundrat@telecominfraproject.com>. gnpy is looking for users with
+    specific, delineated use cases to drive requirements for future
+    development.*
+
+This example demonstrates how GNPy can be used to check the expected SNR at the end of the line by varying the channel input power:
+
+.. image:: https://telecominfraproject.github.io/oopt-gnpy/docs/images/transmission_main_example.svg
+   :width: 100%
+   :align: left
+   :alt: Running a simple simulation example
+   :target: https://asciinema.org/a/252295
+
+By default, this script operates on a single span network defined in
+`gnpy/example-data/edfa_example_network.json <gnpy/example-data/edfa_example_network.json>`_
+
+You can specify a different network at the command line as follows. For
+example, to use the CORONET Global network defined in
+`gnpy/example-data/CORONET_Global_Topology.json <gnpy/example-data/CORONET_Global_Topology.json>`_:
+
+.. code-block:: shell-session
+
+    $ gnpy-transmission-example $(gnpy-example-data)/CORONET_Global_Topology.json
+
+It is also possible to use an Excel file input (for example
+`gnpy/example-data/CORONET_Global_Topology.xls <gnpy/example-data/CORONET_Global_Topology.xls>`_).
+The Excel file will be processed into a JSON file with the same prefix.
+Further details about the Excel data structure are available `in the documentation <docs/excel.rst>`__.
+
+The main transmission example will calculate the average signal OSNR and SNR
+across network elements (transceiver, ROADMs, fibers, and amplifiers)
+between two transceivers selected by the user. Additional details are provided by doing ``gnpy-transmission-example -h``. (By default, for the CORONET Global
+network, it will show the transmission of spectral information between Abilene and Albany)
+
+This script calculates the average signal OSNR = |OSNR| and SNR = |SNR|.
+
+.. |OSNR| replace:: P\ :sub:`ch`\ /P\ :sub:`ase`
+.. |SNR| replace:: P\ :sub:`ch`\ /(P\ :sub:`nli`\ +\ P\ :sub:`ase`)
+
+|Pase| is the amplified spontaneous emission noise, and |Pnli| the non-linear
+interference noise.
+
+.. |Pase| replace:: P\ :sub:`ase`
+.. |Pnli| replace:: P\ :sub:`nli`
+
+Further Instructions for Use
+----------------------------
+
+Simulations are driven by a set of `JSON <docs/json.rst>`__ or `XLS <docs/excel.rst>`__ files.
+
+The ``gnpy-transmission-example`` script propagates a spectrum of channels at 32 Gbaud, 50 GHz spacing and 0 dBm/channel. 
+Launch power can be overridden by using the ``--power`` argument.
+Spectrum information is not yet parametrized but can be modified directly in the ``eqpt_config.json`` (via the ``SpectralInformation`` -SI- structure) to accommodate any baud rate or spacing.
+The number of channel is computed based on ``spacing`` and ``f_min``, ``f_max`` values.
+
+An experimental support for Raman amplification is available:
+
+.. code-block:: shell-session
+
+     $ gnpy-transmission-example \
+       $(gnpy-example-data)/raman_edfa_example_network.json \
+       --sim $(gnpy-example-data)/sim_params.json --show-channels
+
+Configuration of Raman pumps (their frequencies, power and pumping direction) is done via the `RamanFiber element in the network topology <gnpy/example-data/raman_edfa_example_network.json>`_.
+General numeric parameters for simulation control are provided in the `gnpy/example-data/sim_params.json <gnpy/example-data/sim_params.json>`_.
+
+Use ``gnpy-path-request`` to request several paths at once:
+
+.. code-block:: shell-session
+
+     $ cd $(gnpy-example-data)
+     $ gnpy-path-request -o output_file.json \
+       meshTopologyExampleV2.xls meshTopologyExampleV2_services.json
+
+This program operates on a network topology (`JSON <docs/json.rst>`__ or `Excel <docs/excel.rst>`__ format), processing the list of service requests (JSON or XLS again).
+The service requests and reply formats are based on the `draft-ietf-teas-yang-path-computation-01 <https://tools.ietf.org/html/draft-ietf-teas-yang-path-computation-01>`__ with custom extensions (e.g., for transponder modes).
+An example of the JSON input is provided in file `service-template.json`, while results are shown in `path_result_template.json`.
+
+Important note: ``gnpy-path-request`` is not a network dimensionning tool: each service does not reserve spectrum, or occupy ressources such as transponders. It only computes path feasibility assuming the spectrum (between defined frequencies) is loaded with "nb of channels" spaced by "spacing" values as specified in the system parameters input in the service file, each cannel having the same characteristics in terms of baudrate, format,... as the service transponder. The transceiver element acts as a "logical starting/stopping point" for the spectral information propagation. At that point it is not meant to represent the capacity of add drop ports.
+As a result transponder type is not part of the network info. it is related to the list of services requests.
+
+The current version includes a spectrum assigment features that enables to compute a candidate spectrum assignment for each service based on a first fit policy. Spectrum is assigned based on service specified spacing value, path_bandwidth value and selected mode for the transceiver. This spectrum assignment includes a basic capacity planning capability so that the spectrum resource is limited by the frequency min and max values defined for the links. If the requested services reach the link spectrum capacity, additional services feasibility are computed but marked as blocked due to spectrum reason.
+
+OpenROADM networks can be simulated via ``gnpy/example-data/eqpt_config_openroadm.json`` -- see ``gnpy/example-data/Sweden_OpenROADM_example_network.json`` as an example. 

docs/json.rst

@@ -11,8 +11,7 @@ Design and transmission parameters are defined in a dedicated json file.
 By default, this information is read from `gnpy/example-data/eqpt_config.json <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/gnpy/example-data/eqpt_config.json>`_.
 This file defines the equipment libraries that can be customized (EDFAs, fibers, and transceivers).
 
-It also defines the simulation parameters (spans, ROADMs, and the spectral
-information to transmit.)
+It also defines the simulation parameters (spans, ROADMs, and the spectral information to transmit.)
 
 EDFA
 ~~~~
@@ -20,9 +19,20 @@ EDFA
 The EDFA equipment library is a list of supported amplifiers. New amplifiers
 can be added and existing ones removed. Three different noise models are available:
 
-1. ``'type_def': 'variable_gain'`` is a simplified model simulating a 2-coil EDFA with internal, input and output VOAs. The NF vs gain response is calculated accordingly based on the input parameters: ``nf_min``, ``nf_max``, and ``gain_flatmax``. It is not a simple interpolation but a 2-stage NF calculation.
-2. ``'type_def': 'fixed_gain'`` is a fixed gain model.  `NF == Cte == nf0` if `gain_min < gain < gain_flatmax`
-3. ``'type_def': None`` is an advanced model. A detailed JSON configuration file is required (by default `gnpy/example-data/std_medium_gain_advanced_config.json <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/gnpy/example-data/std_medium_gain_advanced_config.json>`_). It uses a 3rd order polynomial where NF = f(gain), NF_ripple = f(frequency), gain_ripple = f(frequency), N-array dgt = f(frequency). Compared to the previous models, NF ripple and gain ripple are modelled.
+1. ``'type_def': 'variable_gain'`` is a simplified model simulating a 2-coil EDFA with internal, input and output VOAs.
+   The NF vs gain response is calculated accordingly based on the input parameters: ``nf_min``, ``nf_max``, and ``gain_flatmax``.
+   It is not a simple interpolation but a 2-stage NF calculation.
+2. ``'type_def': 'fixed_gain'`` is a fixed gain model.
+   `NF == Cte == nf0` if `gain_min < gain < gain_flatmax`
+3. ``'type_def': 'openroadm'`` models the incremental OSNR contribution as a function of input power.
+   It is suitable for inline amplifiers that conform to the OpenROADM specification.
+   The input parameters are coefficients of the :ref:`third-degree polynomial<ext-nf-model-polynomial-OSNR-OpenROADM>`.
+4. ``'type_def': 'openroadm_preamp'`` and ``openroadm_booster`` approximate the :ref:`preamp and booster within an OpenROADM network<ext-nf-model-noise-mask-OpenROADM>`.
+   No extra parameters specific to the NF model are accepted.
+5. ``'type_def': 'advanced_model'`` is an advanced model.
+   A detailed JSON configuration file is required (by default `gnpy/example-data/std_medium_gain_advanced_config.json <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/gnpy/example-data/std_medium_gain_advanced_config.json>`_).
+   It uses a 3rd order polynomial where NF = f(gain), NF_ripple = f(frequency), gain_ripple = f(frequency), N-array dgt = f(frequency).
+   Compared to the previous models, NF ripple and gain ripple are modelled.
 
 For all amplifier models:
 
@@ -49,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:
 
-+----------------------+-----------+-----------------------------------------+
-| field                | type      | description                             |
-+======================+===========+=========================================+
-| ``type_variety``     | (string)  | a unique name to ID the fiber in the    |
-|                      |           | JSON or Excel template topology input   |
-|                      |           | file                                    |
-+----------------------+-----------+-----------------------------------------+
-| ``dispersion``       | (number)  | (s.m-1.m-1)                             |
-+----------------------+-----------+-----------------------------------------+
-| ``dispersion_slope`` | (number)  | (s.m-1.m-1.m-1)                         |
-+----------------------+-----------+-----------------------------------------+
-| ``gamma``            | (number)  | 2pi.n2/(lambda*Aeff) (w-1.m-1)          |
-+----------------------+-----------+-----------------------------------------+
-| ``pmd_coef``         | (number)  | Polarization mode dispersion (PMD)      |
-|                      |           | coefficient. (s.sqrt(m)-1)              |
-+----------------------+-----------+-----------------------------------------+
++----------------------+-----------+------------------------------------------+
+| field                | type      | description                              |
++======================+===========+==========================================+
+| ``type_variety``     | (string)  | a unique name to ID the fiber in the     |
+|                      |           | JSON or Excel template topology input    |
+|                      |           | file                                     |
++----------------------+-----------+------------------------------------------+
+| ``dispersion``       | (number)  | In :math:`s \times m^{-1} \times m^{-1}`.|
++----------------------+-----------+------------------------------------------+
+| ``dispersion_slope`` | (number)  | In :math:`s \times m^{-1} \times m^{-1}  |
+|                      |           | \times 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)       |
+|                      |           | coefficient. In                          |
+|                      |           | :math:`s\times\sqrt{m}^{-1}`.            |
++----------------------+-----------+------------------------------------------+
 
 Transceiver
 ~~~~~~~~~~~
@@ -81,7 +94,7 @@ used to determine the service list path feasibility when running the
 |                      |           | the JSON or Excel template topology     |
 |                      |           | input file                              |
 +----------------------+-----------+-----------------------------------------+
-| ``frequency``        | (number)  | Min/max as below.                       |
+| ``frequency``        | (number)  | Min/max central channel frequency.      |
 +----------------------+-----------+-----------------------------------------+
 | ``mode``             | (number)  | A list of modes supported by the        |
 |                      |           | transponder. New modes can be added at  |
@@ -154,24 +167,17 @@ Global parameters
 The following options are still defined in ``eqpt_config.json`` for legacy reasons, but
 they do not correspond to tangible network devices.
 
-Auto-design automatically creates EDFA amplifier network elements when they are
-missing, after a fiber, or between a ROADM and a fiber. This auto-design
-functionality can be manually and locally deactivated by introducing a ``Fused``
-network element after a ``Fiber`` or a ``Roadm`` that doesn't need amplification.
-The amplifier is chosen in the EDFA list of the equipment library based on
-gain, power, and NF criteria. Only the EDFA that are marked
-``'allowed_for_design': true`` are considered.
+Auto-design automatically creates EDFA amplifier network elements when they are missing, after a fiber, or between a ROADM and a fiber.
+This auto-design functionality can be manually and locally deactivated by introducing a ``Fused`` network element after a ``Fiber`` or a ``Roadm`` that doesn't need amplification.
+The amplifier is chosen in the EDFA list of the equipment library based on gain, power, and NF criteria.
+Only the EDFA that are marked ``'allowed_for_design': true`` are considered.
 
-For amplifiers defined in the topology JSON input but whose ``gain = 0``
-(placeholder), auto-design will set its gain automatically: see ``power_mode`` in
-the ``Spans`` library to find out how the gain is calculated.
+For amplifiers defined in the topology JSON input but whose ``gain = 0`` (placeholder), auto-design will set its gain automatically: see ``power_mode`` in the ``Spans`` library to find out how the gain is calculated.
 
 Span
 ~~~~
 
-Span configuration is not a list (which may change
-in later releases) and the user can only modify the value of existing
-parameters:
+Span configuration is not a list (which may change in later releases) and the user can only modify the value of existing parameters:
 
 +-------------------------------------+-----------+---------------------------------------------+
 | field                               | type      | description                                 |
@@ -297,16 +303,18 @@ parameters:
 SpectralInformation
 ~~~~~~~~~~~~~~~~~~~
 
-The user can only modify the value of existing parameters. It defines a spectrum of N
-identical carriers. While the code libraries allow for different carriers and
-power levels, the current user parametrization only allows one carrier type and
-one power/channel definition.
+The user can only modify the value of existing parameters.
+It defines a spectrum of N identical carriers.
+While the code libraries allow for different carriers and power levels, the current user parametrization only allows one carrier type and one power/channel definition.
 
 +----------------------+-----------+-------------------------------------------+
 | field                |   type    | description                               |
 +======================+===========+===========================================+
-| ``f_min``,           | (number)  | In Hz. Carrier min max excursion.         |
-| ``f_max``            |           |                                           |
+| ``f_min``,           | (number)  | In Hz. Define spectrum boundaries. Note   |
+| ``f_max``            |           | that due to backward compatibility, the   |
+|                      |           | first channel central frequency is placed |
+|                      |           | at :math:`f_{min} + spacing` and the last |
+|                      |           | one at :math:`f_{max}`.                   |
 +----------------------+-----------+-------------------------------------------+
 | ``baud_rate``        | (number)  | In Hz. Simulated baud rate.               |
 +----------------------+-----------+-------------------------------------------+

docs/requirements.txt

@@ -0,0 +1,7 @@
+alabaster>=0.7.12,<1
+docutils>=0.15.2,<1
+myst-parser>=0.14.0,<1
+Pygments>=2.7.4,<3
+rstcheck
+Sphinx>=3.5.0,<4
+sphinxcontrib-bibtex>=0.4.2,<1

gnpy/core/elements.py

@@ -52,10 +52,6 @@ class _Node:
         if type_variety:
             self.type_variety = type_variety
 
-    @property
-    def coords(self):
-        return self.lng, self.lat
-
     @property
     def location(self):
         return self.metadata['location']
@@ -169,10 +165,10 @@ class Transceiver(_Node):
 
         return '\n'.join([f'{type(self).__name__} {self.uid}',
 
+                          f'  GSNR (0.1nm, dB):          {snr_01nm:.2f}',
+                          f'  GSNR (signal bw, dB):      {snr:.2f}',
                           f'  OSNR ASE (0.1nm, dB):      {osnr_ase_01nm:.2f}',
                           f'  OSNR ASE (signal bw, dB):  {osnr_ase:.2f}',
-                          f'  SNR total (signal bw, dB): {snr:.2f}',
-                          f'  SNR total (0.1nm, dB):     {snr_01nm:.2f}',
                           f'  CD (ps/nm):                {cd:.2f}',
                           f'  PMD (ps):                  {pmd:.2f}'])
 
@@ -221,7 +217,7 @@ class Roadm(_Node):
 
         return '\n'.join([f'{type(self).__name__} {self.uid}',
                           f'  effective loss (dB):  {self.effective_loss:.2f}',
-                          f'  pch out (dBm):        {self.effective_pch_out_db!r}'])
+                          f'  pch out (dBm):        {self.effective_pch_out_db:.2f}'])
 
     def propagate(self, pref, *carriers, degree):
         # pin_target and loss are read from eqpt_config.json['Roadm']
@@ -345,18 +341,12 @@ class Fiber(_Node):
 
         return '\n'.join([f'{type(self).__name__}          {self.uid}',
                           f'  type_variety:                {self.type_variety}',
-                          f'  length (km):                 '
-                          f'{round(self.params.length * 1e-3):.2f}',
+                          f'  length (km):                 {self.params.length * 1e-3:.2f}',
                           f'  pad att_in (dB):             {self.params.att_in:.2f}',
                           f'  total loss (dB):             {self.loss:.2f}',
                           f'  (includes conn loss (dB) in: {self.params.con_in:.2f} out: {self.params.con_out:.2f})',
                           f'  (conn loss out includes EOL margin defined in eqpt_config.json)',
-                          f'  pch out (dBm): {self.pch_out_db!r}'])
-
-    @property
-    def fiber_loss(self):
-        """Fiber loss in dB, not including padding attenuator"""
-        return self.params.loss_coef * self.params.length + self.params.con_in + self.params.con_out
+                          f'  pch out (dBm): {self.pch_out_db:.2f}'])
 
     @property
     def loss(self):
@@ -557,6 +547,7 @@ class Edfa(_Node):
             params = {}
         if operational is None:
             operational = {}
+        self.variety_list = kwargs.pop('variety_list', None)
         super().__init__(
             *args,
             params=EdfaParams(**params),
@@ -623,9 +614,9 @@ class Edfa(_Node):
                           f'  pad att_in (dB):        {self.att_in:.2f}',
                           f'  Power In (dBm):         {self.pin_db:.2f}',
                           f'  Power Out (dBm):        {self.pout_db:.2f}',
-                          f'  Delta_P (dB):           {self.delta_p!r}',
-                          f'  target pch (dBm):       {self.target_pch_out_db!r}',
-                          f'  effective pch (dBm):    {self.effective_pch_out_db!r}',
+                          f'  Delta_P (dB):           ' + f'{self.delta_p:.2f}' if self.delta_p is not None else 'None',
+                          f'  target pch (dBm):       ' + f'{self.target_pch_out_db:.2f}' if self.target_pch_out_db is not None else 'None',
+                          f'  effective pch (dBm):    {self.effective_pch_out_db:.2f}',
                           f'  output VOA (dB):        {self.out_voa:.2f}'])
 
     def interpol_params(self, frequencies, pin, baud_rates, pref):
@@ -685,6 +676,13 @@ class Edfa(_Node):
             pin_ch = self.pin_db - lin2db(self.nch)
             # model OSNR = f(Pin)
             nf_avg = pin_ch - polyval(nf_model.nf_coef, pin_ch) + 58
+        elif type_def == 'openroadm_preamp':
+            pin_ch = self.pin_db - lin2db(self.nch)
+            # model OSNR = f(Pin)
+            nf_avg = pin_ch - min((4 * pin_ch + 275) / 7, 33) + 58
+        elif type_def == 'openroadm_booster':
+            # model a zero-noise amp with "infinitely negative" (in dB) NF
+            nf_avg = float('-inf')
         elif type_def == 'advanced_model':
             nf_avg = polyval(nf_fit_coeff, -dg)
         return nf_avg + pad, pad
@@ -805,25 +803,19 @@ class Edfa(_Node):
         if len(self.interpol_dgt) == 1:
             return array([self.effective_gain])
 
-        nb_channel = arange(len(self.interpol_dgt))
-
         # TODO|jla: find a way to use these or lose them. Primarily we should have
         # a way to determine if exceeding the gain or output power of the amp
         tot_in_power_db = self.pin_db  # Pin in W
 
         # linear fit to get the
-        p = polyfit(nb_channel, self.interpol_dgt, 1)
+        p = polyfit(self.channel_freq, self.interpol_dgt, 1)
         dgt_slope = p[0]
 
-        # Calculate the target slope - currently assumes equal spaced channels
-        # TODO|jla: support arbitrary channel spacing
-        targ_slope = self.tilt_target / (len(nb_channel) - 1)
+        # Calculate the target slope
+        targ_slope = -self.tilt_target / (self.params.f_max - self.params.f_min)
 
         # first estimate of DGT scaling
-        if abs(dgt_slope) > 0.001:  # check for zero value due to flat dgt
-            dgts1 = targ_slope / dgt_slope
-        else:
-            dgts1 = 0
+        dgts1 = targ_slope / dgt_slope if dgt_slope != 0. else 0.
 
         # when simple_opt is true, make 2 attempts to compute gain and
         # the internal voa value. This is currently here to provide direct

gnpy/core/network.py

@@ -156,52 +156,45 @@ def target_power(network, node, equipment):  # get_fiber_dp
     return dp
 
 
+_fiber_fused_types = (elements.Fused, elements.Fiber)
+
+
 def prev_node_generator(network, node):
     """fused spans interest:
-    iterate over all predecessors while they are Fused or Fiber type"""
+    iterate over all predecessors while they are either Fused or Fibers succeeded by Fused"""
     try:
         prev_node = next(network.predecessors(node))
     except StopIteration:
+        if isinstance(node, elements.Transceiver):
+            return
         raise NetworkTopologyError(f'Node {node.uid} is not properly connected, please check network topology')
-    # yield and re-iterate
-    if isinstance(prev_node, elements.Fused) or isinstance(node, elements.Fused):
+    if ((isinstance(prev_node, elements.Fused) and isinstance(node, _fiber_fused_types)) or
+            (isinstance(prev_node, _fiber_fused_types) and isinstance(node, elements.Fused))):
         yield prev_node
         yield from prev_node_generator(network, prev_node)
-    else:
-        StopIteration
 
 
 def next_node_generator(network, node):
     """fused spans interest:
-    iterate over all successors while they are Fused or Fiber type"""
+    iterate over all predecessors while they are either Fused or Fibers preceded by Fused"""
     try:
         next_node = next(network.successors(node))
     except StopIteration:
-        raise NetworkTopologyError('Node {node.uid} is not properly connected, please check network topology')
-    # yield and re-iterate
-    if isinstance(next_node, elements.Fused) or isinstance(node, elements.Fused):
+        if isinstance(node, elements.Transceiver):
+            return
+        raise NetworkTopologyError(f'Node {node.uid} is not properly connected, please check network topology')
+
+    if ((isinstance(next_node, elements.Fused) and isinstance(node, _fiber_fused_types)) or
+            (isinstance(next_node, _fiber_fused_types) and isinstance(node, elements.Fused))):
         yield next_node
         yield from next_node_generator(network, next_node)
-    else:
-        StopIteration
 
 
 def span_loss(network, node):
-    """Fused span interest:
-    return the total span loss of all the fibers spliced by a Fused node"""
+    """Total loss of a span (Fiber and Fused nodes) which contains the given node"""
     loss = node.loss if node.passive else 0
-    try:
-        prev_node = next(network.predecessors(node))
-        if isinstance(prev_node, elements.Fused):
-            loss += sum(n.loss for n in prev_node_generator(network, node))
-    except StopIteration:
-        pass
-    try:
-        next_node = next(network.successors(node))
-        if isinstance(next_node, elements.Fused):
-            loss += sum(n.loss for n in next_node_generator(network, node))
-    except StopIteration:
-        pass
+    loss += sum(n.loss for n in prev_node_generator(network, node))
+    loss += sum(n.loss for n in next_node_generator(network, node))
     return loss
 
 
@@ -294,22 +287,17 @@ def set_egress_amplifier(network, this_node, equipment, pref_ch_db, pref_total_d
                 else:
                     raman_allowed = False
 
-                # implementation of restrictions on roadm boosters
-                if isinstance(prev_node, elements.Roadm):
-                    if prev_node.restrictions['booster_variety_list']:
+                if node.params.type_variety == '':
+                    if node.variety_list and isinstance(node.variety_list, list):
+                        restrictions = node.variety_list
+                    elif isinstance(prev_node, elements.Roadm) and prev_node.restrictions['booster_variety_list']:
+                        # implementation of restrictions on roadm boosters
                         restrictions = prev_node.restrictions['booster_variety_list']
-                    else:
-                        restrictions = None
-                elif isinstance(next_node, elements.Roadm):
-                    # implementation of restrictions on roadm preamp
-                    if next_node.restrictions['preamp_variety_list']:
+                    elif isinstance(next_node, elements.Roadm) and next_node.restrictions['preamp_variety_list']:
+                        # implementation of restrictions on roadm preamp
                         restrictions = next_node.restrictions['preamp_variety_list']
                     else:
                         restrictions = None
-                else:
-                    restrictions = None
-
-                if node.params.type_variety == '':
                     edfa_variety, power_reduction = select_edfa(raman_allowed, gain_target, power_target, equipment, node.uid, restrictions)
                     extra_params = equipment['Edfa'][edfa_variety]
                     node.params.update_params(extra_params.__dict__)
@@ -342,21 +330,22 @@ def set_egress_amplifier(network, this_node, equipment, pref_ch_db, pref_total_d
     if isinstance(this_node, elements.Roadm):
         this_node.per_degree_pch_out_db = {k: v for k, v in this_node_degree.items()}
 
-def add_egress_amplifier(network, node):
-    next_nodes = [n for n in network.successors(node)
+
+def add_roadm_booster(network, roadm):
+    next_nodes = [n for n in network.successors(roadm)
                   if not (isinstance(n, elements.Transceiver) or isinstance(n, elements.Fused) or isinstance(n, elements.Edfa))]
     # no amplification for fused spans or TRX
-    for i, next_node in enumerate(next_nodes):
-        network.remove_edge(node, next_node)
+    for next_node in next_nodes:
+        network.remove_edge(roadm, next_node)
         amp = elements.Edfa(
-            uid=f'Edfa{i}_{node.uid}',
+            uid=f'Edfa_booster_{roadm.uid}_to_{next_node.uid}',
             params={},
             metadata={
                 'location': {
-                    'latitude': (node.lat + next_node.lat) / 2,
-                    'longitude': (node.lng + next_node.lng) / 2,
-                    'city': node.loc.city,
-                    'region': node.loc.region,
+                    'latitude': roadm.lat,
+                    'longitude': roadm.lng,
+                    'city': roadm.loc.city,
+                    'region': roadm.loc.region,
                 }
             },
             operational={
@@ -364,11 +353,62 @@ def add_egress_amplifier(network, node):
                 'tilt_target': 0,
             })
         network.add_node(amp)
-        if isinstance(node, elements.Fiber):
-            edgeweight = node.params.length
+        network.add_edge(roadm, amp, weight=0.01)
+        network.add_edge(amp, next_node, weight=0.01)
+
+
+def add_roadm_preamp(network, roadm):
+    prev_nodes = [n for n in network.predecessors(roadm)
+                  if not (isinstance(n, elements.Transceiver) or isinstance(n, elements.Fused) or isinstance(n, elements.Edfa))]
+    # no amplification for fused spans or TRX
+    for prev_node in prev_nodes:
+        network.remove_edge(prev_node, roadm)
+        amp = elements.Edfa(
+            uid=f'Edfa_preamp_{roadm.uid}_from_{prev_node.uid}',
+            params={},
+            metadata={
+                'location': {
+                    'latitude': roadm.lat,
+                    'longitude': roadm.lng,
+                    'city': roadm.loc.city,
+                    'region': roadm.loc.region,
+                }
+            },
+            operational={
+                'gain_target': None,
+                'tilt_target': 0,
+            })
+        network.add_node(amp)
+        if isinstance(prev_node, elements.Fiber):
+            edgeweight = prev_node.params.length
         else:
             edgeweight = 0.01
-        network.add_edge(node, amp, weight=edgeweight)
+        network.add_edge(prev_node, amp, weight=edgeweight)
+        network.add_edge(amp, roadm, weight=0.01)
+
+
+def add_inline_amplifier(network, fiber):
+    next_node = next(network.successors(fiber))
+    if isinstance(next_node, elements.Fiber) or isinstance(next_node, elements.RamanFiber):
+        # no amplification for fused spans or TRX
+        network.remove_edge(fiber, next_node)
+        amp = elements.Edfa(
+            uid=f'Edfa_{fiber.uid}',
+            params={},
+            metadata={
+                'location': {
+                    'latitude': (fiber.lat + next_node.lat) / 2,
+                    'longitude': (fiber.lng + next_node.lng) / 2,
+                    'city': fiber.loc.city,
+                    'region': fiber.loc.region,
+                }
+            },
+            operational={
+                'gain_target': None,
+                'tilt_target': 0,
+            })
+        network.add_node(amp)
+        network.add_edge(fiber, amp, weight=fiber.params.length)
         network.add_edge(amp, next_node, weight=0.01)
 
 
@@ -407,8 +447,8 @@ def split_fiber(network, fiber, bounds, target_length, equipment):
 
     fiber.params.length = new_length
 
-    xpos = [prev_node.lng + (next_node.lng - prev_node.lng) * (n + 1) / (n_spans + 1) for n in range(n_spans)]
-    ypos = [prev_node.lat + (next_node.lat - prev_node.lat) * (n + 1) / (n_spans + 1) for n in range(n_spans)]
+    xpos = [prev_node.lng + (next_node.lng - prev_node.lng) * (n + 0.5) / n_spans for n in range(n_spans)]
+    ypos = [prev_node.lat + (next_node.lat - prev_node.lat) * (n + 0.5) / n_spans for n in range(n_spans)]
     for span, lng, lat in zip(range(n_spans), xpos, ypos):
         new_span = elements.Fiber(uid=f'{fiber.uid}_({span+1}/{n_spans})',
                          type_variety=fiber.type_variety,
@@ -487,12 +527,15 @@ def build_network(network, equipment, pref_ch_db, pref_total_db):
     for fiber in fibers:
         split_fiber(network, fiber, bounds, target_length, equipment)
 
-    amplified_nodes = [n for n in network.nodes() if isinstance(n, elements.Fiber) or isinstance(n, elements.Roadm)]
+    roadms = [r for r in network.nodes() if isinstance(r, elements.Roadm)]
+    for roadm in roadms:
+        add_roadm_preamp(network, roadm)
+        add_roadm_booster(network, roadm)
 
-    for node in amplified_nodes:
-        add_egress_amplifier(network, node)
+    fibers = [f for f in network.nodes() if isinstance(f, elements.Fiber)]
+    for fiber in fibers:
+        add_inline_amplifier(network, fiber)
 
-    roadms = [r for r in amplified_nodes if isinstance(r, elements.Roadm)]
     for roadm in roadms:
         set_egress_amplifier(network, roadm, equipment, pref_ch_db, pref_total_db)
 

gnpy/core/science_utils.py

@@ -359,7 +359,7 @@ class RamanSolver:
         cr = interp_cr(freq_diff)
 
         # z propagation axis
-        z = arange(0, fiber_length + 1, z_resolution)
+        z = append(arange(0, fiber_length, z_resolution), fiber_length)
 
         def ode_function(z, p):
             return self._ode_stimulated_raman(z, p, alphap_fiber, freq_array, cr, prop_direct)
@@ -484,7 +484,7 @@ class NliSolver:
             eta_matrix = self._compute_eta_matrix(carrier, *carriers)
             carrier_nli = self._carrier_nli_from_eta_matrix(eta_matrix, carrier, *carriers)
         else:
-            raise ValueError(f'Method {sim_params.nli_params.method_nli} not implemented.')
+            raise ValueError(f'Method {sim_params.nli_params.nli_method_name} not implemented.')
 
         return carrier_nli
 

gnpy/example-data/Juniper-BoosterHG.json

@@ -1,13 +1,13 @@
 {
-      "nf_fit_coeff": [
+    "nf_fit_coeff": [
         0.0008,
         0.0272,
         -0.2249,
         6.4902
-       ],
-      "f_min": 191.35e12,
-      "f_max": 196.1e12,
-       "nf_ripple": [
+    ],
+    "f_min": 191.4e12,
+    "f_max": 196.1e12,
+    "nf_ripple": [
         0.0,
         0.0,
         0.0,
@@ -58,103 +58,103 @@
         0.0
     ],
     "gain_ripple": [
-        0.15017064489112,
-        0.14157768006701,
-        0.00223094639866,
-        -0.06701528475711,
-        -0.05982935510889,
-        -0.01028161641541,
-        0.02740682579566,
-        0.02795958961474,
-        0.00107516750419,
-        -0.02199015912898,
-        -0.00877407872698,
-        0.0453465242881,
-        0.1204721524288,
-        0.18936662479061,
-        0.23826109715241,
-        0.26956762981574,
-        0.27836159966498,
-        0.26941687604691,
-        0.23579878559464,
-        0.18147717755444,
-        0.1191656197655,
-        0.05921587102177,
-        0.01509526800668,
-        -0.01053287269681,
-        -0.02475397822447,
-        -0.01847257118928,
-        -0.00420121440538,
-        0.01584903685091,
-        0.0399193886097,
-        0.04494451423784,
-        0.04961788107202,
-        0.03378873534338,
-        0.01027114740367,
-        -0.01319618927973,
-        -0.04962835008375,
-        -0.0765630234506,
-        -0.10606051088777,
-        -0.13550774706866,
-        -0.15460322445561,
-        -0.17113588777219,
-        -0.18053287269681,
-        -0.18324644053602,
-        -0.19440221943049,
-        -0.20897508375209,
-        -0.23575900335007,
-        -0.25188965661642,
+        -0.15656302345061,
         -0.22244242043552,
-        -0.15656302345061
+        -0.25188965661642,
+        -0.23575900335007,
+        -0.20897508375209,
+        -0.19440221943049,
+        -0.18324644053602,
+        -0.18053287269681,
+        -0.17113588777219,
+        -0.15460322445561,
+        -0.13550774706866,
+        -0.10606051088777,
+        -0.0765630234506,
+        -0.04962835008375,
+        -0.01319618927973,
+        0.01027114740367,
+        0.03378873534338,
+        0.04961788107202,
+        0.04494451423784,
+        0.0399193886097,
+        0.01584903685091,
+        -0.00420121440538,
+        -0.01847257118928,
+        -0.02475397822447,
+        -0.01053287269681,
+        0.01509526800668,
+        0.05921587102177,
+        0.1191656197655,
+        0.18147717755444,
+        0.23579878559464,
+        0.26941687604691,
+        0.27836159966498,
+        0.26956762981574,
+        0.23826109715241,
+        0.18936662479061,
+        0.1204721524288,
+        0.0453465242881,
+        -0.00877407872698,
+        -0.02199015912898,
+        0.00107516750419,
+        0.02795958961474,
+        0.02740682579566,
+        -0.01028161641541,
+        -0.05982935510889,
+        -0.06701528475711,
+        0.00223094639866,
+        0.14157768006701,
+        0.15017064489112
     ],
     "dgt": [
-        2.4553191172498,
-        2.44342862248888,
-        2.41879254989742,
-        2.38192717604575,
-        2.33147727493671,
-        2.26678136721453,
-        2.19013043016015,
-        2.10336369905543,
-        2.01414465424155,
-        1.92915262384742,
-        1.85543800978691,
-        1.79748596476494,
-        1.75428006928365,
-        1.72461030013125,
-        1.70379790088896,
-        1.68845480656382,
-        1.6761448370895,
-        1.66286684904577,
-        1.64799163036252,
-        1.63068023161292,
-        1.61073904908309,
-        1.58973304612691,
-        1.56750088631614,
-        1.54578500307573,
-        1.5242627235492,
-        1.50335352244996,
-        1.48420288841848,
-        1.46637521309853,
-        1.44977369463316,
-        1.43476940680732,
-        1.42089447397912,
-        1.40864903907609,
-        1.3966294751726,
-        1.38430337205545,
-        1.3710092503689,
-        1.35690844654118,
-        1.3405812000038,
-        1.32210817897091,
-        1.30069883494415,
-        1.27657903892303,
-        1.24931318255134,
-        1.21911100318577,
-        1.18632744096844,
-        1.15209185089701,
-        1.11575888725852,
-        1.07773189112355,
+        1.0,
         1.03941448941778,
-        1.0
+        1.07773189112355,
+        1.11575888725852,
+        1.15209185089701,
+        1.18632744096844,
+        1.21911100318577,
+        1.24931318255134,
+        1.27657903892303,
+        1.30069883494415,
+        1.32210817897091,
+        1.3405812000038,
+        1.35690844654118,
+        1.3710092503689,
+        1.38430337205545,
+        1.3966294751726,
+        1.40864903907609,
+        1.42089447397912,
+        1.43476940680732,
+        1.44977369463316,
+        1.46637521309853,
+        1.48420288841848,
+        1.50335352244996,
+        1.5242627235492,
+        1.54578500307573,
+        1.56750088631614,
+        1.58973304612691,
+        1.61073904908309,
+        1.63068023161292,
+        1.64799163036252,
+        1.66286684904577,
+        1.6761448370895,
+        1.68845480656382,
+        1.70379790088896,
+        1.72461030013125,
+        1.75428006928365,
+        1.79748596476494,
+        1.85543800978691,
+        1.92915262384742,
+        2.01414465424155,
+        2.10336369905543,
+        2.19013043016015,
+        2.26678136721453,
+        2.33147727493671,
+        2.38192717604575,
+        2.41879254989742,
+        2.44342862248888,
+        2.4553191172498
     ]
 }

gnpy/example-data/default_edfa_config.json

@@ -6,101 +6,101 @@
         0.0
     ],
     "dgt": [
-        2.714526681131686,
-        2.705443819238505,
-        2.6947834587664494,
-        2.6841217449620203,
-        2.6681935771243177,
-        2.6521732021128046,
-        2.630396440815385,
-        2.602860350286428,
-        2.5696460593920065,
-        2.5364027376452056,
-        2.499446286796604,
-        2.4587748041127506,
-        2.414398437185221,
-        2.3699990328716107,
-        2.322373696229342,
-        2.271520771371253,
-        2.2174389328192197,
-        2.16337565384239,
-        2.1183028432496016,
-        2.082225099873648,
-        2.055100772005235,
-        2.0279625371819305,
-        2.0008103857988204,
-        1.9736443063300082,
-        1.9482128147680253,
-        1.9245345552113182,
-        1.9026104247588487,
-        1.8806927939516411,
-        1.862235672444246,
-        1.847275503201129,
-        1.835814081380705,
-        1.824381436842932,
-        1.8139629377087627,
-        1.8045606557581335,
-        1.7961751115773796,
-        1.7877868031023945,
-        1.7793941781790852,
-        1.7709972329654864,
-        1.7625959636196327,
-        1.7541903672600494,
-        1.7459181197626403,
-        1.737780757913635,
-        1.7297783508684146,
-        1.7217732861435076,
-        1.7137640932265894,
-        1.7057507692361864,
-        1.6918150918099673,
-        1.6719047669939942,
-        1.6460167077689267,
-        1.6201194134191075,
-        1.5986915141218316,
-        1.5817353179379183,
-        1.569199764184379,
-        1.5566577309558969,
-        1.545374152761467,
-        1.5353620432989845,
-        1.5266220576235803,
-        1.5178910621476225,
-        1.5097346239790443,
-        1.502153039909686,
-        1.495145456062699,
-        1.488134243479226,
-        1.48111939735681,
-        1.474100442252211,
-        1.4670307626366115,
-        1.4599103316162523,
-        1.45273959485914,
-        1.445565137158368,
-        1.4340878115214444,
-        1.418273806730323,
-        1.3981208704326855,
-        1.3779439775587023,
-        1.3598972673004606,
-        1.3439818461440451,
-        1.3301807335621048,
-        1.316383926863083,
-        1.3040618749785347,
-        1.2932153453410835,
-        1.2838336236692311,
-        1.2744470198196236,
-        1.2650555289898042,
-        1.2556591482982988,
-        1.2428104897182262,
-        1.2264996957264114,
-        1.2067249615595257,
-        1.1869318618366975,
-        1.1672278304018044,
-        1.1476135933863398,
-        1.1280891949729075,
-        1.108555289615659,
-        1.0895983485572227,
-        1.0712204022764056,
-        1.0534217504465226,
-        1.0356155337864215,
+        1.0,
         1.017807767853702,
-        1.0
+        1.0356155337864215,
+        1.0534217504465226,
+        1.0712204022764056,
+        1.0895983485572227,
+        1.108555289615659,
+        1.1280891949729075,
+        1.1476135933863398,
+        1.1672278304018044,
+        1.1869318618366975,
+        1.2067249615595257,
+        1.2264996957264114,
+        1.2428104897182262,
+        1.2556591482982988,
+        1.2650555289898042,
+        1.2744470198196236,
+        1.2838336236692311,
+        1.2932153453410835,
+        1.3040618749785347,
+        1.316383926863083,
+        1.3301807335621048,
+        1.3439818461440451,
+        1.3598972673004606,
+        1.3779439775587023,
+        1.3981208704326855,
+        1.418273806730323,
+        1.4340878115214444,
+        1.445565137158368,
+        1.45273959485914,
+        1.4599103316162523,
+        1.4670307626366115,
+        1.474100442252211,
+        1.48111939735681,
+        1.488134243479226,
+        1.495145456062699,
+        1.502153039909686,
+        1.5097346239790443,
+        1.5178910621476225,
+        1.5266220576235803,
+        1.5353620432989845,
+        1.545374152761467,
+        1.5566577309558969,
+        1.569199764184379,
+        1.5817353179379183,
+        1.5986915141218316,
+        1.6201194134191075,
+        1.6460167077689267,
+        1.6719047669939942,
+        1.6918150918099673,
+        1.7057507692361864,
+        1.7137640932265894,
+        1.7217732861435076,
+        1.7297783508684146,
+        1.737780757913635,
+        1.7459181197626403,
+        1.7541903672600494,
+        1.7625959636196327,
+        1.7709972329654864,
+        1.7793941781790852,
+        1.7877868031023945,
+        1.7961751115773796,
+        1.8045606557581335,
+        1.8139629377087627,
+        1.824381436842932,
+        1.835814081380705,
+        1.847275503201129,
+        1.862235672444246,
+        1.8806927939516411,
+        1.9026104247588487,
+        1.9245345552113182,
+        1.9482128147680253,
+        1.9736443063300082,
+        2.0008103857988204,
+        2.0279625371819305,
+        2.055100772005235,
+        2.082225099873648,
+        2.1183028432496016,
+        2.16337565384239,
+        2.2174389328192197,
+        2.271520771371253,
+        2.322373696229342,
+        2.3699990328716107,
+        2.414398437185221,
+        2.4587748041127506,
+        2.499446286796604,
+        2.5364027376452056,
+        2.5696460593920065,
+        2.602860350286428,
+        2.630396440815385,
+        2.6521732021128046,
+        2.6681935771243177,
+        2.6841217449620203,
+        2.6947834587664494,
+        2.705443819238505,
+        2.714526681131686
     ]
 }

gnpy/example-data/edfa_model/amplifier_models_description.rst

@@ -227,7 +227,7 @@ In an opensource and multi-vendor environnement, it is needed to support differe
     .. code-block:: json-object
 
         "Edfa":[{
-                "type_variety": "low_noise",
+                "type_variety": "openroadm_ila_low_noise",
                 "type_def": "openroadm",
                 "gain_flatmax": 27,
                 "gain_min": 12,

gnpy/example-data/eqpt_config.json

@@ -29,24 +29,40 @@
             "allowed_for_design": false           
             },
             {
-            "type_variety": "low_noise",
+            "type_variety": "openroadm_ila_low_noise",
             "type_def": "openroadm",
             "gain_flatmax": 27,
-            "gain_min": 12,
+            "gain_min": 0,
             "p_max": 22,
             "nf_coef": [-8.104e-4,-6.221e-2,-5.889e-1,37.62],
             "allowed_for_design": false
             },          
             {
-            "type_variety": "standard",
+            "type_variety": "openroadm_ila_standard",
             "type_def": "openroadm",
             "gain_flatmax": 27,
-            "gain_min": 12,
+            "gain_min": 0,
             "p_max": 22,
             "nf_coef": [-5.952e-4,-6.250e-2,-1.071,28.99],
             "allowed_for_design": false
             },
             {
+            "type_variety": "openroadm_mw_mw_preamp",
+            "type_def": "openroadm_preamp",
+            "gain_flatmax": 27,
+            "gain_min": 0,
+            "p_max": 22,
+            "allowed_for_design": false
+            },
+            {
+            "type_variety": "openroadm_mw_mw_booster",
+            "type_def": "openroadm_booster",
+            "gain_flatmax": 32,
+            "gain_min": 0,
+            "p_max": 22,
+            "allowed_for_design": false
+            },
+            {
             "type_variety": "std_high_gain",
             "type_def": "variable_gain",
             "gain_flatmax": 35,

gnpy/example-data/eqpt_config_openroadm.json

@@ -0,0 +1,190 @@
+{     "Edfa":[
+            {
+            "type_variety": "openroadm_ila_low_noise",
+            "type_def": "openroadm",
+            "gain_flatmax": 27,
+            "gain_min": 0,
+            "p_max": 22,
+            "nf_coef": [-8.104e-4,-6.221e-2,-5.889e-1,37.62],
+            "allowed_for_design": true
+            },
+            {
+            "type_variety": "openroadm_ila_standard",
+            "type_def": "openroadm",
+            "gain_flatmax": 27,
+            "gain_min": 0,
+            "p_max": 22,
+            "nf_coef": [-5.952e-4,-6.250e-2,-1.071,28.99],
+            "allowed_for_design": true
+            },
+		{
+            "type_variety": "openroadm_mw_mw_preamp",
+            "type_def": "openroadm_preamp",
+            "gain_flatmax": 27,
+            "gain_min": 0,
+            "p_max": 22,
+            "allowed_for_design": false
+            },
+		{
+            "type_variety": "openroadm_mw_mw_booster",
+            "type_def": "openroadm_booster",
+            "gain_flatmax": 32,
+            "gain_min": 0,
+            "p_max": 22,
+            "allowed_for_design": false
+            }
+      ],
+      "Fiber":[
+            {
+            "type_variety": "SSMF",
+            "dispersion": 1.67e-05,
+            "gamma": 0.00127,
+            "pmd_coef": 1.265e-15
+            },
+            {
+            "type_variety": "NZDF",
+            "dispersion": 0.5e-05,
+            "gamma": 0.00146,
+            "pmd_coef": 1.265e-15
+            },
+            {
+            "type_variety": "LOF",
+            "dispersion": 2.2e-05,
+            "gamma": 0.000843,
+            "pmd_coef": 1.265e-15
+            }
+      ],
+      "RamanFiber":[
+            {
+            "type_variety": "SSMF",
+            "dispersion": 1.67e-05,
+            "gamma": 0.00127,
+            "pmd_coef": 1.265e-15,
+            "raman_efficiency": {
+              "cr":[
+                  0, 9.4E-06, 2.92E-05, 4.88E-05, 6.82E-05, 8.31E-05, 9.4E-05, 0.0001014, 0.0001069, 0.0001119,
+                  0.0001217, 0.0001268, 0.0001365, 0.000149, 0.000165, 0.000181, 0.0001977, 0.0002192, 0.0002469,
+                  0.0002749, 0.0002999, 0.0003206, 0.0003405, 0.0003592, 0.000374, 0.0003826, 0.0003841, 0.0003826,
+                  0.0003802, 0.0003756, 0.0003549, 0.0003795, 0.000344, 0.0002933, 0.0002024, 0.0001158, 8.46E-05,
+                  7.14E-05, 6.86E-05, 8.5E-05, 8.93E-05, 9.01E-05, 8.15E-05, 6.67E-05, 4.37E-05, 3.28E-05, 2.96E-05,
+                  2.65E-05, 2.57E-05, 2.81E-05, 3.08E-05, 3.67E-05, 5.85E-05, 6.63E-05, 6.36E-05, 5.5E-05, 4.06E-05,
+                  2.77E-05, 2.42E-05, 1.87E-05, 1.6E-05, 1.4E-05, 1.13E-05, 1.05E-05, 9.8E-06, 9.8E-06, 1.13E-05,
+                  1.64E-05, 1.95E-05, 2.38E-05, 2.26E-05, 2.03E-05, 1.48E-05, 1.09E-05, 9.8E-06, 1.05E-05, 1.17E-05,
+                  1.25E-05, 1.21E-05, 1.09E-05, 9.8E-06, 8.2E-06, 6.6E-06, 4.7E-06, 2.7E-06, 1.9E-06, 1.2E-06, 4E-07,
+                  2E-07, 1E-07
+              ],
+              "frequency_offset":[
+                0, 0.5e12, 1e12, 1.5e12, 2e12, 2.5e12, 3e12, 3.5e12, 4e12, 4.5e12, 5e12, 5.5e12, 6e12, 6.5e12, 7e12,
+                7.5e12, 8e12, 8.5e12, 9e12, 9.5e12, 10e12, 10.5e12, 11e12, 11.5e12, 12e12, 12.5e12, 12.75e12,
+                13e12, 13.25e12, 13.5e12, 14e12, 14.5e12, 14.75e12, 15e12, 15.5e12, 16e12, 16.5e12, 17e12,
+                17.5e12, 18e12, 18.25e12, 18.5e12, 18.75e12, 19e12, 19.5e12, 20e12, 20.5e12, 21e12, 21.5e12,
+                22e12, 22.5e12, 23e12, 23.5e12, 24e12, 24.5e12, 25e12, 25.5e12, 26e12, 26.5e12, 27e12, 27.5e12, 28e12,
+                28.5e12, 29e12, 29.5e12, 30e12, 30.5e12, 31e12, 31.5e12, 32e12, 32.5e12, 33e12, 33.5e12, 34e12, 34.5e12,
+                35e12, 35.5e12, 36e12, 36.5e12, 37e12, 37.5e12, 38e12, 38.5e12, 39e12, 39.5e12, 40e12, 40.5e12, 41e12,
+                41.5e12, 42e12
+              ]
+              }
+            }
+      ],
+      "Span":[
+            {
+            "power_mode":true,
+            "delta_power_range_db": [0,0,0],
+            "max_fiber_lineic_loss_for_raman": 0.25,
+            "target_extended_gain": 0,
+            "max_length": 135,
+            "length_units": "km",
+            "max_loss": 28,
+            "padding": 11,
+            "EOL": 0,
+            "con_in": 0,
+            "con_out": 0
+            }
+      ],
+      "Roadm":[
+            {
+            "target_pch_out_db": -20,
+            "add_drop_osnr": 30,
+            "pmd": 0,
+            "restrictions": {
+                            "preamp_variety_list":["openroadm_mw_mw_preamp"],
+                            "booster_variety_list":["openroadm_mw_mw_booster"]
+                            }            
+            }
+      ],
+      "SI":[
+            {
+            "f_min": 191.3e12,
+            "baud_rate": 31.57e9,
+            "f_max":196.1e12,
+            "spacing": 50e9,
+            "power_dbm": 2,
+            "power_range_db": [0,0,1],
+            "roll_off": 0.15,
+            "tx_osnr": 35,
+            "sys_margins": 2
+            }
+      ],
+      "Transceiver":[
+		{
+            "type_variety": "OpenROADM MSA ver. 4.0",
+            "frequency":{
+                        "min": 191.35e12,
+                        "max": 196.1e12
+                        },
+            "mode":[
+                       {
+                       "format": "100 Gbit/s, 27.95 Gbaud, DP-QPSK",
+                       "baud_rate": 27.95e9,
+                       "OSNR": 17,
+                       "bit_rate": 100e9,
+                       "roll_off": null,
+                       "tx_osnr": 33,
+                       "min_spacing": 50e9,
+                       "cost":1
+                       },
+					   {
+                       "format": "100 Gbit/s, 31.57 Gbaud, DP-QPSK",
+                       "baud_rate": 31.57e9,
+                       "OSNR": 12,
+                       "bit_rate": 100e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 35,
+                       "min_spacing": 50e9,
+                       "cost":1
+                       },
+                       {
+                       "format": "200 Gbit/s, DP-QPSK",
+                       "baud_rate": 63.1e9,
+                       "OSNR": 17,
+                       "bit_rate": 200e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 36,
+                       "min_spacing": 87.5e9,
+                       "cost":1
+                       },
+                       {
+                       "format": "300 Gbit/s, DP-8QAM",
+                       "baud_rate": 63.1e9,
+                       "OSNR": 21,
+                       "bit_rate": 300e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 36,
+                       "min_spacing": 87.5e9,
+                       "cost":1
+                       },
+					   {
+                       "format": "400 Gbit/s, DP-16QAM",
+                       "baud_rate": 63.1e9,
+                       "OSNR": 24,
+                       "bit_rate": 400e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 36,
+                       "min_spacing": 87.5e9,
+                       "cost":1
+                       }
+                   ]
+            }
+      ]
+
+}

gnpy/example-data/meshTopologyExampleV2.json

@@ -624,6 +624,70 @@
         "con_out": null
       }
     },
+    {
+      "uid": "west edfa in Quimper",
+      "metadata": {
+        "location": {
+          "city": "Quimper",
+          "region": "RLD",
+          "latitude": 1.0,
+          "longitude": 1.0
+        }
+      },
+      "type": "Edfa",
+      "operational": {
+        "gain_target": null,
+        "tilt_target": 0
+      }
+    },
+    {
+      "uid": "west edfa in Ploermel",
+      "metadata": {
+        "location": {
+          "city": "Ploermel",
+          "region": "RLD",
+          "latitude": 1.0,
+          "longitude": 2.0
+        }
+      },
+      "type": "Edfa",
+      "operational": {
+        "gain_target": null,
+        "tilt_target": 0
+      }
+    },
+    {
+      "uid": "east edfa in Quimper",
+      "metadata": {
+        "location": {
+          "city": "Quimper",
+          "region": "RLD",
+          "latitude": 1.0,
+          "longitude": 1.0
+        }
+      },
+      "type": "Edfa",
+      "operational": {
+        "gain_target": null,
+        "tilt_target": 0
+      }
+    },
+    {
+      "uid": "east edfa in Ploermel",
+      "metadata": {
+        "location": {
+          "city": "Ploermel",
+          "region": "RLD",
+          "latitude": 1.0,
+          "longitude": 2.0
+        }
+      },
+      "type": "Edfa",
+      "operational": {
+        "gain_target": null,
+        "tilt_target": 0
+      }
+    },
     {
       "uid": "east edfa in Lannion_CAS to Corlay",
       "metadata": {
@@ -1190,18 +1254,34 @@
     },
     {
       "from_node": "fiber (Brest_KLA → Quimper)-",
+      "to_node": "west edfa in Quimper"
+    },
+    {
+      "from_node": "west edfa in Quimper",
       "to_node": "fiber (Quimper → Lorient_KMA)-"
     },
     {
       "from_node": "fiber (Lorient_KMA → Quimper)-",
+      "to_node": "east edfa in Quimper"
+    },
+    {
+      "from_node": "east edfa in Quimper",
       "to_node": "fiber (Quimper → Brest_KLA)-"
     },
     {
       "from_node": "fiber (Vannes_KBE → Ploermel)-",
+      "to_node": "west edfa in Ploermel"
+    },
+    {
+      "from_node": "west edfa in Ploermel",
       "to_node": "fiber (Ploermel → Rennes_STA)-"
     },
     {
       "from_node": "fiber (Rennes_STA → Ploermel)-",
+      "to_node": "east edfa in Ploermel"
+    },
+    {
+      "from_node": "east edfa in Ploermel",
       "to_node": "fiber (Ploermel → Vannes_KBE)-"
     },
     {

gnpy/example-data/std_medium_gain_advanced_config.json

@@ -1,303 +1,304 @@
-{     "nf_fit_coeff": [
-      0.000168241,
-      0.0469961,
-      0.0359549,
-      5.82851
-      ],
-      "f_min": 191.35e12,
-      "f_max": 196.1e12,
-      "nf_ripple": [
-      -0.3110761646066259,
-      -0.3110761646066259,
-      -0.31110274831665313,
-      -0.31419329378173544,
-      -0.3172854168606314,
-      -0.32037911876162584,
-      -0.3233255190215882,
-      -0.31624321721895354,
-      -0.30915729645781326,
-      -0.30206775396360075,
-      -0.2949045115165272,
-      -0.26632156113294336,
-      -0.23772399031437283,
-      -0.20911178784023846,
-      -0.18048410390821285,
-      -0.14379944379052215,
-      -0.10709599992470213,
-      -0.07037375788020579,
-      -0.03372858157230583,
-      -0.015660302006048,
-      0.0024172385953583004,
-      0.020504047353947653,
-      0.03860013139908377,
-      0.05670549786742816,
-      0.07482015390297145,
-      0.0838762040768461,
-      0.09284481475528361,
-      0.1018180306253394,
-      0.11079585523492333,
-      0.1020395478432815,
-      0.09310160456603413,
-      0.08415906712621996,
-      0.07521193198077789,
-      0.0676340601339394,
-      0.06005437964543287,
-      0.052470799141237305,
-      0.044883315610536455,
-      0.037679759069084225,
-      0.03047647598902483,
-      0.02326948274513522,
-      0.01605877647020772,
-      0.021248462316134083,
-      0.02657315875107553,
-      0.03190060058247842,
-      0.03723078993416436,
-      0.04256372893215024,
-      0.047899419704645264,
-      0.03915515813685565,
-      0.030289222542492025,
-      0.021418708618354456,
-      0.012573926129294415,
-      0.006240488799898697,
-      -9.622162373026585e-05,
-      -0.006436207679519103,
-      -0.012779471908040341,
-      -0.02038153550619876,
-      -0.027999803010447587,
-      -0.035622012697103154,
-      -0.043236398934156144,
-      -0.04493583574805963,
-      -0.04663615264317309,
-      -0.048337350303318156,
-      -0.050039429413028365,
-      -0.051742390657545205,
-      -0.05342028484370278,
-      -0.05254242298580185,
-      -0.05166410580536087,
-      -0.05078533294804249,
-      -0.04990610405914272,
-      -0.05409792133358102,
-      -0.05832916277634124,
-      -0.06256260169582961,
-      -0.06660356886269536,
-      -0.04779792991567815,
-      -0.028982516728038848,
-      -0.010157321677553965,
-      0.00861320615127981,
-      0.01913736978785662,
-      0.029667009055877668,
-      0.04020212822983975,
-      0.050742731588695494,
-      0.061288823415841555,
-      0.07184040799914815,
-      0.1043252636301016,
-      0.13687829834471027,
-      0.1694483010211072,
-      0.202035284929368,
-      0.23624619427167134,
-      0.27048596623174515,
-      0.30474360397422756,
-      0.3390191214858807,
-      0.36358851509924695,
-      0.38814205928193013,
-      0.41270842850729195,
-      0.4372876328262819,
-      0.4372876328262819
-      ],
-      "dgt": [
-      2.714526681131686,
-      2.705443819238505,
-      2.6947834587664494,
-      2.6841217449620203,
-      2.6681935771243177,
-      2.6521732021128046,
-      2.630396440815385,
-      2.602860350286428,
-      2.5696460593920065,
-      2.5364027376452056,
-      2.499446286796604,
-      2.4587748041127506,
-      2.414398437185221,
-      2.3699990328716107,
-      2.322373696229342,
-      2.271520771371253,
-      2.2174389328192197,
-      2.16337565384239,
-      2.1183028432496016,
-      2.082225099873648,
-      2.055100772005235,
-      2.0279625371819305,
-      2.0008103857988204,
-      1.9736443063300082,
-      1.9482128147680253,
-      1.9245345552113182,
-      1.9026104247588487,
-      1.8806927939516411,
-      1.862235672444246,
-      1.847275503201129,
-      1.835814081380705,
-      1.824381436842932,
-      1.8139629377087627,
-      1.8045606557581335,
-      1.7961751115773796,
-      1.7877868031023945,
-      1.7793941781790852,
-      1.7709972329654864,
-      1.7625959636196327,
-      1.7541903672600494,
-      1.7459181197626403,
-      1.737780757913635,
-      1.7297783508684146,
-      1.7217732861435076,
-      1.7137640932265894,
-      1.7057507692361864,
-      1.6918150918099673,
-      1.6719047669939942,
-      1.6460167077689267,
-      1.6201194134191075,
-      1.5986915141218316,
-      1.5817353179379183,
-      1.569199764184379,
-      1.5566577309558969,
-      1.545374152761467,
-      1.5353620432989845,
-      1.5266220576235803,
-      1.5178910621476225,
-      1.5097346239790443,
-      1.502153039909686,
-      1.495145456062699,
-      1.488134243479226,
-      1.48111939735681,
-      1.474100442252211,
-      1.4670307626366115,
-      1.4599103316162523,
-      1.45273959485914,
-      1.445565137158368,
-      1.4340878115214444,
-      1.418273806730323,
-      1.3981208704326855,
-      1.3779439775587023,
-      1.3598972673004606,
-      1.3439818461440451,
-      1.3301807335621048,
-      1.316383926863083,
-      1.3040618749785347,
-      1.2932153453410835,
-      1.2838336236692311,
-      1.2744470198196236,
-      1.2650555289898042,
-      1.2556591482982988,
-      1.2428104897182262,
-      1.2264996957264114,
-      1.2067249615595257,
-      1.1869318618366975,
-      1.1672278304018044,
-      1.1476135933863398,
-      1.1280891949729075,
-      1.108555289615659,
-      1.0895983485572227,
-      1.0712204022764056,
-      1.0534217504465226,
-      1.0356155337864215,
-      1.017807767853702,
-      1.0
-      ],
-      "gain_ripple": [
-      0.1359703369791596,
-      0.11822862697916037,
-      0.09542181697916163,
-      0.06245819697916133,
-      0.02602813697916062,
-      -0.0036199830208403228,
-      -0.018326963020840026,
-      -0.0246928330208398,
-      -0.016792253020838643,
-      -0.0028138630208403015,
-      0.017572956979162058,
-      0.038328296979159404,
-      0.054956336979159914,
-      0.0670723869791594,
-      0.07091459697916136,
-      0.07094413697916124,
-      0.07114372697916238,
-      0.07533675697916209,
-      0.08731066697916035,
-      0.10313984697916112,
-      0.12276252697916235,
-      0.14239527697916188,
-      0.15945681697916214,
-      0.1739275269791598,
-      0.1767381569791624,
-      0.17037189697916233,
-      0.15216302697916007,
-      0.13114358697916018,
-      0.10802383697916085,
-      0.08548825697916129,
-      0.06916723697916183,
-      0.05848224697916038,
-      0.05447361697916264,
-      0.05154489697916276,
-      0.04946107697915991,
-      0.04717897697916129,
-      0.04551704697916037,
-      0.04467697697916151,
-      0.04072968697916224,
-      0.03285456697916089,
-      0.023488786979161347,
-      0.01659282697915998,
-      0.013321846979160057,
-      0.011234826979162449,
-      0.01030063697916006,
-      0.00936596697916059,
-      0.00874012697916271,
-      0.00842583697916055,
-      0.006965146979162284,
-      0.0040435869791615175,
-      0.0007104669791608842,
-      -0.0015763130208377163,
-      -0.006936193020838033,
-      -0.016475303020840215,
-      -0.028748483020837767,
-      -0.039618433020837784,
-      -0.051112303020840244,
-      -0.06468462302083822,
-      -0.07868024302083754,
-      -0.09101254302083817,
-      -0.10103437302083762,
-      -0.11041488302083735,
-      -0.11916081302083725,
-      -0.12789859302083784,
-      -0.1353792530208402,
-      -0.14160178302083892,
-      -0.1455411330208385,
-      -0.1484450830208388,
-      -0.14823350302084037,
-      -0.14591937302083835,
-      -0.1409032730208395,
-      -0.13525493302083902,
-      -0.1279646530208396,
-      -0.11963431302083904,
-      -0.11089282302084058,
-      -0.1027863830208382,
-      -0.09717347302083823,
-      -0.09343261302083761,
-      -0.0913487130208388,
-      -0.08906007302083907,
-      -0.0865687230208394,
-      -0.08407607302083875,
-      -0.07844600302084004,
-      -0.06968090302083851,
-      -0.05947139302083926,
-      -0.05095282302083959,
-      -0.042428283020839785,
-      -0.03218106302083967,
-      -0.01819858302084043,
-      -0.0021726530208390216,
-      0.01393231697916164,
-      0.028098946979159933,
-      0.040326236979161934,
-      0.05257029697916238,
-      0.06479749697916048,
-      0.07704745697916238
-      ]
-}
+{
+    "nf_fit_coeff": [
+        0.000168241,
+        0.0469961,
+        0.0359549,
+        5.82851
+    ],
+    "f_min": 191.35e12,
+    "f_max": 196.1e12,
+    "nf_ripple": [
+        0.4372876328262819,
+        0.4372876328262819,
+        0.41270842850729195,
+        0.38814205928193013,
+        0.36358851509924695,
+        0.3390191214858807,
+        0.30474360397422756,
+        0.27048596623174515,
+        0.23624619427167134,
+        0.202035284929368,
+        0.1694483010211072,
+        0.13687829834471027,
+        0.1043252636301016,
+        0.07184040799914815,
+        0.061288823415841555,
+        0.050742731588695494,
+        0.04020212822983975,
+        0.029667009055877668,
+        0.01913736978785662,
+        0.00861320615127981,
+        -0.010157321677553965,
+        -0.028982516728038848,
+        -0.04779792991567815,
+        -0.06660356886269536,
+        -0.06256260169582961,
+        -0.05832916277634124,
+        -0.05409792133358102,
+        -0.04990610405914272,
+        -0.05078533294804249,
+        -0.05166410580536087,
+        -0.05254242298580185,
+        -0.05342028484370278,
+        -0.051742390657545205,
+        -0.050039429413028365,
+        -0.048337350303318156,
+        -0.04663615264317309,
+        -0.04493583574805963,
+        -0.043236398934156144,
+        -0.035622012697103154,
+        -0.027999803010447587,
+        -0.02038153550619876,
+        -0.012779471908040341,
+        -0.006436207679519103,
+        -9.622162373026585e-05,
+        0.006240488799898697,
+        0.012573926129294415,
+        0.021418708618354456,
+        0.030289222542492025,
+        0.03915515813685565,
+        0.047899419704645264,
+        0.04256372893215024,
+        0.03723078993416436,
+        0.03190060058247842,
+        0.02657315875107553,
+        0.021248462316134083,
+        0.01605877647020772,
+        0.02326948274513522,
+        0.03047647598902483,
+        0.037679759069084225,
+        0.044883315610536455,
+        0.052470799141237305,
+        0.06005437964543287,
+        0.0676340601339394,
+        0.07521193198077789,
+        0.08415906712621996,
+        0.09310160456603413,
+        0.1020395478432815,
+        0.11079585523492333,
+        0.1018180306253394,
+        0.09284481475528361,
+        0.0838762040768461,
+        0.07482015390297145,
+        0.05670549786742816,
+        0.03860013139908377,
+        0.020504047353947653,
+        0.0024172385953583004,
+        -0.015660302006048,
+        -0.03372858157230583,
+        -0.07037375788020579,
+        -0.10709599992470213,
+        -0.14379944379052215,
+        -0.18048410390821285,
+        -0.20911178784023846,
+        -0.23772399031437283,
+        -0.26632156113294336,
+        -0.2949045115165272,
+        -0.30206775396360075,
+        -0.30915729645781326,
+        -0.31624321721895354,
+        -0.3233255190215882,
+        -0.32037911876162584,
+        -0.3172854168606314,
+        -0.31419329378173544,
+        -0.31110274831665313,
+        -0.3110761646066259,
+        -0.3110761646066259
+    ],
+    "dgt": [
+        1.0,
+        1.017807767853702,
+        1.0356155337864215,
+        1.0534217504465226,
+        1.0712204022764056,
+        1.0895983485572227,
+        1.108555289615659,
+        1.1280891949729075,
+        1.1476135933863398,
+        1.1672278304018044,
+        1.1869318618366975,
+        1.2067249615595257,
+        1.2264996957264114,
+        1.2428104897182262,
+        1.2556591482982988,
+        1.2650555289898042,
+        1.2744470198196236,
+        1.2838336236692311,
+        1.2932153453410835,
+        1.3040618749785347,
+        1.316383926863083,
+        1.3301807335621048,
+        1.3439818461440451,
+        1.3598972673004606,
+        1.3779439775587023,
+        1.3981208704326855,
+        1.418273806730323,
+        1.4340878115214444,
+        1.445565137158368,
+        1.45273959485914,
+        1.4599103316162523,
+        1.4670307626366115,
+        1.474100442252211,
+        1.48111939735681,
+        1.488134243479226,
+        1.495145456062699,
+        1.502153039909686,
+        1.5097346239790443,
+        1.5178910621476225,
+        1.5266220576235803,
+        1.5353620432989845,
+        1.545374152761467,
+        1.5566577309558969,
+        1.569199764184379,
+        1.5817353179379183,
+        1.5986915141218316,
+        1.6201194134191075,
+        1.6460167077689267,
+        1.6719047669939942,
+        1.6918150918099673,
+        1.7057507692361864,
+        1.7137640932265894,
+        1.7217732861435076,
+        1.7297783508684146,
+        1.737780757913635,
+        1.7459181197626403,
+        1.7541903672600494,
+        1.7625959636196327,
+        1.7709972329654864,
+        1.7793941781790852,
+        1.7877868031023945,
+        1.7961751115773796,
+        1.8045606557581335,
+        1.8139629377087627,
+        1.824381436842932,
+        1.835814081380705,
+        1.847275503201129,
+        1.862235672444246,
+        1.8806927939516411,
+        1.9026104247588487,
+        1.9245345552113182,
+        1.9482128147680253,
+        1.9736443063300082,
+        2.0008103857988204,
+        2.0279625371819305,
+        2.055100772005235,
+        2.082225099873648,
+        2.1183028432496016,
+        2.16337565384239,
+        2.2174389328192197,
+        2.271520771371253,
+        2.322373696229342,
+        2.3699990328716107,
+        2.414398437185221,
+        2.4587748041127506,
+        2.499446286796604,
+        2.5364027376452056,
+        2.5696460593920065,
+        2.602860350286428,
+        2.630396440815385,
+        2.6521732021128046,
+        2.6681935771243177,
+        2.6841217449620203,
+        2.6947834587664494,
+        2.705443819238505,
+        2.714526681131686
+    ],
+    "gain_ripple": [
+        0.07704745697916238,
+        0.06479749697916048,
+        0.05257029697916238,
+        0.040326236979161934,
+        0.028098946979159933,
+        0.01393231697916164,
+        -0.0021726530208390216,
+        -0.01819858302084043,
+        -0.03218106302083967,
+        -0.042428283020839785,
+        -0.05095282302083959,
+        -0.05947139302083926,
+        -0.06968090302083851,
+        -0.07844600302084004,
+        -0.08407607302083875,
+        -0.0865687230208394,
+        -0.08906007302083907,
+        -0.0913487130208388,
+        -0.09343261302083761,
+        -0.09717347302083823,
+        -0.1027863830208382,
+        -0.11089282302084058,
+        -0.11963431302083904,
+        -0.1279646530208396,
+        -0.13525493302083902,
+        -0.1409032730208395,
+        -0.14591937302083835,
+        -0.14823350302084037,
+        -0.1484450830208388,
+        -0.1455411330208385,
+        -0.14160178302083892,
+        -0.1353792530208402,
+        -0.12789859302083784,
+        -0.11916081302083725,
+        -0.11041488302083735,
+        -0.10103437302083762,
+        -0.09101254302083817,
+        -0.07868024302083754,
+        -0.06468462302083822,
+        -0.051112303020840244,
+        -0.039618433020837784,
+        -0.028748483020837767,
+        -0.016475303020840215,
+        -0.006936193020838033,
+        -0.0015763130208377163,
+        0.0007104669791608842,
+        0.0040435869791615175,
+        0.006965146979162284,
+        0.00842583697916055,
+        0.00874012697916271,
+        0.00936596697916059,
+        0.01030063697916006,
+        0.011234826979162449,
+        0.013321846979160057,
+        0.01659282697915998,
+        0.023488786979161347,
+        0.03285456697916089,
+        0.04072968697916224,
+        0.04467697697916151,
+        0.04551704697916037,
+        0.04717897697916129,
+        0.04946107697915991,
+        0.05154489697916276,
+        0.05447361697916264,
+        0.05848224697916038,
+        0.06916723697916183,
+        0.08548825697916129,
+        0.10802383697916085,
+        0.13114358697916018,
+        0.15216302697916007,
+        0.17037189697916233,
+        0.1767381569791624,
+        0.1739275269791598,
+        0.15945681697916214,
+        0.14239527697916188,
+        0.12276252697916235,
+        0.10313984697916112,
+        0.08731066697916035,
+        0.07533675697916209,
+        0.07114372697916238,
+        0.07094413697916124,
+        0.07091459697916136,
+        0.0670723869791594,
+        0.054956336979159914,
+        0.038328296979159404,
+        0.017572956979162058,
+        -0.0028138630208403015,
+        -0.016792253020838643,
+        -0.0246928330208398,
+        -0.018326963020840026,
+        -0.0036199830208403228,
+        0.02602813697916062,
+        0.06245819697916133,
+        0.09542181697916163,
+        0.11822862697916037,
+        0.1359703369791596
+    ]
+}

gnpy/tools/cli_examples.py

@@ -9,7 +9,6 @@ Common code for CLI examples
 '''
 
 import argparse
-from json import dumps
 import logging
 import os.path
 import sys
@@ -72,12 +71,12 @@ def load_common_data(equipment_filename, topology_filename, simulation_filename,
     except exceptions.NetworkTopologyError as e:
         print(f'{ansi_escapes.red}Invalid network definition:{ansi_escapes.reset} {e}')
         sys.exit(1)
-    except exceptions.ConfigurationError as e:
-        print(f'{ansi_escapes.red}Configuration error:{ansi_escapes.reset} {e}')
-        sys.exit(1)
     except exceptions.ParametersError as e:
         print(f'{ansi_escapes.red}Simulation parameters error:{ansi_escapes.reset} {e}')
         sys.exit(1)
+    except exceptions.ConfigurationError as e:
+        print(f'{ansi_escapes.red}Configuration error:{ansi_escapes.reset} {e}')
+        sys.exit(1)
     except exceptions.ServiceError as e:
         print(f'{ansi_escapes.red}Service error:{ansi_escapes.reset} {e}')
         sys.exit(1)
@@ -113,7 +112,7 @@ def transmission_main_example(args=None):
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
         )
     _add_common_options(parser, network_default=_examples_dir / 'edfa_example_network.json')
-    parser.add_argument('--show-channels', action='store_true', help='Show final per-channel OSNR summary')
+    parser.add_argument('--show-channels', action='store_true', help='Show final per-channel OSNR and GSNR summary')
     parser.add_argument('-pl', '--plot', action='store_true')
     parser.add_argument('-l', '--list-nodes', action='store_true', help='list all transceiver nodes')
     parser.add_argument('-po', '--power', default=0, help='channel ref power in dBm')
@@ -240,7 +239,7 @@ def transmission_main_example(args=None):
                 print(f'\nTransmission result for input power = {lin2db(req.power*1e3):.2f} dBm:')
             else:
                 print(f'\nTransmission results:')
-            print(f'  Final SNR total (0.1 nm): {ansi_escapes.cyan}{mean(destination.snr_01nm):.02f} dB{ansi_escapes.reset}')
+            print(f'  Final GSNR (0.1 nm): {ansi_escapes.cyan}{mean(destination.snr_01nm):.02f} dB{ansi_escapes.reset}')
         else:
             print(path[-1])
 
@@ -249,7 +248,7 @@ def transmission_main_example(args=None):
         print(f'{ansi_escapes.blue}Network (after autodesign) saved to {args.save_network}{ansi_escapes.reset}')
 
     if args.show_channels:
-        print('\nThe total SNR per channel at the end of the line is:')
+        print('\nThe GSNR per channel at the end of the line is:')
         print(
             '{:>5}{:>26}{:>26}{:>28}{:>28}{:>28}' .format(
                 'Ch. #',
@@ -257,7 +256,7 @@ def transmission_main_example(args=None):
                 'Channel power (dBm)',
                 'OSNR ASE (signal bw, dB)',
                 'SNR NLI (signal bw, dB)',
-                'SNR total (signal bw, dB)'))
+                'GSNR (signal bw, dB)'))
         for final_carrier, ch_osnr, ch_snr_nl, ch_snr in zip(
                 infos.carriers, path[-1].osnr_ase, path[-1].osnr_nli, path[-1].snr):
             ch_freq = final_carrier.frequency * 1e-12
@@ -384,7 +383,7 @@ def path_requests_run(args=None):
     pth_assign_spectrum(pths, rqs, oms_list, reversed_pths)
 
     print(f'{ansi_escapes.blue}Result summary{ansi_escapes.reset}')
-    header = ['req id', '  demand', '  snr@bandwidth A-Z (Z-A)', '  snr@0.1nm A-Z (Z-A)',
+    header = ['req id', '  demand', ' GSNR@bandwidth A-Z (Z-A)', ' GSNR@0.1nm A-Z (Z-A)',
               '  Receiver minOSNR', '  mode', '  Gbit/s', '  nb of tsp pairs',
               'N,M or blocking reason']
     data = []
@@ -423,7 +422,7 @@ def path_requests_run(args=None):
         secondcol = ''.join(row[1].ljust(secondcol_width))
         remainingcols = ''.join(word.center(col_width, ' ') for word in row[2:])
         print(f'{firstcol} {secondcol} {remainingcols}')
-    print(f'{ansi_escapes.yellow}Result summary shows mean SNR and OSNR (average over all channels){ansi_escapes.reset}')
+    print(f'{ansi_escapes.yellow}Result summary shows mean GSNR and OSNR (average over all channels){ansi_escapes.reset}')
 
     if args.output:
         result = []

gnpy/tools/convert.py

@@ -225,6 +225,8 @@ def sanity_check(nodes, links, nodes_by_city, links_by_city, eqpts_by_city):
                 duplicate_links.append(l1)
     for l in duplicate_links:
         links.remove(l)
+        links_by_city[l.from_city].remove(l)
+        links_by_city[l.to_city].remove(l)
 
     unreferenced_nodes = [n for n in nodes_by_city if n not in links_by_city]
     if unreferenced_nodes:
@@ -423,10 +425,27 @@ def xls_to_json_data(input_filename, filter_region=[]):
               'params': {'length': round(x.west_distance, 3),
                          'length_units': x.distance_units,
                          'loss_coef': x.west_lineic,
-                         'con_in':x.west_con_in,
-                         'con_out':x.west_con_out}
-            } # missing ILA construction
-              for x in links] +
+                         'con_in': x.west_con_in,
+                         'con_out': x.west_con_out}
+              } for x in links] +
+            [{'uid': f'west edfa in {x.city}',
+              'metadata': {'location': {'city': x.city,
+                                        'region': x.region,
+                                        'latitude': x.latitude,
+                                        'longitude': x.longitude}},
+              'type': 'Edfa',
+              'operational': {'gain_target': None,
+                              'tilt_target': 0}
+              } for x in nodes_by_city.values() if x.node_type.lower() == 'ila' and x.city not in eqpts_by_city] +
+            [{'uid': f'east edfa in {x.city}',
+              'metadata': {'location': {'city': x.city,
+                                        'region': x.region,
+                                        'latitude': x.latitude,
+                                        'longitude': x.longitude}},
+              'type': 'Edfa',
+              'operational': {'gain_target': None,
+                              'tilt_target': 0}
+              } for x in nodes_by_city.values() if x.node_type.lower() == 'ila' and x.city not in eqpts_by_city] +
             [create_east_eqpt_element(e) for e in eqpts] +
             [create_west_eqpt_element(e) for e in eqpts],
         'connections':
@@ -675,8 +694,6 @@ def connect_eqpt(from_, in_, to_):
 
 def eqpt_in_city_to_city(in_city, to_city, direction='east'):
     rev_direction = 'west' if direction == 'east' else 'east'
-    amp_direction = f'{direction}_amp_type'
-    amp_rev_direction = f'{rev_direction}_amp_type'
     return_eqpt = ''
     if in_city in eqpts_by_city:
         for e in eqpts_by_city[in_city]:
@@ -686,8 +703,9 @@ def eqpt_in_city_to_city(in_city, to_city, direction='east'):
             elif nodes_by_city[in_city].node_type.lower() == 'ila':
                 if e.to_city != to_city:
                     direction = rev_direction
-                    amp_direction = amp_rev_direction
                 return_eqpt = f'{direction} edfa in {e.from_city} to {e.to_city}'
+    elif nodes_by_city[in_city].node_type.lower() == 'ila':
+        return_eqpt = f'{direction} edfa in {in_city}'
     if nodes_by_city[in_city].node_type.lower() == 'fused':
         return_eqpt = f'{direction} fused spans in {in_city}'
     return return_eqpt

gnpy/tools/json_io.py

@@ -21,15 +21,14 @@ from gnpy.core.utils import automatic_nch, automatic_fmax, merge_amplifier_restr
 from gnpy.topology.request import PathRequest, Disjunction
 from gnpy.tools.convert import xls_to_json_data
 from gnpy.tools.service_sheet import read_service_sheet
-import time
 
 
 _logger = getLogger(__name__)
 
 
-Model_vg = namedtuple('Model_vg', 'nf1 nf2 delta_p')
+Model_vg = namedtuple('Model_vg', 'nf1 nf2 delta_p orig_nf_min orig_nf_max')
 Model_fg = namedtuple('Model_fg', 'nf0')
-Model_openroadm = namedtuple('Model_openroadm', 'nf_coef')
+Model_openroadm_ila = namedtuple('Model_openroadm_ila', 'nf_coef')
 Model_hybrid = namedtuple('Model_hybrid', 'nf_ram gain_ram edfa_variety')
 Model_dual_stage = namedtuple('Model_dual_stage', 'preamp_variety booster_variety')
 
@@ -44,7 +43,6 @@ class _JsonThing:
                       f'\n WARNING missing {k} attribute in eqpt_config.json[{name}]' +
                       f'\n default value is {k} = {v}' +
                       ansi_escapes.reset)
-                time.sleep(1)
 
 
 class SI(_JsonThing):
@@ -196,13 +194,15 @@ class Amp(_JsonThing):
             except KeyError:
                 pass  # nf0 is not needed for variable gain amp
             nf1, nf2, delta_p = estimate_nf_model(type_variety, gain_min, gain_max, nf_min, nf_max)
-            nf_def = Model_vg(nf1, nf2, delta_p)
+            nf_def = Model_vg(nf1, nf2, delta_p, nf_min, nf_max)
         elif type_def == 'openroadm':
             try:
                 nf_coef = kwargs.pop('nf_coef')
             except KeyError:  # nf_coef is expected for openroadm amp
                 raise EquipmentConfigError(f'missing nf_coef input for amplifier: {type_variety} in equipment config')
-            nf_def = Model_openroadm(nf_coef)
+            nf_def = Model_openroadm_ila(nf_coef)
+        elif type_def in ('openroadm_preamp', 'openroadm_booster'):
+            pass  # no extra parameters needed
         elif type_def == 'dual_stage':
             try:  # nf_ram and gain_ram are expected for a hybrid amp
                 preamp_variety = kwargs.pop('preamp_variety')
@@ -532,10 +532,9 @@ def convert_service_sheet(
         network,
         network_filename=None,
         output_filename='',
-        bidir=False,
-        filter_region=None):
+        bidir=False):
     if output_filename == '':
         output_filename = f'{str(input_filename)[0:len(str(input_filename))-len(str(input_filename.suffixes[0]))]}_services.json'
-    data = read_service_sheet(input_filename, eqpt, network, network_filename, bidir, filter_region)
+    data = read_service_sheet(input_filename, eqpt, network, network_filename, bidir)
     save_json(data, output_filename)
     return data

gnpy/tools/plots.py

@@ -5,11 +5,11 @@
 gnpy.tools.plots
 ================
 
-Graphs and plots usable form a CLI application
+Graphs and plots usable from a CLI application
 '''
 
 from matplotlib.pyplot import show, axis, figure, title, text
-from networkx import draw_networkx_nodes, draw_networkx_edges, draw_networkx_labels
+from networkx import draw_networkx
 from gnpy.core.elements import Transceiver
 
 
@@ -18,21 +18,10 @@ def _try_city(node):
 
 
 def plot_baseline(network):
-    edges = set(network.edges())
     pos = {n: (n.lng, n.lat) for n in network.nodes()}
     labels = {n: _try_city(n) for n in network.nodes() if isinstance(n, Transceiver)}
-    city_labels = set(labels.values())
-    for n in network.nodes():
-        if n.location.city and n.location.city not in city_labels:
-            labels[n] = n.location.city
-            city_labels.add(n.location.city)
-    label_pos = pos
-
-    fig = figure()
-    kwargs = {'figure': fig, 'pos': pos}
-    plot = draw_networkx_nodes(network, nodelist=network.nodes(), node_color='#ababab', **kwargs)
-    draw_networkx_edges(network, edgelist=edges, edge_color='#ababab', **kwargs)
-    draw_networkx_labels(network, labels=labels, font_size=14, **{**kwargs, 'pos': label_pos})
+    draw_networkx(network, pos=pos, node_size=50, node_color='#ababab', edge_color='#ababab',
+                  labels=labels, font_size=14)
     axis('off')
     show()
 
@@ -40,27 +29,21 @@ def plot_baseline(network):
 def plot_results(network, path, source, destination):
     path_edges = set(zip(path[:-1], path[1:]))
     edges = set(network.edges()) - path_edges
+    nodes = [n for n in network.nodes() if n not in path]
     pos = {n: (n.lng, n.lat) for n in network.nodes()}
-    nodes = {}
+    nodes_by_pos = {}
     for k, (x, y) in pos.items():
-        nodes.setdefault((round(x, 1), round(y, 1)), []).append(k)
+        nodes_by_pos.setdefault((round(x, 1), round(y, 1)), []).append(k)
 
     labels = {n: _try_city(n) for n in network.nodes() if isinstance(n, Transceiver)}
-    city_labels = set(labels.values())
-    for n in network.nodes():
-        if n.location.city and n.location.city not in city_labels:
-            labels[n] = n.location.city
-            city_labels.add(n.location.city)
-    label_pos = pos
 
     fig = figure()
-    kwargs = {'figure': fig, 'pos': pos}
-    all_nodes = [n for n in network.nodes() if n not in path]
-    plot = draw_networkx_nodes(network, nodelist=all_nodes, node_color='#ababab', node_size=50, **kwargs)
-    draw_networkx_nodes(network, nodelist=path, node_color='#ff0000', node_size=55, **kwargs)
-    draw_networkx_edges(network, edgelist=edges, edge_color='#ababab', **kwargs)
-    draw_networkx_edges(network, edgelist=path_edges, edge_color='#ff0000', **kwargs)
-    draw_networkx_labels(network, labels=labels, font_size=14, **{**kwargs, 'pos': label_pos})
+    draw_networkx(network, pos=pos, labels=labels, font_size=14,
+                  nodelist=nodes, node_color='#ababab', node_size=50,
+                  edgelist=edges, edge_color='#ababab')
+    draw_networkx(network, pos=pos, with_labels=False,
+                  nodelist=path, node_color='#ff0000', node_size=55,
+                  edgelist=path_edges, edge_color='#ff0000')
     title(f'Propagating from {_try_city(source)} to {_try_city(destination)}')
     axis('off')
 
@@ -70,7 +53,7 @@ def plot_results(network, path, source, destination):
                    bbox={'boxstyle': 'round', 'facecolor': 'wheat', 'alpha': 0.5})
 
     msgs = {(x, y): heading + '\n\n'.join(str(n) for n in ns if n in path)
-            for (x, y), ns in nodes.items()}
+            for (x, y), ns in nodes_by_pos.items()}
 
     def hover(event):
         if event.xdata is None or event.ydata is None:

gnpy/tools/service_sheet.py

@@ -178,12 +178,9 @@ def read_service_sheet(
         eqpt,
         network,
         network_filename=None,
-        bidir=False,
-        filter_region=None):
+        bidir=False):
     """ converts a service sheet into a json structure
     """
-    if filter_region is None:
-        filter_region = []
     if network_filename is None:
         network_filename = input_filename
     service = parse_excel(input_filename)

gnpy/topology/request.py

@@ -1133,9 +1133,8 @@ def compute_path_with_disjunction(network, equipment, pathreqlist, pathlist):
 
             # reversed path is needed for correct spectrum assignment
             reversed_path = find_reversed_path(pathlist[i])
-            if pathreq.bidir:
-                # only propagate if bidir is true, but needs the reversed path anyway for
-                # correct spectrum assignment
+            if pathreq.bidir and pathreq.baud_rate is not None:
+                # Both directions requested, and a feasible mode was found
                 rev_p = deepcopy(reversed_path)
 
                 print(f'\n\tPropagating Z to A direction {pathreq.destination} to {pathreq.source}')

json_structure_description.rst

@@ -141,7 +141,7 @@ location is in **gnpy-transmission-example** folder:
 .. code-block:: json-object
 
     "Edfa":[{
-            "type_variety": "low_noise",
+            "type_variety": "openroadm_ila_low_noise",
             "type_def": "openroadm",
             "gain_flatmax": 27,
             "gain_min": 12,

requirements.txt

@@ -1,12 +1,7 @@
-alabaster>=0.7.12,<1
-docutils==0.15.2
 matplotlib>=3.3.3,<4
 networkx>=2.5,<3
 numpy>=1.19.4,<2
 pandas>=1.1.5,<2
 pbr>=5.5.1,<6
-Pygments>=2.7.4,<3
 scipy>=1.5.4,<2
-Sphinx>=3.5.0,<4
-sphinxcontrib-bibtex>=0.4.2,<1
 xlrd>=1.2.0,<2

setup.cfg

@@ -1,8 +1,7 @@
 [metadata]
 name = gnpy
-description = Route planning and optimization tool for mesh optical networks
-description-file = README.rst
-description-content-type = text/x-rst; charset=UTF-8
+description-file = README.md
+description-content-type = text/markdown; variant=GFM
 author = Telecom Infra Project
 author-email = jan.kundrat@telecominfraproject.com
 license = BSD-3-Clause
@@ -23,6 +22,7 @@ classifier =
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
     Programming Language :: Python :: Implementation :: CPython
     Topic :: Scientific/Engineering
     Topic :: Scientific/Engineering :: Physics

tests/data/bugfixiteratortopo.json

@@ -0,0 +1,446 @@
+{
+  "elements": [
+    {
+      "uid": "Site_A",
+      "type": "Transceiver",
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": "Site A",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "nodeA",
+      "type": "Roadm",
+      "params": {
+        "target_pch_out_db": -18,
+        "restrictions": {
+          "preamp_variety_list": [],
+          "booster_variety_list": []
+        },
+        "per_degree_pch_out_db": {}
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.0,
+          "longitude": 0.0,
+          "city": "Zion",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "fiber1",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "length": 50.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.0,
+        "con_out": 0.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": null,
+          "region": null
+        }
+      }
+    },
+    {
+      "uid": "fiber7",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "length": 1.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.0,
+        "con_out": 0.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": null,
+          "region": null
+        }
+      }
+    },
+    {
+      "uid": "fiber8",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "length": 60.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.0,
+        "con_out": 0.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": null,
+          "region": null
+        }
+      }
+    },
+    {
+      "uid": "fused1",
+      "type": "Fused",
+      "params": {
+        "loss": 0.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": null,
+          "region": null
+        }
+      }
+    },
+    {
+      "uid": "fiber2",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "length": 1.0,
+        "loss_coef": 0.5,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.0,
+        "con_out": 0.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": null,
+          "region": null
+        }
+      }
+    },
+    {
+      "uid": "amp2",
+      "type": "Edfa",
+      "type_variety": "std_medium_gain",
+      "metadata": {
+        "location": {
+          "latitude": 0.0,
+          "longitude": 0.0,
+          "city": "Zion",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "fiber3",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "length": 80.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.0,
+        "con_out": 0.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": null,
+          "region": null
+        }
+      }
+    },
+    {
+      "uid": "fused7",
+      "type": "Fused",
+      "params": {
+        "loss": 1.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": null,
+          "region": null
+        }
+      }
+    },
+    {
+      "uid": "fiber6",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "length": 80.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.0,
+        "con_out": 0.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": null,
+          "region": null
+        }
+      }
+    },
+    {
+      "uid": "nodeC",
+      "type": "Roadm",
+      "params": {
+        "target_pch_out_db": -18,
+        "restrictions": {
+          "preamp_variety_list": [],
+          "booster_variety_list": []
+        },
+        "per_degree_pch_out_db": {}
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.0,
+          "longitude": 0.0,
+          "city": "Zion",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "Site_C",
+      "type": "Transceiver",
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": "Site A",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "amp3",
+      "type": "Edfa",
+      "type_variety": "std_medium_gain",
+      "metadata": {
+        "location": {
+          "latitude": 0.0,
+          "longitude": 0.0,
+          "city": "Zion",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "fused4",
+      "type": "Fused",
+      "params": {
+        "loss": 1.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": null,
+          "region": null
+        }
+      }
+    },
+    {
+      "uid": "fiber4",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "length": 80.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.0,
+        "con_out": 0.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": null,
+          "region": null
+        }
+      }
+    },
+    {
+      "uid": "amp4",
+      "type": "Edfa",
+      "type_variety": "std_medium_gain",
+      "operational": {
+        "gain_target": 13.31,
+        "delta_p": 1.18,
+        "tilt_target": -0.81,
+        "out_voa": 2.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.0,
+          "longitude": 0.0,
+          "city": "Zion",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "fused5",
+      "type": "Fused",
+      "params": {
+        "loss": 0.0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": null,
+          "region": null
+        }
+      }
+    },
+    {
+      "uid": "nodeB",
+      "type": "Roadm",
+      "params": {
+        "target_pch_out_db": -15,
+        "restrictions": {
+          "preamp_variety_list": [],
+          "booster_variety_list": []
+        },
+        "per_degree_pch_out_db": {}
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.0,
+          "longitude": 0.0,
+          "city": "Zion",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "Site_B",
+      "type": "Transceiver",
+      "metadata": {
+        "location": {
+          "latitude": 2,
+          "longitude": 0,
+          "city": "Site B",
+          "region": ""
+        }
+      }
+    }
+  ],
+  "connections": [
+    {
+      "from_node": "Site_A",
+      "to_node": "nodeA"
+    },
+    {
+      "from_node": "nodeA",
+      "to_node": "Site_A"
+    },
+    {
+      "from_node": "nodeA",
+      "to_node": "fiber1"
+    },
+    {
+      "from_node": "fiber1",
+      "to_node": "fused1"
+    },
+    {
+      "from_node": "fused1",
+      "to_node": "fiber2"
+    },
+    {
+      "from_node": "fiber2",
+      "to_node": "amp2"
+    },
+    {
+      "from_node": "amp2",
+      "to_node": "fiber3"
+    },
+    {
+      "from_node": "fiber3",
+      "to_node": "nodeC"
+    },
+    {
+      "from_node": "nodeC",
+      "to_node": "Site_C"
+    },
+    {
+      "from_node": "Site_C",
+      "to_node": "nodeC"
+    },
+    {
+      "from_node": "nodeC",
+      "to_node": "amp3"
+    },
+    {
+      "from_node": "amp3",
+      "to_node": "fiber4"
+    },
+    {
+      "from_node": "fiber4",
+      "to_node": "amp4"
+    },
+    {
+      "from_node": "amp4",
+      "to_node": "fused5"
+    },
+    {
+      "from_node": "fused5",
+      "to_node": "nodeB"
+    },
+    {
+      "from_node": "nodeB",
+      "to_node": "fused7"
+    },
+    {
+      "from_node": "fused7",
+      "to_node": "fiber6"
+    },
+    {
+      "from_node": "fiber6",
+      "to_node": "nodeA"
+    },
+    {
+      "from_node": "Site_B",
+      "to_node": "nodeB"
+    },
+    {
+      "from_node": "nodeB",
+      "to_node": "Site_B"
+    },
+    {
+      "from_node": "nodeA",
+      "to_node": "fiber7"
+    },
+    {
+      "from_node": "fiber7",
+      "to_node": "fiber8"
+    },
+    {
+      "from_node": "fiber8",
+      "to_node": "nodeB"
+    }
+  ]
+}

tests/data/perdegreemeshTopologyExampleV2_expected.json

@@ -64,8 +64,8 @@
       "uid": "roadm Lannion_CAS",
       "params": {
         "per_degree_pch_out_db": {
-            "east edfa in Lannion_CAS to Corlay": -18.6,
-            "east edfa in Lannion_CAS to Morlaix": -23.0
+          "east edfa in Lannion_CAS to Corlay": -18.6,
+          "east edfa in Lannion_CAS to Morlaix": -23.0
         }
       },
       "metadata": {
@@ -82,7 +82,7 @@
       "uid": "roadm Lorient_KMA",
       "params": {
         "per_degree_pch_out_db": {
-            "east edfa in Lorient_KMA to Vannes_KBE": -12.0
+          "east edfa in Lorient_KMA to Vannes_KBE": -12.0
         }
       },
       "metadata": {
@@ -99,7 +99,7 @@
       "uid": "roadm Vannes_KBE",
       "params": {
         "per_degree_pch_out_db": {
-            "east edfa in Vannes_KBE to Lorient_KMA": -10.0
+          "east edfa in Vannes_KBE to Lorient_KMA": -10.0
         }
       },
       "metadata": {
@@ -116,7 +116,7 @@
       "uid": "roadm Rennes_STA",
       "params": {
         "per_degree_pch_out_db": {
-            "east edfa in Rennes_STA to Stbrieuc": -20.0
+          "east edfa in Rennes_STA to Stbrieuc": -20.0
         }
       },
       "metadata": {
@@ -648,6 +648,70 @@
         "con_out": null
       }
     },
+    {
+      "uid": "west edfa in Quimper",
+      "metadata": {
+        "location": {
+          "city": "Quimper",
+          "region": "RLD",
+          "latitude": 1.0,
+          "longitude": 1.0
+        }
+      },
+      "type": "Edfa",
+      "operational": {
+        "gain_target": null,
+        "tilt_target": 0
+      }
+    },
+    {
+      "uid": "west edfa in Ploermel",
+      "metadata": {
+        "location": {
+          "city": "Ploermel",
+          "region": "RLD",
+          "latitude": 1.0,
+          "longitude": 2.0
+        }
+      },
+      "type": "Edfa",
+      "operational": {
+        "gain_target": null,
+        "tilt_target": 0
+      }
+    },
+    {
+      "uid": "east edfa in Quimper",
+      "metadata": {
+        "location": {
+          "city": "Quimper",
+          "region": "RLD",
+          "latitude": 1.0,
+          "longitude": 1.0
+        }
+      },
+      "type": "Edfa",
+      "operational": {
+        "gain_target": null,
+        "tilt_target": 0
+      }
+    },
+    {
+      "uid": "east edfa in Ploermel",
+      "metadata": {
+        "location": {
+          "city": "Ploermel",
+          "region": "RLD",
+          "latitude": 1.0,
+          "longitude": 2.0
+        }
+      },
+      "type": "Edfa",
+      "operational": {
+        "gain_target": null,
+        "tilt_target": 0
+      }
+    },
     {
       "uid": "east edfa in Lannion_CAS to Corlay",
       "metadata": {
@@ -1200,18 +1264,34 @@
     },
     {
       "from_node": "fiber (Brest_KLA → Quimper)-",
+      "to_node": "west edfa in Quimper"
+    },
+    {
+      "from_node": "west edfa in Quimper",
       "to_node": "fiber (Quimper → Lorient_KMA)-"
     },
     {
       "from_node": "fiber (Lorient_KMA → Quimper)-",
+      "to_node": "east edfa in Quimper"
+    },
+    {
+      "from_node": "east edfa in Quimper",
       "to_node": "fiber (Quimper → Brest_KLA)-"
     },
     {
       "from_node": "fiber (Vannes_KBE → Ploermel)-",
+      "to_node": "west edfa in Ploermel"
+    },
+    {
+      "from_node": "west edfa in Ploermel",
       "to_node": "fiber (Ploermel → Rennes_STA)-"
     },
     {
       "from_node": "fiber (Rennes_STA → Ploermel)-",
+      "to_node": "east edfa in Ploermel"
+    },
+    {
+      "from_node": "east edfa in Ploermel",
       "to_node": "fiber (Ploermel → Vannes_KBE)-"
     },
     {

tests/invocation/openroadm-Stockholm-Gothenburg

@@ -0,0 +1,239 @@
+There are 96 channels propagating
+Power mode is set to True
+=> it can be modified in eqpt_config.json - Span
+
+There are 6 fiber spans over 500 km between trx_Stockholm and trx_Gothenburg
+
+Now propagating between trx_Stockholm and trx_Gothenburg:
+
+Propagating with input power = 2.00 dBm:
+Transceiver trx_Stockholm
+  GSNR (0.1nm, dB):          35.00
+  GSNR (signal bw, dB):      30.98
+  OSNR ASE (0.1nm, dB):      35.00
+  OSNR ASE (signal bw, dB):  30.98
+  CD (ps/nm):                0.00
+  PMD (ps):                  0.00
+Roadm roadm_Stockholm
+  effective loss (dB):  22.00
+  pch out (dBm):        -20.00
+Edfa Edfa_booster_roadm_Stockholm_to_fiber (Stockholm → Norrköping)_(1/2)
+  type_variety:           openroadm_mw_mw_booster
+  effective gain(dB):     22.00
+  (before att_in and before output VOA)
+  noise figure (dB):      -inf
+  (including att_in)
+  pad att_in (dB):        0.00
+  Power In (dBm):         -0.18
+  Power Out (dBm):        21.82
+  Delta_P (dB):           0.00
+  target pch (dBm):       2.00
+  effective pch (dBm):    2.00
+  output VOA (dB):        0.00
+Fiber          fiber (Stockholm → Norrköping)_(1/2)
+  type_variety:                SSMF
+  length (km):                 81.63
+  pad att_in (dB):             0.00
+  total loss (dB):             16.33
+  (includes conn loss (dB) in: 0.00 out: 0.00)
+  (conn loss out includes EOL margin defined in eqpt_config.json)
+  pch out (dBm): -14.33
+Edfa Edfa_fiber (Stockholm → Norrköping)_(1/2)
+  type_variety:           openroadm_ila_low_noise
+  effective gain(dB):     16.33
+  (before att_in and before output VOA)
+  noise figure (dB):      8.01
+  (including att_in)
+  pad att_in (dB):        0.00
+  Power In (dBm):         5.51
+  Power Out (dBm):        21.84
+  Delta_P (dB):           0.00
+  target pch (dBm):       2.00
+  effective pch (dBm):    2.00
+  output VOA (dB):        0.00
+Fiber          fiber (Stockholm → Norrköping)_(2/2)
+  type_variety:                SSMF
+  length (km):                 81.63
+  pad att_in (dB):             0.00
+  total loss (dB):             16.33
+  (includes conn loss (dB) in: 0.00 out: 0.00)
+  (conn loss out includes EOL margin defined in eqpt_config.json)
+  pch out (dBm): -14.33
+Edfa Edfa_preamp_roadm_Norrköping_from_fiber (Stockholm → Norrköping)_(2/2)
+  type_variety:           openroadm_mw_mw_preamp
+  effective gain(dB):     16.33
+  (before att_in and before output VOA)
+  noise figure (dB):      12.59
+  (including att_in)
+  pad att_in (dB):        0.00
+  Power In (dBm):         5.53
+  Power Out (dBm):        21.87
+  Delta_P (dB):           0.00
+  target pch (dBm):       2.00
+  effective pch (dBm):    2.00
+  output VOA (dB):        0.00
+Roadm roadm_Norrköping
+  effective loss (dB):  22.00
+  pch out (dBm):        -20.00
+Edfa Edfa_booster_roadm_Norrköping_to_fiber (Norrköping → Linköping)
+  type_variety:           openroadm_mw_mw_booster
+  effective gain(dB):     22.00
+  (before att_in and before output VOA)
+  noise figure (dB):      -inf
+  (including att_in)
+  pad att_in (dB):        0.00
+  Power In (dBm):         -0.18
+  Power Out (dBm):        21.82
+  Delta_P (dB):           0.00
+  target pch (dBm):       2.00
+  effective pch (dBm):    2.00
+  output VOA (dB):        0.00
+Fiber          fiber (Norrköping → Linköping)
+  type_variety:                SSMF
+  length (km):                 45.99
+  pad att_in (dB):             1.80
+  total loss (dB):             11.00
+  (includes conn loss (dB) in: 0.00 out: 0.00)
+  (conn loss out includes EOL margin defined in eqpt_config.json)
+  pch out (dBm): -9.00
+Edfa Edfa_preamp_roadm_Linköping_from_fiber (Norrköping → Linköping)
+  type_variety:           openroadm_mw_mw_preamp
+  effective gain(dB):     11.00
+  (before att_in and before output VOA)
+  noise figure (dB):      16.00
+  (including att_in)
+  pad att_in (dB):        0.00
+  Power In (dBm):         10.83
+  Power Out (dBm):        21.83
+  Delta_P (dB):           0.00
+  target pch (dBm):       2.00
+  effective pch (dBm):    2.00
+  output VOA (dB):        0.00
+Roadm roadm_Linköping
+  effective loss (dB):  22.00
+  pch out (dBm):        -20.00
+Edfa Edfa_booster_roadm_Linköping_to_fiber (Linköping → Jönköping)
+  type_variety:           openroadm_mw_mw_booster
+  effective gain(dB):     22.00
+  (before att_in and before output VOA)
+  noise figure (dB):      -inf
+  (including att_in)
+  pad att_in (dB):        0.00
+  Power In (dBm):         -0.18
+  Power Out (dBm):        21.82
+  Delta_P (dB):           0.00
+  target pch (dBm):       2.00
+  effective pch (dBm):    2.00
+  output VOA (dB):        0.00
+Fiber          fiber (Linköping → Jönköping)
+  type_variety:                SSMF
+  length (km):                 134.02
+  pad att_in (dB):             0.00
+  total loss (dB):             26.80
+  (includes conn loss (dB) in: 0.00 out: 0.00)
+  (conn loss out includes EOL margin defined in eqpt_config.json)
+  pch out (dBm): -24.80
+Edfa Edfa_preamp_roadm_Jönköping_from_fiber (Linköping → Jönköping)
+  type_variety:           openroadm_mw_mw_preamp
+  effective gain(dB):     26.80
+  (before att_in and before output VOA)
+  noise figure (dB):      8.09
+  (including att_in)
+  pad att_in (dB):        0.00
+  Power In (dBm):         -4.97
+  Power Out (dBm):        21.86
+  Delta_P (dB):           0.00
+  target pch (dBm):       2.00
+  effective pch (dBm):    2.00
+  output VOA (dB):        0.00
+Roadm roadm_Jönköping
+  effective loss (dB):  22.00
+  pch out (dBm):        -20.00
+Edfa Edfa_booster_roadm_Jönköping_to_fiber (Jönköping → Borås)
+  type_variety:           openroadm_mw_mw_booster
+  effective gain(dB):     22.00
+  (before att_in and before output VOA)
+  noise figure (dB):      -inf
+  (including att_in)
+  pad att_in (dB):        0.00
+  Power In (dBm):         -0.18
+  Power Out (dBm):        21.82
+  Delta_P (dB):           0.00
+  target pch (dBm):       2.00
+  effective pch (dBm):    2.00
+  output VOA (dB):        0.00
+Fiber          fiber (Jönköping → Borås)
+  type_variety:                SSMF
+  length (km):                 89.12
+  pad att_in (dB):             0.00
+  total loss (dB):             17.82
+  (includes conn loss (dB) in: 0.00 out: 0.00)
+  (conn loss out includes EOL margin defined in eqpt_config.json)
+  pch out (dBm): -15.82
+Edfa Edfa_preamp_roadm_Borås_from_fiber (Jönköping → Borås)
+  type_variety:           openroadm_mw_mw_preamp
+  effective gain(dB):     17.82
+  (before att_in and before output VOA)
+  noise figure (dB):      11.94
+  (including att_in)
+  pad att_in (dB):        0.00
+  Power In (dBm):         4.01
+  Power Out (dBm):        21.84
+  Delta_P (dB):           0.00
+  target pch (dBm):       2.00
+  effective pch (dBm):    2.00
+  output VOA (dB):        0.00
+Roadm roadm_Borås
+  effective loss (dB):  22.00
+  pch out (dBm):        -20.00
+Edfa Edfa_booster_roadm_Borås_to_fiber (Borås → Gothenburg)
+  type_variety:           openroadm_mw_mw_booster
+  effective gain(dB):     22.00
+  (before att_in and before output VOA)
+  noise figure (dB):      -inf
+  (including att_in)
+  pad att_in (dB):        0.00
+  Power In (dBm):         -0.18
+  Power Out (dBm):        21.82
+  Delta_P (dB):           0.00
+  target pch (dBm):       2.00
+  effective pch (dBm):    2.00
+  output VOA (dB):        0.00
+Fiber          fiber (Borås → Gothenburg)
+  type_variety:                SSMF
+  length (km):                 67.64
+  pad att_in (dB):             0.00
+  total loss (dB):             13.53
+  (includes conn loss (dB) in: 0.00 out: 0.00)
+  (conn loss out includes EOL margin defined in eqpt_config.json)
+  pch out (dBm): -11.53
+Edfa Edfa_preamp_roadm_Gothenburg_from_fiber (Borås → Gothenburg)
+  type_variety:           openroadm_mw_mw_preamp
+  effective gain(dB):     13.53
+  (before att_in and before output VOA)
+  noise figure (dB):      13.78
+  (including att_in)
+  pad att_in (dB):        0.00
+  Power In (dBm):         8.30
+  Power Out (dBm):        21.84
+  Delta_P (dB):           0.00
+  target pch (dBm):       2.00
+  effective pch (dBm):    2.00
+  output VOA (dB):        0.00
+Roadm roadm_Gothenburg
+  effective loss (dB):  22.00
+  pch out (dBm):        -20.00
+Transceiver trx_Gothenburg
+  GSNR (0.1nm, dB):          18.90
+  GSNR (signal bw, dB):      14.88
+  OSNR ASE (0.1nm, dB):      21.20
+  OSNR ASE (signal bw, dB):  17.18
+  CD (ps/nm):                8350.42
+  PMD (ps):                  0.89
+
+Transmission result for input power = 2.00 dBm:
+  Final GSNR (0.1 nm): 18.90 dB
+
+(No source node specified: picked trx_Stockholm)
+
+(No destination node specified: picked trx_Gothenburg)

tests/invocation/path_requests_run

@@ -143,7 +143,7 @@ with path constraint: ['trx Lannion_CAS', 'trx Lorient_KMA']
 Computed path (roadms):['roadm Lannion_CAS', 'roadm Lorient_KMA']
 
 Result summary
-req id   demand                                 snr@bandwidth A-Z (Z-A)    snr@0.1nm A-Z (Z-A)        Receiver minOSNR               mode                    Gbit/s              nb of tsp pairs      N,M or blocking reason 
+req id   demand                                GSNR@bandwidth A-Z (Z-A)   GSNR@0.1nm A-Z (Z-A)        Receiver minOSNR               mode                    Gbit/s              nb of tsp pairs      N,M or blocking reason 
 0       trx Lorient_KMA to trx Vannes_KBE :             24.83                    28.92                      14                     mode 1                   100.0                      1                     (-284,4)        
 1       trx Brest_KLA to trx Vannes_KBE :               17.75                    21.83                      14                     mode 1                   200.0                      2                     (-272,8)        
 3       trx Lannion_CAS to trx Rennes_STA :             22.21                    26.29                      13                     mode 1                    60.0                      1                     (-284,4)        
@@ -151,4 +151,4 @@ req id   demand                                 snr@bandwidth A-Z (Z-A)    snr@0
 5       trx Rennes_STA to trx Lannion_CAS :             20.31                    27.54                      17                     mode 2                    20.0                      1                     (-274,6)        
 7 | 6   trx Lannion_CAS to trx Lorient_KMA :            19.52                    23.61                      14                     mode 1                   700.0                      7                    (-224,28)        
 7b      trx Lannion_CAS to trx Lorient_KMA :            19.61                    23.69                      14                     mode 1                   400.0                      4                    (-172,24)        
-Result summary shows mean SNR and OSNR (average over all channels)
+Result summary shows mean GSNR and OSNR (average over all channels)

tests/invocation/transmission_main_example

@@ -8,10 +8,10 @@ Now propagating between Site_A and Site_B:
 
 Propagating with input power = 0.00 dBm:
 Transceiver Site_A
+  GSNR (0.1nm, dB):          40.00
+  GSNR (signal bw, dB):      35.92
   OSNR ASE (0.1nm, dB):      40.00
   OSNR ASE (signal bw, dB):  35.92
-  SNR total (signal bw, dB): 35.92
-  SNR total (0.1nm, dB):     40.00
   CD (ps/nm):                0.00
   PMD (ps):                  0.00
 Fiber          Span1
@@ -21,7 +21,7 @@ Fiber          Span1
   total loss (dB):             17.00
   (includes conn loss (dB) in: 0.50 out: 0.50)
   (conn loss out includes EOL margin defined in eqpt_config.json)
-  pch out (dBm): -17.0
+  pch out (dBm): -17.00
 Edfa Edfa1
   type_variety:           std_low_gain
   effective gain(dB):     15.00
@@ -31,20 +31,20 @@ Edfa Edfa1
   pad att_in (dB):        0.00
   Power In (dBm):         1.81
   Power Out (dBm):        16.82
-  Delta_P (dB):           -2
-  target pch (dBm):       -2.0
-  effective pch (dBm):    -2.0
+  Delta_P (dB):           -2.00
+  target pch (dBm):       -2.00
+  effective pch (dBm):    -2.00
   output VOA (dB):        0.00
 Transceiver Site_B
+  GSNR (0.1nm, dB):          31.17
+  GSNR (signal bw, dB):      27.09
   OSNR ASE (0.1nm, dB):      33.30
   OSNR ASE (signal bw, dB):  29.21
-  SNR total (signal bw, dB): 27.09
-  SNR total (0.1nm, dB):     31.17
   CD (ps/nm):                1336.00
   PMD (ps):                  0.36
 
 Transmission result for input power = 0.00 dBm:
-  Final SNR total (0.1 nm): 31.17 dB
+  Final GSNR (0.1 nm): 31.17 dB
 
 (No source node specified: picked Site_A)
 

tests/invocation/transmission_main_example__raman

@@ -8,10 +8,10 @@ Now propagating between Site_A and Site_B:
 
 Propagating with input power = 0.00 dBm:
 Transceiver Site_A
+  GSNR (0.1nm, dB):          40.00
+  GSNR (signal bw, dB):      35.92
   OSNR ASE (0.1nm, dB):      40.00
   OSNR ASE (signal bw, dB):  35.92
-  SNR total (signal bw, dB): 35.92
-  SNR total (0.1nm, dB):     40.00
   CD (ps/nm):                0.00
   PMD (ps):                  0.00
 RamanFiber          Span1
@@ -31,23 +31,23 @@ Edfa Edfa1
   pad att_in (dB):        2.26
   Power In (dBm):         11.07
   Power Out (dBm):        16.82
-  Delta_P (dB):           -2
-  target pch (dBm):       -2.0
-  effective pch (dBm):    -2.0
+  Delta_P (dB):           -2.00
+  target pch (dBm):       -2.00
+  effective pch (dBm):    -2.00
   output VOA (dB):        0.00
 Transceiver Site_B
+  GSNR (0.1nm, dB):          31.43
+  GSNR (signal bw, dB):      27.35
   OSNR ASE (0.1nm, dB):      34.18
   OSNR ASE (signal bw, dB):  30.10
-  SNR total (signal bw, dB): 27.35
-  SNR total (0.1nm, dB):     31.43
   CD (ps/nm):                1336.00
   PMD (ps):                  0.36
 
 Transmission result for input power = 0.00 dBm:
-  Final SNR total (0.1 nm): 31.43 dB
+  Final GSNR (0.1 nm): 31.43 dB
 
-The total SNR per channel at the end of the line is:
-Ch. #   Channel frequency (THz)       Channel power (dBm)    OSNR ASE (signal bw, dB)     SNR NLI (signal bw, dB)   SNR total (signal bw, dB)
+The GSNR per channel at the end of the line is:
+Ch. #   Channel frequency (THz)       Channel power (dBm)    OSNR ASE (signal bw, dB)     SNR NLI (signal bw, dB)        GSNR (signal bw, dB)
     1                    191.35                      0.21                       31.56                       31.47                       28.50
     2                    191.40                      0.17                       31.54                       31.38                       28.45
     3                    191.45                      0.14                       31.52                       31.30                       28.40

tests/test_invocation.py

@@ -14,6 +14,8 @@ SRC_ROOT = Path(__file__).parent.parent
     ('path_requests_run', path_requests_run, []),
     ('transmission_main_example__raman', transmission_main_example,
      ['gnpy/example-data/raman_edfa_example_network.json', '--sim', 'gnpy/example-data/sim_params.json', '--show-channels', ]),
+    ('openroadm-Stockholm-Gothenburg', transmission_main_example,
+     ['-e', 'gnpy/example-data/eqpt_config_openroadm.json', 'gnpy/example-data/Sweden_OpenROADM_example_network.json', ]),
 ))
 def test_example_invocation(capfdbinary, output, handler, args):
     '''Make sure that our examples produce useful output'''

tests/test_network_functions.py

@@ -0,0 +1,64 @@
+# SPDX-License-Identifier: BSD-3-Clause
+#
+# Copyright (C) 2020 Telecom Infra Project and GNPy contributors
+# see LICENSE.md for a list of contributors
+#
+
+from pathlib import Path
+import pytest
+from gnpy.core.exceptions import NetworkTopologyError
+from gnpy.core.network import span_loss
+from gnpy.tools.json_io import load_equipment, load_network
+
+
+TEST_DIR = Path(__file__).parent
+EQPT_FILENAME = TEST_DIR / 'data/eqpt_config.json'
+NETWORK_FILENAME = TEST_DIR / 'data/bugfixiteratortopo.json'
+
+
+@pytest.mark.parametrize("node, attenuation", [
+    # first fiber span
+    ['fiber1', 10.5],
+    ['fiber2', 10.5],
+    ['fused1', 10.5],
+    # second span
+    ['fiber3', 16.0],
+    # third span
+    ['fiber4', 16.0],
+    # direct link between a ROADM and an amplifier
+    ['fused5', 0],
+    # fourth span
+    ['fiber6', 17],
+    ['fused7', 17],
+    # fifth span
+    ['fiber7', 0.2],
+    ['fiber8', 12],
+    # all other nodes
+    ['Site_A', 0],
+    ['nodeA', 0],
+    ['amp2', 0],
+    ['nodeC', 0],
+    ['Site_C', 0],
+    ['amp3', 0],
+    ['amp4', 0],
+    ['nodeB', 0],
+    ['Site_B', 0],
+])
+def test_span_loss(node, attenuation):
+    equipment = load_equipment(EQPT_FILENAME)
+    network = load_network(NETWORK_FILENAME, equipment)
+    for x in network.nodes():
+        if x.uid == node:
+            assert attenuation == span_loss(network, x)
+            return
+    assert not f'node "{node}" referenced from test but not found in the topology'  # pragma: no cover
+
+
+@pytest.mark.parametrize("node", ['fused4'])
+def test_span_loss_unconnected(node):
+    '''Fused node that has no next and no previous nodes should be detected'''
+    equipment = load_equipment(EQPT_FILENAME)
+    network = load_network(NETWORK_FILENAME, equipment)
+    x = next(x for x in network.nodes() if x.uid == node)
+    with pytest.raises(NetworkTopologyError):
+        span_loss(network, x)

tox.ini

@@ -1,5 +1,4 @@
 [tox]
-envlist = py36,py37
 skipsdist = True
 
 [testenv]
@@ -10,6 +9,8 @@ deps =
 	linters: flake8
 	linters: pep8-naming
 	linters: mccabe
+	linters: flake8-noqa
+	linters-diff-ci: flake8-html
 changedir = {toxinidir}
 usedevelop = True
 setenv =
@@ -18,10 +19,11 @@ commands =
 	pytest {env:CI_COVERAGE_OPTS:} -vv {posargs}
 	cover: coverage html -d cover
 	cover: coverage xml -o cover/coverage.xml
+	python setup.py bdist_wheel
 
 [testenv:docs]
 deps =
-	rstcheck
+	-r{toxinidir}/docs/requirements.txt
 whitelist_externals =
 	/bin/sh
 commands =
@@ -32,10 +34,12 @@ commands =
 commands =
 	flake8 {posargs}
 
-[testenv:linters-diff]
+[testenv:linters-diff-ci]
 whitelist_externals = bash
 commands =
+	flake8 {posargs} --format html --htmldir linters --exit-zero
 	bash -c "git diff -U0 origin/$(git rev-parse --abbrev-ref HEAD) | flake8 --diff {posargs}"
 
 [flake8]
 max-line-length = 120
+max-complexity = 15