demo: reduce the spectrum so that it's safely and conveniently deep in the C-band

A duplicate key in the dict means that bad things happen.

.bandit

@@ -1,2 +1 @@
-[bandit]
-skips: B101
+skips: ['B101']

.codecov.yml

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

.docker-entry.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
-cp -nr /oopt-gnpy/gnpy/example-data /shared
+cp -nr /oopt-gnpy/examples /shared
 exec "$@"

.docker-travis.sh

@@ -0,0 +1,52 @@
+#!/bin/bash
+
+set -e
+
+IMAGE_NAME=telecominfraproject/oopt-gnpy
+IMAGE_TAG=$(git describe --tags)
+
+if [[ "${TRAVIS_BRANCH}" == "experimental/2019-summit" ]]; then
+  IMAGE_NAME=telecominfraproject/oopt-gnpy-experimental
+fi
+
+ALREADY_FOUND=0
+docker pull ${IMAGE_NAME}:${IMAGE_TAG} && ALREADY_FOUND=1
+
+if [[ $ALREADY_FOUND == 0 ]]; then
+  docker build . -t ${IMAGE_NAME}
+  docker tag ${IMAGE_NAME} ${IMAGE_NAME}:${IMAGE_TAG}
+else
+  echo "Image ${IMAGE_NAME}:${IMAGE_TAG} already available, will just update the other tags"
+fi
+
+docker images
+
+do_docker_login() {
+  echo "${DOCKER_PASSWORD}" | docker login -u "${DOCKER_USERNAME}" --password-stdin
+}
+
+if [[ "${TRAVIS_PULL_REQUEST}" == "false" ]]; then
+  if [[ "${TRAVIS_BRANCH}" == "develop" || "${TRAVIS_BRANCH}" == "docker" ]]; then
+    echo "Publishing latest"
+    docker tag ${IMAGE_NAME}:${IMAGE_TAG} ${IMAGE_NAME}:latest
+    do_docker_login
+    if [[ $ALREADY_FOUND == 0 ]]; then
+      docker push ${IMAGE_NAME}:${IMAGE_TAG}
+    fi
+    docker push ${IMAGE_NAME}:latest
+  elif [[ "${TRAVIS_BRANCH}" == "master" ]]; then
+    echo "Publishing stable"
+    docker tag ${IMAGE_NAME}:${IMAGE_TAG} ${IMAGE_NAME}:stable
+    do_docker_login
+    if [[ $ALREADY_FOUND == 0 ]]; then
+      docker push ${IMAGE_NAME}:${IMAGE_TAG}
+    fi
+    docker push ${IMAGE_NAME}:stable
+  elif [[ "${TRAVIS_BRANCH}" == "experimental/2019-summit" ]]; then
+    echo "Publishing ad-hoc image for the TIP Summit demo"
+    do_docker_login
+    if [[ $ALREADY_FOUND == 0 ]]; then
+      docker push ${IMAGE_NAME}:${IMAGE_TAG}
+    fi
+  fi
+fi

.github/pull_request_template.md

@@ -1,7 +0,0 @@
-# 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/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

@@ -1,147 +0,0 @@
-on:
-  push:
-  pull_request:
-    branches:
-      - master
-
-name: CI
-
-jobs:
-  build:
-    name: Tox test
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - uses: fedora-python/tox-github-action@v37.0
-        with:
-          tox_env: ${{ matrix.tox_env }}
-          dnf_install: ${{ matrix.dnf_install }}
-      - uses: codecov/codecov-action@v3.1.1
-        if: ${{ endswith(matrix.tox_env, '-cover') }}
-        with:
-          files: ${{ github.workspace }}/cover/coverage.xml
-    strategy:
-      fail-fast: false
-      matrix:
-        tox_env:
-          - py38
-          - py39
-          - py310
-          - py311
-          - py312-cover
-        include:
-          - tox_env: docs
-            dnf_install: graphviz
-
-  pypi:
-    needs: build
-    if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && github.repository_owner == 'Telecominfraproject' }}
-    name: PyPI packaging
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-python@v4
-        name: Install Python
-        with:
-          python-version: '3.12'
-      - 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')) && github.repository_owner == 'Telecominfraproject' }}
-    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@v3
-        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:${{ 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 }}
-            telecominfraproject/oopt-gnpy:latest
-
-  other-platforms:
-    name: Tests on other platforms
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python_version }}
-      - run: |
-          pip install --editable .[tests]
-          pytest -vv
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - os: windows-2022
-            python_version: "3.11"
-          - os: windows-2022
-            python_version: "3.12"
-          - os: windows-2025
-            python_version: "3.11"
-          - os: windows-2025
-            python_version: "3.12"
-          - os: macos-13
-            python_version: "3.12"
-          - os: macos-14
-            python_version: "3.12"
-
-  paywalled-platforms:
-    name: Tests on paywalled platforms
-    if: github.repository_owner == 'Telecominfraproject'
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python_version }}
-      - run: |
-          pip install --editable .[tests]
-          pytest -vv
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - os: macos-13-xlarge # Apple M1 CPU
-            python_version: "3.12"

.gitignore

@@ -3,7 +3,6 @@ __pycache__/
 *.py[cod]
 *$py.class
 .ipynb_checkpoints
-.idea
 
 # C extensions
 *.so

.gitreview

@@ -1,4 +0,0 @@
-[gerrit]
-host=review.gerrithub.io
-project=Telecominfraproject/oopt-gnpy
-defaultrebase=0

.lgtm.yml

@@ -1,3 +0,0 @@
-queries:
-- exclude: py/clear-text-logging-sensitive-data
-- exclude: py/clear-text-storage-sensitive-data

.readthedocs.yml

@@ -1,17 +1,4 @@
-version: 2
 build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.12"
-  apt_packages:
-    - graphviz
-
+    image: latest
 python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs
-
-sphinx:
-  configuration: docs/conf.py
+    version: 3.6

.travis.yml

@@ -0,0 +1,27 @@
+dist: xenial
+sudo: false
+language: python
+services: docker
+python:
+  - "3.6"
+  - "3.7"
+install: skip
+script:
+  - python setup.py install
+  - pip install pytest-cov rstcheck
+  - pytest --cov-report=xml --cov=gnpy
+  - rstcheck --ignore-roles cite --ignore-directives automodule --recursive --ignore-messages '(Duplicate explicit target name.*)' .
+  - ./examples/transmission_main_example.py
+  - ./examples/path_requests_run.py
+  - ./examples/transmission_main_example.py examples/raman_edfa_example_network.json --sim examples/sim_params.json --show-channels
+  - sphinx-build docs/ x-throwaway-location
+after_success:
+  - bash <(curl -s https://codecov.io/bash)
+jobs:
+  include:
+    - stage: test
+      name: Docker image
+      script:
+        - git fetch --unshallow
+        - ./.docker-travis.sh
+        - docker images

.zuul.yaml

@@ -1,54 +0,0 @@
----
-- project:
-    check:
-      jobs:
-        - tox-py38:
-            vars:
-              ensure_tox_version: '<4'
-        - tox-py39:
-            vars:
-              ensure_tox_version: '<4'
-        - tox-py310-cover:
-            vars:
-              ensure_tox_version: '<4'
-        - tox-docs-f36:
-            vars:
-              ensure_tox_version: '<4'
-        - coverage-diff:
-            voting: false
-            dependencies:
-              - tox-py310-cover-previous
-              - tox-py310-cover
-            vars:
-              coverage_job_name_previous: tox-py310-cover-previous
-              coverage_job_name_current: tox-py310-cover
-        - tox-linters-diff-n-report:
-            voting: false
-            vars:
-              ensure_tox_version: '<4'
-        - tox-py310-cover-previous:
-            vars:
-              ensure_tox_version: '<4'
-    tag:
-      jobs:
-        - oopt-release-python:
-            secrets:
-              - secret: pypi-oopt-gnpy
-                name: pypi_info
-                pass-to-parent: true
-
-- secret:
-    name: pypi-oopt-gnpy
-    data:
-      username: __token__
-      password: !encrypted/pkcs1-oaep
-        - Taod9JmSMtVAvC5ShSbB3UWuccktQvutdySrj0G7a1Nk4tKFQIdwDXEnBuLpHsZVvsU9Q
-          6uk4wRVQABDSdNNI/+M/1FwmZfoxuOXa02U5S1deuxW/rBHTxzYcuB8xriwhArBvTiDMk
-          zyWHVysgDsjlR+85h/DkEhvsaMRDLYWqFwYgXizMoGNKVkwDVIH+qkhBmbggQfDpcYPKT
-          1gq0d6fw0eKVJtO8+vonMEcE0sWZvHmZvSSu0H++gxoe1W/JtzbCteH3Ak0zktwBHI8Qt
-          WBqFvY3laad335tpkFJN5b949N+DP8svCWwRwXmkZlHplPYZWF6QpYbEEXL/6Q0H6VwL+
-          om4f7ybYpKe9Gl939uv2INnXaKe5EU6CMsSw40r2XZCjnSTjWOTgh9pUn2PsoHnqUlALW
-          VR4Z+ipnCrEbu8aTmX3ROcnwYNS7OXkq4uhwDU1u9QjzyMHet6NQQhwhGtimsTo9KhL4E
-          TEUNiRlbAgow9WOwM5r3vRzddO8T2HZZSGaWj75qNRX46XPQWRWgB7ItAwyXgwLZ8UzWl
-          HdztjS3D7Hlsqno3zxNOVlhA5/vl9uVnhFbJnMtUOJAB07YoTJOeR+LjQ0avx/VzopxXc
-          RA/WvJXVZSBrlAHY0+ip4wPZvdi4Ph90gpmvHJvoH82KVfp2j5jxzUhsage94I=

AUTHORS.rst

@@ -7,30 +7,22 @@ To learn how to contribute, please see CONTRIBUTING.md
 
 - Alessio Ferrari (Politecnico di Torino) <alessio.ferrari@polito.it>
 - Anders Lindgren (Telia Company) <Anders.X.Lindgren@teliacompany.com>
-- Andrea D'Amico (NEC) <adamico@nec-labs.com>
-- Arturo Mayoral (Telecom Infra Project) <amayoral@telecominfraproject.com>
+- Andrea d'Amico (Politecnico di Torino) <andrea.damico@polito.it>
 - Brian Taylor (Facebook) <briantaylor@fb.com>
 - David Boertjes (Ciena) <dboertje@ciena.com>
 - Diego Landa (Facebook) <dlanda@fb.com>
-- Emmanuelle Delfour (Orange) <WEDE7391@orange.com>
 - Esther Le Rouzic (Orange) <esther.lerouzic@orange.com>
-- Florian Frank (Orange) <florian1.frank@orange.com>
 - Gabriele Galimberti (Cisco) <ggalimbe@cisco.com>
 - Gert Grammel (Juniper Networks) <ggrammel@juniper.net>
-- Giacomo Borraccini (NEC Laboratories America) <gborraccini@nec-labs.com>
 - Gilad Goldfarb (Facebook) <giladg@fb.com>
 - James Powell (Telecom Infra Project) <james.powell@telecominfraproject.com>
-- Jan Kundrát (Telecom Infra Project) <jkt@jankundrat.com>
+- Jan Kundrát (Telecom Infra Project) <jan.kundrat@telecominfraproject.com>
 - Jeanluc Augé (Orange) <jeanluc.auge@orange.com>
-- Jenny L'Escop (Orange) <jenny.lescop@orange.com>
 - Jonas Mårtensson (RISE) <jonas.martensson@ri.se>
 - Mattia Cantono (Politecnico di Torino) <mattia.cantono@polito.it>
 - Miguel Garrich (University Catalunya) <miquel.garrich@upct.es>
 - Raj Nagarajan (Lumentum) <raj.nagarajan@lumentum.com>
-- Renato Ambrosone (Politecnico di Torino) <renato.ambrosone@polito.it>
 - Roberts Miculens (Lattelecom) <roberts.miculens@lattelecom.lv>
-- Rodrigo Sasse David (Orange) <rodrigo.sassedavid@orange.com>
-- Sami Alavi (NUST) <sami.mansooralavi1999@gmail.com>
 - Shengxiang Zhu (University of Arizona) <szhu@email.arizona.edu>
 - Stefan Melin (Telia Company) <Stefan.Melin@teliacompany.com>
 - Vittorio Curri (Politecnico di Torino) <vittorio.curri@polito.it>

Dockerfile

@@ -1,8 +1,8 @@
-FROM python:3.9-slim
+FROM python:3.7-slim
 COPY . /oopt-gnpy
 WORKDIR /oopt-gnpy
-RUN apt update; apt install -y git
-RUN pip install .
-WORKDIR /shared/example-data
+RUN python setup.py install
+WORKDIR /shared
 ENTRYPOINT ["/oopt-gnpy/.docker-entry.sh"]
-CMD ["/bin/bash"]
+CMD ["python", "examples/path_requests_run.py", "examples/2019-demo-topology.json", "examples/2019-demo-services.json", "examples/2019-demo-equipment.json", "--rest"]
+EXPOSE 5000

Excel_userguide.rst

@@ -1,31 +1,26 @@
-.. _excel:
 
-*****************************
-Excel (XLS, XLSX) input files
-*****************************
+How to prepare the Excel input file
+-----------------------------------
 
-``gnpy-transmission-example`` gives the possibility to use an excel input file instead of a json file. The program then will generate the corresponding json file for you.
+`examples/transmission_main_example.py <examples/transmission_main_example.py>`_ gives the possibility to use an excel input file instead of a json file. The program then will generate the corresponding json file for you.
 
 The file named 'meshTopologyExampleV2.xls' is an example.
 
 In order to work the excel file MUST contain at least 2 sheets:
 
-- `Nodes`
-- `Links`
+- Nodes
+- Links
 
-(In progress) The File MAY contain additional sheets:
+(In progress) The File MAY contain an additional sheet:
 
-- `Eqpt`
-- `Service`
-- `Roadms`
+- Eqt
+- Service
 
-.. _excel-nodes-sheet:
+Nodes sheet
+-----------
 
-`Nodes` sheet
-=============
-
-`Nodes` sheet contains nine columns.
-Each line represents a 'node' (`ROADM` site or an in line amplifier site `ILA` or a `Fused`)::
+Nodes sheet contains nine columns.
+Each line represents a 'node' (ROADM site or an in line amplifier site ILA or a Fused)::
 
   City (Mandatory) ; State ; Country ; Region ; Latitude ; Longitude ; Type
 
@@ -39,7 +34,7 @@ Each line represents a 'node' (`ROADM` site or an in line amplifier site `ILA` o
   - If filled, it can take "ROADM", "FUSED" or "ILA" values. If another string is used, it will be considered as not filled. FUSED means that ingress and egress spans will be fused together.  
 
 - *State*, *Country*, *Region* are not mandatory.
-  "Region" is a holdover from the CORONET topology reference file `CORONET_Global_Topology.xlsx <gnpy/example-data/CORONET_Global_Topology.xlsx>`_. CORONET separates its network into geographical regions (Europe, Asia, Continental US.) This information is not used by gnpy.
+  "Region" is a holdover from the CORONET topology reference file `CORONET_Global_Topology.xls <examples/CORONET_Global_Topology.xls>`_. CORONET separates its network into geographical regions (Europe, Asia, Continental US.) This information is not used by gnpy.
 
 - *Longitude*, *Latitude* are not mandatory. If filled they should contain numbers.
 
@@ -49,18 +44,16 @@ Each line represents a 'node' (`ROADM` site or an in line amplifier site `ILA` o
 **There MUST NOT be empty line(s) between two nodes lines**
 
 
-.. _excel-links-sheet:
-
 Links sheet
-===========
+-----------
 
 Links sheet must contain sixteen columns::
 
-                   <--           east cable from a to z                                   --> <--                  west from z to a                                 -->
+                   <--           east cable from a to z                                   --> <--                  west from z to                                   -->
    NodeA ; NodeZ ; Distance km ; Fiber type ; Lineic att ; Con_in ; Con_out ; PMD ; Cable Id ; Distance km ; Fiber type ; Lineic att ; Con_in ; Con_out ; PMD ; Cable Id
 
 
-`Links` sheet MUST contain all links between nodes defined in Nodes sheet.
+Links sheets MUST contain all links between nodes defined in Nodes sheet.
 Each line represents a 'bidir link' between two nodes. The two directions are represented on a single line with "east cable from a to z" fields and "west from z to a" fields. Values for 'a to z' may be different from values from 'z to a'. 
 Since both direction of a bidir 'a-z' link are described on the same line (east and west), 'z to a' direction MUST NOT be repeated in a different line. If repeated, it will generate another parrallel bidir link between the same end nodes.
 
@@ -87,54 +80,51 @@ and a fiber span from node3 to node6::
 
   - If filled it MUST contain numbers. If empty it is replaced by a default "80" km value. 
   - If value is below 150 km, it is considered as a single (bidirectional) fiber span.
-  - If value is over 150 km or if the loss is greater than 28 dB, the autodesign program
-    will automatically split the span with "_1","_2", ... trailing strings in names.
-    Splitting threshold can be tuned in ["Span"]["max_length"] and ["Span"]["max_loss"] in
-    equipment library.
+  - If value is over 150 km the `transmission_main_example.py <examples/transmission_main_example.py>`_ program will automatically suppose that intermediate span description are required and will generate fiber spans elements with "_1","_2", ... trailing strings which are not visible in the json output. The reason for the splitting is that current edfa usually do not support large span loss. The current assumption is that links larger than 150km will require intermediate amplification. This value will be revisited when Raman amplification is added”
 
 - **Fiber type** is not mandatory. 
 
-  If filled it must contain types listed in `eqpt_config.json <gnpy/example-data/eqpt_config.json>`_ in "Fiber" list "type_variety".
+  If filled it must contain types listed in `eqpt_config.json <examples/eqpt_config.json>`_ in "Fiber" list "type_variety".
   If not filled it takes "SSMF" as default value.
 
-- **Lineic att** is not mandatory.
+- **Lineic att** is not mandatory. 
 
   It is the lineic attenuation expressed in dB/km.
   If filled it must contain positive numbers.
   If not filled it takes "0.2" dB/km value
 
-- **Con_in**, **Con_out** are not mandatory.
+- *Con_in*, *Con_out* are not mandatory. 
 
   They are the connector loss in dB at ingress and egress of the fiber spans.
   If filled they must contain positive numbers.
   If not filled they take "0.5" dB default value.
 
-- **PMD** is not mandatory.
+- *PMD* is not mandatory and and is not used yet. 
 
   It is the PMD value of the link in ps.
   If filled they must contain positive numbers.
   If not filled, it takes "0.1" ps value.
 
-- **Cable Id** is not mandatory.
+- *Cable Id* is not mandatory. 
   If filled they must contain strings with the same constraint as "City" names. Its value is used to differenate links having the same end points. In this case different Id should be used. Cable Ids are not meant to be unique in general.
 
 
-.. _excel-equipment-sheet:
+
+
+(in progress)
 
 Eqpt sheet 
-==========
+----------
 
-The equipment sheet (named "Eqpt") is optional.
-If provided, it specifies types of boosters and preamplifiers for all ROADM degrees of all ROADM nodes, and for all ILA nodes.
+Eqt sheet is optional. It lists the amplifiers types and characteristics on each degree of the *Node A* line.
+Eqpt sheet must contain twelve columns::
 
-This sheet contains twelve columns::
+                   <--           east cable from a to z        --> <--        west from z to a                 -->
+  Node A ; Node Z ; amp type ; att_in ; amp gain ; tilt ; att_out ; amp type ; att_in ; amp gain ; tilt ; att_out
 
-                   <--           east cable from a to z                  --> <--        west from z to a                          -->
-  Node A ; Node Z ; amp type ; att_in ; amp gain ; tilt ; att_out ; delta_p ; amp type ; att_in ; amp gain ; tilt ; att_out ; delta_p
+If the sheet is present, it MUST have as many lines as egress directions of ROADMs defined in Links Sheet. 
 
-If the sheet is present, it MUST have as many lines as there are egress directions of ROADMs defined in Links Sheet, and all ILAs.
-
-For example, consider the following list of links (A, B and C being a ROADM and amp# ILAs):
+For example, consider the following list of links (A,B and C being a ROADM and amp# ILAs)
 
 ::
 
@@ -146,8 +136,8 @@ For example, consider the following list of links (A, B and C being a ROADM and
 
 then Eqpt sheet should contain:
   - one line for each ILAs: amp1, amp2, amp3 
-  - one line for each one-degree ROADM (B and C in this example)
-  - two lines for each two-degree ROADM (just the ROADM A)
+  - one line for each degree 1 ROADMs B and C  
+  - two lines for ROADM A  which is a degree 2 ROADM 
 
 ::
 
@@ -160,11 +150,11 @@ then Eqpt sheet should contain:
   C    - amp3
 
 
-In case you already have filled Nodes and Links sheets `create_eqpt_sheet.py <gnpy/example-data/create_eqpt_sheet.py>`_  can be used to automatically create a template for the mandatory entries of the list.
+In case you already have filled Nodes and Links sheets `create_eqpt_sheet.py <examples/create_eqpt_sheet.py>`_  can be used to automatically create a template for the mandatory entries of the list.
 
 .. code-block:: shell
 
-    $ cd $(gnpy-example-data)
+    $ cd examples
     $ python create_eqpt_sheet.py meshTopologyExampleV2.xls
 
 This generates a text file meshTopologyExampleV2_eqt_sheet.txt  whose content can be directly copied into the Eqt sheet of the excel file. The user then can fill the values in the rest of the columns.
@@ -177,7 +167,7 @@ This generates a text file meshTopologyExampleV2_eqt_sheet.txt  whose content ca
 - **Node Z** is mandatory. It is the egress direction from the *Node A* site. Multiple Links between the same Node A and NodeZ is not supported.
 
 - **amp type** is not mandatory. 
-  If filled it must contain types listed in the equipment librairie like in the example `eqpt_config.json <gnpy/example-data/eqpt_config.json>`_ in "Edfa" list "type_variety".
+  If filled it must contain types listed in `eqpt_config.json <examples/eqpt_config.json>`_ in "Edfa" list "type_variety".
   If not filled it takes "std_medium_gain" as default value.
   If filled with fused, a fused element with 0.0 dB loss will be placed instead of an amplifier. This might be used to avoid booster amplifier on a ROADM direction.
 
@@ -185,59 +175,19 @@ This generates a text file meshTopologyExampleV2_eqt_sheet.txt  whose content ca
   If not filled, it will be determined with design rules in the convert.py file.
   If filled, it must contain positive numbers.
 
-- **att_in** and **att_out** are not mandatory. They are the value of the attenuator at input and output of amplifier (in dB).
+- *att_in* and *att_out* are not mandatory and are not used yet. They are the value of the attenautor at input and output of amplifier (in dB).
   If filled they must contain positive numbers.
 
-- **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.
+- *tilt* --TODO--
 
-- **delta_p**, in dB,  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.
-
-
-.. _excel-roadms-sheet:
-
-Roadms sheet 
-============
-
-The ROADM sheet (named "Roadms") is optional.
-If provided, it can be used to specify:
-
-  - per channel power target on a specific ROADM degree (*per_degree_pch_out_db*),
-  - ROADM type variety,
-  - impairment ID (identifier) on a particular ROADM path (from degree - to degree).
-
-This sheet contains six columns:
-
-  Node A ; Node Z ; per degree target power (dBm) ; type_variety ; from degrees ; from degree to degree impairment id
-
-- **Node A** is mandatory. Name of the ROADM node (as listed in Nodes sheet).
-  Must be a 'ROADM' (Type attribute in Node sheet), its number of occurence may be equal to its degree.
-
-- **Node Z** is mandatory. Egress direction from the *Node A* ROADM site. Multiple Links between the same Node A
-  and NodeZ is not supported. 
-
-- **per degree target power (dBm)** (optional). 
-  If filled it must contain a value in dBm corresponding to :ref:`per_degree_pch_out_db<roadm_json_instance>` on the **Node Z** degree.
-  Defaults to equipment library value if not filled.
-
-- **type_variety** (optional). Must be the same for all ROADM entries if filled,
-  and defined in the :ref:`equipment library<roadm>`. Defaults to 'default' if not filled.
-
-- **from degrees** (optional): List of Node names separated by ' | '. Names must be present in Node sheet.
-  Together with Node Z, they define a list of internal path in ROADM for which the impairment ID applies
-
-- **from degree to degree impairment id** (optional):List of impairment IDs separated by ' | '. Must be filled
-  if **from degrees** is defined.
-  The impairment ID must be defined in the equipment library and be of "express" type.
+# to be completed #
 
 (in progress)
 
-.. _excel-service-sheet:
-
 Service sheet 
-=============
+-------------
 
-Service sheet is optional. It lists the services for which path and feasibility must be computed with ``gnpy-path-request``.
+Service sheet is optional. It lists the services for which path and feasibility must be computed with path_requests_run.py.
 
 Service sheet must contain 11 columns::  
 
@@ -249,7 +199,7 @@ Service sheet must contain 11 columns::
 
 - **Destination** is mandatory. It is the name of the destination node (as listed in Nodes sheet). Source MUST be a ROADM node. (TODO: relax this and accept trx entries)
 
-- **TRX type** is mandatory. It is the variety type of the transceiver to be used for the propagation simulation. These modes MUST be defined in the equipment library. The format of the mode is used as the name of the mode. (TODO: maybe add another  mode id on Transceiver library ?). In particular the mode selection defines the channel baudrate to be used for the propagation simulation.
+- **TRX type** is mandatory. They are the variety type and selected mode of the transceiver to be used for the propagation simulation. These modes MUST be defined in the equipment library. The format of the mode is used as the name of the mode. (TODO: maybe add another  mode id on Transceiver library ?). In particular the mode selection defines the channel baudrate to be used for the propagation simulation.
 
 - **mode** is optional. If not specified, the program will search for the mode of the defined transponder with the highest baudrate fitting within the spacing value. 
 
@@ -266,4 +216,36 @@ Service sheet must contain 11 columns::
   - path: is the set of ROADM nodes that must be used by the path. It must contain the list of ROADM names that the path must cross. TODO : only ROADM nodes are accepted in this release. Relax this with any type of nodes. If filled it must contain ROADM ids separated by ' | '. Exact names are required. 
   - is loose?  'no' value means that the list of nodes should be strictly followed, while any other value means that the constraint may be relaxed if the node is not reachable. 
 
-- **path bandwidth** is mandatory. It is the amount of capacity required between source and destination in Gbit/s. Value should be positive (non zero). It is used to compute the amount of required spectrum for the service.  
+- ** path bandwidth** is optional. It is the amount of capacity required between source and destination in Gbit/s. Default value is 0.0 Gbit/s. 
+
+path_requests_run.py
+------------------------
+
+**Usage**: path_requests_run.py [-h] [-v] [-o OUTPUT]
+                            [network_filename xls or json] [service_filename xls or json] [eqpt_filename json]
+
+.. code-block:: shell
+
+    $ cd examples
+    $ python path_requests_run.py meshTopologyExampleV2.xls service_file.json eqpt_file -o output_file.json
+
+A function that computes performances for a list of services provided in the service file (accepts json or excel format.
+
+if the service <file.xls> is in xls format, path_requests_run.py converts it to a json file <file_services.json> following the Yang model for requesting Path Computation defined in `draft-ietf-teas-yang-path-computation-01.txt <https://www.ietf.org/id/draft-ietf-teas-yang-path-computation-01.pdf>`_. For PSE use, additional fields with trx type and mode have been added to the te-bandwidth field. 
+
+A template for the json file can be found here: `service_template.json <service_template.json>`_
+
+
+If no output file is given, the computation is shown on standard output for demo.
+If a file is specified with the optional -o argument, the result of the computation is converted into a json format following  the Yang model for requesting Path Computation defined in `draft-ietf-teas-yang-path-computation-01.txt <https://www.ietf.org/id/draft-ietf-teas-yang-path-computation-01.pdf>`_. TODO: verify that this implementation is correct + give feedback to ietf on what is missing for our specific application.
+
+A template for the result of computation json file can be found here: `path_result_template.json <path_result_template.json>`_
+
+Important note: path_requests_run.py 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.
+
+In a next step we plan to provide required features to enable dimensionning : alocation of ressources, counting channels, limitation of the number of channels, ...
+
+(in progress)
+
+

README.md

@@ -1,35 +0,0 @@
-# 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/actions/workflow/status/Telecominfraproject/oopt-gnpy/main.yml)](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 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)
-[![Matrix chat](https://img.shields.io/matrix/oopt-gnpy:matrix.org)](https://matrix.to/#/%23oopt-gnpy%3Amatrix.org?via=matrix.org)
-
-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](https://gnpy.readthedocs.io/en/master/install.html#using-prebuilt-docker-images), or as a [Python package](https://gnpy.readthedocs.io/en/master/install.html#using-python-on-your-computer).
-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](docs/images/gnpy-transmission-example.svg)
-
-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/), or give it a [try online at `gnpy.app`](https://gnpy.app/):
-
-[![Path propagation at gnpy.app](docs/images/2022-04-12-gnpy-app.png)](https://gnpy.app/)
-
-## Project Calendar
-
-See upcoming meetings on the [Project Calendar](https://telecominfraproject.github.io/oopt-gnpy/calendar.html). The calendar is embedded from Google Calendar and updates automatically.

README.rst

@@ -0,0 +1,633 @@
+.. 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
+====================================================================
+
+|docs| |build| |doi|
+
+**`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/458339931322799/>`__ 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/>`__.
+
+Branches and Tagged Releases
+----------------------------
+
+- all releases are `available via GitHub <https://github.com/Telecominfraproject/oopt-gnpy/releases>`_
+- the `master <https://github.com/Telecominfraproject/oopt-gnpy/tree/master>`_ branch contains stable, `validated code <https://github.com/Telecominfraproject/oopt-gnpy/wiki/Testing-for-Quality>`_. It is updated from develop on a release schedule determined by the OOPT-PSE Working Group.
+- the `develop <https://github.com/Telecominfraproject/oopt-gnpy/tree/develop>`_ branch contains the latest code under active development, which may not be fully validated and tested.
+
+How to Install
+--------------
+
+Using prebuilt Docker images
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Our `Docker images <https://hub.docker.com/r/telecominfraproject/oopt-gnpy>`_ contain everything needed to run all examples from this guide.
+Docker transparently fetches the image over the network upon first use.
+On Linux and Mac, run:
+
+
+.. code-block:: shell-session
+
+    $ docker run -it --rm --volume $(pwd):/shared telecominfraproject/oopt-gnpy
+    root@bea050f186f7:/shared/examples#
+
+On Windows, launch from Powershell as:
+
+.. code-block:: powershell
+
+    PS C:\> docker run -it --rm --volume ${PWD}:/shared telecominfraproject/oopt-gnpy
+    root@89784e577d44:/shared/examples#
+
+In both cases, a directory named ``examples/`` will appear in your current working directory.
+GNPy automaticallly populates it with example files from the current release.
+Remove that directory if you want to start from scratch.
+
+Using Python on your computer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+   **Note**: `gnpy` supports Python 3 only. Python 2 is not supported.
+   `gnpy` requires Python ≥3.6
+
+   **Note**: the `gnpy` maintainers strongly recommend the use of Anaconda for
+   managing dependencies.
+
+It is recommended that you use a "virtual environment" when installing `gnpy`.
+Do not install `gnpy` on your system Python.
+
+We recommend the use of the `Anaconda Python distribution <https://www.anaconda.com/download>`_ which comes with many scientific computing
+dependencies pre-installed. Anaconda creates a base "virtual environment" for
+you automatically. You can also create and manage your ``conda`` "virtual
+environments" yourself (see:
+https://conda.io/docs/user-guide/tasks/manage-environments.html)
+
+To activate your Anaconda virtual environment, you may need to do the
+following:
+
+.. code-block:: shell
+
+    $ source /path/to/anaconda/bin/activate # activate Anaconda base environment
+    (base) $                                # note the change to the prompt
+
+You can check which Anaconda environment you are using with:
+
+.. code-block:: shell
+
+    (base) $ conda env list                          # list all environments
+    # conda environments:
+    #
+    base                  *  /src/install/anaconda3
+
+    (base) $ echo $CONDA_DEFAULT_ENV                 # show default environment
+    base
+
+You can check your version of Python with the following. If you are using
+Anaconda's Python 3, you should see similar output as below. Your results may
+be slightly different depending on your Anaconda installation path and the
+exact version of Python you are using.
+
+.. code-block:: shell
+
+    $ which python                   # check which Python executable is used
+    /path/to/anaconda/bin/python
+    $ python -V                      # check your Python version
+    Python 3.6.5 :: Anaconda, Inc.
+
+From within your Anaconda Python 3 environment, you can clone the master branch
+of the `gnpy` repo and install it with:
+
+.. code-block:: shell
+
+    $ git clone https://github.com/Telecominfraproject/oopt-gnpy # clone the repo
+    $ cd oopt-gnpy
+    $ python setup.py install                                    # install
+
+To test that `gnpy` was successfully installed, you can run this command. If it
+executes without a ``ModuleNotFoundError``, you have successfully installed
+`gnpy`.
+
+.. code-block:: shell
+
+    $ python -c 'import gnpy' # attempt to import gnpy
+
+    $ pytest                  # run tests
+
+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
+`examples/edfa_example_network.json <examples/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
+`examples/CORONET_Global_Topology.json <examples/CORONET_Global_Topology.json>`_:
+
+.. code-block:: shell-session
+
+    $ ./examples/transmission_main_example.py examples/CORONET_Global_Topology.json
+
+It is also possible to use an Excel file input (for example
+`examples/CORONET_Global_Topology.xls <examples/CORONET_Global_Topology.xls>`_).
+The Excel file will be processed into a JSON file with the same prefix. For
+further instructions on how to prepare the Excel input file, see
+`Excel_userguide.rst <Excel_userguide.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 ``transmission_main_example.py -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 (`transmission_main_example.py`, `path_requests_run.py`)
+-------------------------------------------------------------------------------------
+
+Design and transmission parameters are defined in a dedicated json file. By
+default, this information is read from `examples/eqpt_config.json
+<examples/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.)
+
+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 `examples/std_medium_gain_advanced_config.json <examples/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:
+
++------------------------+-----------+-----------------------------------------+
+| field                  |   type    | description                             |
++========================+===========+=========================================+
+| ``type_variety``       | (string)  | a unique name to ID the amplifier in the|
+|                        |           | JSON/Excel template topology input file |
++------------------------+-----------+-----------------------------------------+
+| ``out_voa_auto``       | (boolean) | auto_design feature to optimize the     |
+|                        |           | amplifier output VOA. If true, output   |
+|                        |           | VOA is present and will be used to push |
+|                        |           | amplifier gain to its maximum, within   |
+|                        |           | EOL power margins.                      |
++------------------------+-----------+-----------------------------------------+
+| ``allowed_for_design`` | (boolean) | If false, the amplifier will not be     |
+|                        |           | picked by auto-design but it can still  |
+|                        |           | be used as a manual input (from JSON or |
+|                        |           | Excel template topology files.)         |
++------------------------+-----------+-----------------------------------------+
+
+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)                             |
++----------------------+-----------+-----------------------------------------+
+| ``gamma``            | (number)  | 2pi.n2/(lambda*Aeff) (w-2.m-1)          |
++----------------------+-----------+-----------------------------------------+
+
+The transceiver equipment library is a list of supported transceivers. New
+transceivers can be added and existing ones removed at will by the user. It is
+used to determine the service list path feasibility when running the
+`path_request_run.py routine <examples/path_request_run.py>`_.
+
++----------------------+-----------+-----------------------------------------+
+| field                | type      | description                             |
++======================+===========+=========================================+
+| ``type_variety``     | (string)  | A unique name to ID the transceiver in  |
+|                      |           | the JSON or Excel template topology     |
+|                      |           | input file                              |
++----------------------+-----------+-----------------------------------------+
+| ``frequency``        | (number)  | Min/max as below.                       |
++----------------------+-----------+-----------------------------------------+
+| ``mode``             | (number)  | A list of modes supported by the        |
+|                      |           | transponder. New modes can be added at  |
+|                      |           | will by the user. The modes are specific|
+|                      |           | to each transponder type_variety.       |
+|                      |           | Each mode is described as below.        |
++----------------------+-----------+-----------------------------------------+
+
+The modes are defined as follows:
+
++----------------------+-----------+-----------------------------------------+
+| field                | type      | description                             |
++======================+===========+=========================================+
+| ``format``           | (string)  | a unique name to ID the mode            |
++----------------------+-----------+-----------------------------------------+
+| ``baud_rate``        | (number)  | in Hz                                   |
++----------------------+-----------+-----------------------------------------+
+| ``OSNR``             | (number)  | min required OSNR in 0.1nm (dB)         |
++----------------------+-----------+-----------------------------------------+
+| ``bit_rate``         | (number)  | in bit/s                                |
++----------------------+-----------+-----------------------------------------+
+| ``roll_off``         | (number)  | Not used.                               |
++----------------------+-----------+-----------------------------------------+
+| ``tx_osnr``          | (number)  | In dB. OSNR out from transponder.       |
++----------------------+-----------+-----------------------------------------+
+| ``cost``             | (number)  | Arbitrary unit                          |
++----------------------+-----------+-----------------------------------------+
+
+Simulation parameters are defined as follows.
+
+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.
+
+Span configuration is performed as follows. It is not a list (which may change
+in later releases) and the user can only modify the value of existing
+parameters:
+
++-------------------------------------+-----------+---------------------------------------------+
+| field                               | type      | description                                 |
++=====================================+===========+=============================================+
+| ``power_mode``                      | (boolean) | If false, gain mode. Auto-design sets       |
+|                                     |           | amplifier gain = preceding span loss,       |
+|                                     |           | unless the amplifier exists and its         |
+|                                     |           | gain > 0 in the topology input JSON.        |
+|                                     |           | If true, power mode (recommended for        |
+|                                     |           | auto-design and power sweep.)               |
+|                                     |           | Auto-design sets amplifier power            |
+|                                     |           | according to delta_power_range. If the      |
+|                                     |           | amplifier exists with gain > 0 in the       |
+|                                     |           | topology JSON input, then its gain is       |
+|                                     |           | translated into a power target/channel.     |
+|                                     |           | Moreover, when performing a power sweep     |
+|                                     |           | (see ``power_range_db`` in the SI           |
+|                                     |           | configuration library) the power sweep      |
+|                                     |           | is performed w/r/t this power target,       |
+|                                     |           | regardless of preceding amplifiers          |
+|                                     |           | power saturation/limitations.               |
++-------------------------------------+-----------+---------------------------------------------+
+| ``delta_power_range_db``            | (number)  | Auto-design only, power-mode                |
+|                                     |           | only. Specifies the [min, max, step]        |
+|                                     |           | power excursion/span. It is a relative      |
+|                                     |           | power excursion w/r/t the                   |
+|                                     |           | power_dbm + power_range_db                  |
+|                                     |           | (power sweep if applicable) defined in      |
+|                                     |           | the SI configuration library. This          |
+|                                     |           | relative power excursion is = 1/3 of        |
+|                                     |           | the span loss difference with the           |
+|                                     |           | reference 20 dB span. The 1/3 slope is      |
+|                                     |           | derived from the GN model equations.        |
+|                                     |           | For example, a 23 dB span loss will be      |
+|                                     |           | set to 1 dB more power than a 20 dB         |
+|                                     |           | span loss. The 20 dB reference spans        |
+|                                     |           | will *always* be set to                     |
+|                                     |           | power = power_dbm + power_range_db.         |
+|                                     |           | To configure the same power in all          |
+|                                     |           | spans, use `[0, 0, 0]`. All spans will      |
+|                                     |           | be set to                                   |
+|                                     |           | power = power_dbm + power_range_db.         |
+|                                     |           | To configure the same power in all spans    |
+|                                     |           | and 3 dB more power just for the longest    |
+|                                     |           | spans: `[0, 3, 3]`. The longest spans are   |
+|                                     |           | set to                                      |
+|                                     |           | power = power_dbm + power_range_db + 3.     |
+|                                     |           | To configure a 4 dB power range across      |
+|                                     |           | all spans in 0.5 dB steps: `[-2, 2, 0.5]`.  |
+|                                     |           | A 17 dB span is set to                      |
+|                                     |           | power = power_dbm + power_range_db - 1,     |
+|                                     |           | a 20 dB span to                             |
+|                                     |           | power = power_dbm + power_range_db and      |
+|                                     |           | a 23 dB span to                             |
+|                                     |           | power = power_dbm + power_range_db + 1      |
++-------------------------------------+-----------+---------------------------------------------+
+| ``max_fiber_lineic_loss_for_raman`` | (number)  | Maximum linear fiber loss for Raman         |
+|                                     |           | amplification use.                          |
++-------------------------------------+-----------+---------------------------------------------+
+| ``max_length``                      | (number)  | Split fiber lengths > max_length.           |
+|                                     |           | Interest to support high level              |
+|                                     |           | topologies that do not specify in line      |
+|                                     |           | amplification sites. For example the        |
+|                                     |           | CORONET_Global_Topology.xls defines         |
+|                                     |           | links > 1000km between 2 sites: it          |
+|                                     |           | couldn't be simulated if these links        |
+|                                     |           | were not split in shorter span lengths.     |
++-------------------------------------+-----------+---------------------------------------------+
+| ``length_unit``                     | "m"/"km"  | Unit for ``max_length``.                    |
++-------------------------------------+-----------+---------------------------------------------+
+| ``max_loss``                        | (number)  | Not used in the current code                |
+|                                     |           | implementation.                             |
++-------------------------------------+-----------+---------------------------------------------+
+| ``padding``                         | (number)  | In dB. Min span loss before putting an      |
+|                                     |           | attenuator before fiber. Attenuator         |
+|                                     |           | value                                       |
+|                                     |           | Fiber.att_in = max(0, padding - span_loss). |
+|                                     |           | Padding can be set manually to reach a      |
+|                                     |           | higher padding value for a given fiber      |
+|                                     |           | by filling in the Fiber/params/att_in       |
+|                                     |           | field in the topology json input [1]        |
+|                                     |           | but if span_loss = length * loss_coef       |
+|                                     |           | + att_in + con_in + con_out < padding,      |
+|                                     |           | the specified att_in value will be          |
+|                                     |           | completed to have span_loss = padding.      |
+|                                     |           | Therefore it is not possible to set         |
+|                                     |           | span_loss < padding.                        |
++-------------------------------------+-----------+---------------------------------------------+
+| ``EOL``                             | (number)  | All fiber span loss ageing. The value       |
+|                                     |           | is added to the con_out (fiber output       |
+|                                     |           | connector). So the design and the path      |
+|                                     |           | feasibility are performed with              |
+|                                     |           | span_loss + EOL. EOL cannot be set          |
+|                                     |           | manually for a given fiber span             |
+|                                     |           | (workaround is to specify higher            |
+|                                     |           | ``con_out`` loss for this fiber).           |
++-------------------------------------+-----------+---------------------------------------------+
+| ``con_in``,                         | (number)  | Default values if Fiber/params/con_in/out   |
+| ``con_out``                         |           | is None in the topology input               |
+|                                     |           | description. This default value is          |
+|                                     |           | ignored if a Fiber/params/con_in/out        |
+|                                     |           | value is input in the topology for a        |
+|                                     |           | given Fiber.                                |
++-------------------------------------+-----------+---------------------------------------------+
+
+.. code-block:: json
+
+    {
+        "uid": "fiber (A1->A2)",
+        "type": "Fiber",
+        "type_variety": "SSMF",
+        "params":
+        {
+              "type_variety": "SSMF",
+              "length": 120.0,
+              "loss_coef": 0.2,
+              "length_units": "km",
+              "att_in": 0,
+              "con_in": 0,
+              "con_out": 0
+        }
+    }
+
+ROADMs can be configured as follows. The user can only modify the value of
+existing parameters:
+
++--------------------------+-----------+---------------------------------------------+
+| field                    |   type    | description                                 |
++==========================+===========+=============================================+
+| ``target_pch_out_db``    | (number)  | Auto-design sets the ROADM egress channel   |
+|                          |           | power. This reflects typical control loop   |
+|                          |           | algorithms that adjust ROADM losses to      |
+|                          |           | equalize channels (eg coming from different |
+|                          |           | ingress direction or add ports)             |
+|                          |           | This is the default value                   |
+|                          |           | Roadm/params/target_pch_out_db if no value  |
+|                          |           | is given in the ``Roadm`` element in the    |
+|                          |           | topology input description.                 |
+|                          |           | This default value is ignored if a          |
+|                          |           | params/target_pch_out_db value is input in  |
+|                          |           | the topology for a given ROADM.             |
++--------------------------+-----------+---------------------------------------------+
+| ``add_drop_osnr``        | (number)  | OSNR contribution from the add/drop ports   |
++--------------------------+-----------+---------------------------------------------+
+| ``restrictions``         | (dict of  | If non-empty, keys ``preamp_variety_list``  |
+|                          |  strings) | and ``booster_variety_list`` represent      |
+|                          |           | list of ``type_variety`` amplifiers which   |
+|                          |           | are allowed for auto-design within ROADM's  |
+|                          |           | line degrees.                               |
+|                          |           |                                             |
+|                          |           | If no booster should be placed on a degree, |
+|                          |           | insert a ``Fused`` node on the degree       |
+|                          |           | output.                                     |
++--------------------------+-----------+---------------------------------------------+
+
+The ``SpectralInformation`` object can be configured as follows. 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``            |           |                                           |
++----------------------+-----------+-------------------------------------------+
+| ``baud_rate``        | (number)  | In Hz. Simulated baud rate.               |
++----------------------+-----------+-------------------------------------------+
+| ``spacing``          | (number)  | In Hz. Carrier spacing.                   |
++----------------------+-----------+-------------------------------------------+
+| ``roll_off``         | (number)  | Not used.                                 |
++----------------------+-----------+-------------------------------------------+
+| ``tx_osnr``          | (number)  | In dB. OSNR out from transponder.         |
++----------------------+-----------+-------------------------------------------+
+| ``power_dbm``        | (number)  | Reference channel power. In gain mode     |
+|                      |           | (see spans/power_mode = false), all gain  |
+|                      |           | settings are offset w/r/t this reference  |
+|                      |           | power. In power mode, it is the           |
+|                      |           | reference power for                       |
+|                      |           | Spans/delta_power_range_db. For example,  |
+|                      |           | if delta_power_range_db = `[0,0,0]`, the  |
+|                      |           | same power=power_dbm is launched in every |
+|                      |           | spans. The network design is performed    |
+|                      |           | with the power_dbm value: even if a       |
+|                      |           | power sweep is defined (see after) the    |
+|                      |           | design is not repeated.                   |
++----------------------+-----------+-------------------------------------------+
+| ``power_range_db``   | (number)  | Power sweep excursion around power_dbm.   |
+|                      |           | It is not the min and max channel power   |
+|                      |           | values! The reference power becomes:      |
+|                      |           | power_range_db + power_dbm.               |
++----------------------+-----------+-------------------------------------------+
+| ``sys_margins``      | (number)  | In dB. Added margin on min required       |
+|                      |           | transceiver OSNR.                         |         
++----------------------+-----------+-------------------------------------------+
+
+The `transmission_main_example.py <examples/transmission_main_example.py>`_ 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
+
+     $ ./examples/transmission_main_example.py \
+       examples/raman_edfa_example_network.json \
+       --sim examples/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 <examples/raman_edfa_example_network.json>`_.
+General numeric parameters for simulaiton control are provided in the `examples/sim_params.json <examples/sim_params.json>`_.
+
+Use `examples/path_requests_run.py <examples/path_requests_run.py>`_ to run multiple optimizations as follows:
+
+.. code-block:: shell
+
+     $ python path_requests_run.py -h
+     Usage: path_requests_run.py [-h] [-v] [-o OUTPUT] [network_filename] [service_filename] [eqpt_filename]
+
+The ``network_filename`` and ``service_filename`` can be an XLS or JSON file. The ``eqpt_filename`` must be a JSON file.
+
+To see an example of it, run:
+
+.. code-block:: shell
+
+    $ cd examples
+    $ python path_requests_run.py meshTopologyExampleV2.xls meshTopologyExampleV2_services.json eqpt_config.json -o output_file.json
+
+This program requires a list of connections to be estimated and the equipment
+library. The program computes performances for the list of services (accepts
+JSON or Excel format) using the same spectrum propagation modules as
+``transmission_main_example.py``. Explanation on the Excel template is provided in
+the `Excel_userguide.rst <Excel_userguide.rst#service-sheet>`_. Template for
+the JSON format can be found here: `service-template.json
+<service-template.json>`_.
+
+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.
+
+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=develop
+  :target: http://gnpy.readthedocs.io/en/develop/?badge=develop
+  :alt: Documentation Status
+  :scale: 100%
+
+.. |build| image:: https://travis-ci.com/Telecominfraproject/oopt-gnpy.svg?branch=develop
+  :target: https://travis-ci.com/Telecominfraproject/oopt-gnpy
+  :alt: Build Status
+  :scale: 100%
+
+.. |doi| image:: https://zenodo.org/badge/96894149.svg
+  :target: https://zenodo.org/badge/latestdoi/96894149
+  :alt: DOI
+  :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.

bindep.txt

@@ -1 +0,0 @@
-graphviz

docs/_static/custom.css

@@ -1,4 +0,0 @@
-
-.wy-table-responsive table td, .wy-table-responsive table th {
-  white-space: normal;
-}

docs/about-project.md

@@ -1,60 +0,0 @@
-(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)=
-## 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 [Esther Le Rouzic](mailto:esther.lerouzic@orange.com) or
-[Andrea d'Amico](mailto:adamico@nec-labs.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/biblio.bib

@@ -1848,177 +1848,3 @@ month={Sept},}
   title = {Telecom Infra Project},
   url = {https://www.telecominfraproject.com},
 }
-
-@ARTICLE{DAmicoJLT2022,
-  author={D’Amico, Andrea and Correia, Bruno and London, Elliot and Virgillito,
-  Emanuele and Borraccini, Giacomo and Napoli, Antonio and Curri, Vittorio},
-  journal={Journal of Lightwave Technology},
-  title={Scalable and Disaggregated GGN Approximation Applied to a C+L+S Optical Network},
-  year={2022},
-  volume={40},
-  number={11},
-  pages={3499-3511},
-  doi={10.1109/JLT.2022.3162134}
-}
-
-@inproceedings{grammel2018physical,
-  title={Physical simulation environment of the telecommunications infrastructure project (TIP)},
-  author={Grammel, Gert and Curri, Vittorio and Auge, Jean-Luc},
-  booktitle={Optical Fiber Communication Conference},
-  pages={M1D--3},
-  year={2018},
-  organization={Optica Publishing Group}
-}
-
-@inproceedings{taylor2018towards,
-  title={Towards a route planning tool for open optical networks in the telecom infrastructure project},
-  author={Taylor, Brian D and Goldfarb, Gilad and Bandyopadhyay, Saumil and Curri, Vittorio and Schmidtke, Hans-Juergen},
-  booktitle={Optical Fiber Communication Conference},
-  pages={Tu3E--4},
-  year={2018},
-  organization={Optica Publishing Group}
-}
-
-@article{filer2018multi,
-  title={Multi-vendor experimental validation of an open source QoT estimator for optical networks},
-  author={Filer, Mark and Cantono, Mattia and Ferrari, Alessio and Grammel, Gert and Galimberti, Gabriele and Curri, Vittorio},
-  journal={Journal of Lightwave Technology},
-  volume={36},
-  number={15},
-  pages={3073--3082},
-  year={2018},
-  publisher={IEEE}
-}
-
-@inproceedings{auge2019open,
-  title={Open optical network planning demonstration},
-  author={Auge, Jean-Luc and Grammel, Gert and Le Rouzic, Esther and Curri, Vittorio and Galimberti, Gabriele and Powell, James},
-  booktitle={Optical Fiber Communication Conference},
-  pages={M3Z--9},
-  year={2019},
-  organization={Optica Publishing Group}
-}
-
-@inproceedings{kundrat2020physical,
-  title={Physical-layer awareness: GNPy and ONOS for end-to-end circuits in disaggregated networks},
-  author={Kundr{\'a}t, Jan and Campanella, Andrea and Le Rouzic, Esther and Ferrari, Alessio and Havli{\v{s}}, Ond{\v{r}}ej and Ha{\v{z}}linsk{\`y}, Michal and Grammel, Gert and Galimberti, Gabriele and Curri, Vittorio},
-  booktitle={2020 Optical Fiber Communications Conference and Exhibition (OFC)},
-  pages={1--3},
-  year={2020},
-  organization={IEEE}
-}
-
-@inproceedings{ferrari2020experimental,
-  title={Experimental validation of an open source quality of transmission estimator for open optical networks},
-  author={Ferrari, Alessio and Filer, Mark and Balasubramanian, Karthikeyan and Yin, Yawei and Le Rouzic, Esther and Kundr{\'a}t, Jan and Grammel, Gert and Galimberti, Gabriele and Curri, Vittorio},
-  booktitle={2020 Optical Fiber Communications Conference and Exhibition (OFC)},
-  pages={1--3},
-  year={2020},
-  organization={IEEE}
-}
-
-@article{ferrari2020gnpy,
-  title={GNPy: an open source application for physical layer aware open optical networks},
-  author={Ferrari, Alessio and Filer, Mark and Balasubramanian, Karthikeyan and Yin, Yawei and Le Rouzic, Esther and Kundr{\'a}t, Jan and Grammel, Gert and Galimberti, Gabriele and Curri, Vittorio},
-  journal={Journal of Optical Communications and Networking},
-  volume={12},
-  number={6},
-  pages={C31--C40},
-  year={2020},
-  publisher={Optica Publishing Group}
-}
-
-@inproceedings{ferrari2020softwarized,
-  title={Softwarized optical transport QoT in production optical network: a Brownfield validation},
-  author={Ferrari, Alessio and Balasubramanian, Karthikeyan and Filer, Mark and Yin, Yawei and Le Rouzic, Esther and Kundr{\'a}t, Jan and Grammel, Gert and Galimberti, Gabriele and Curri, Vittorio},
-  booktitle={2020 European Conference on Optical Communications (ECOC)},
-  pages={1--4},
-  year={2020},
-  organization={IEEE}
-}
-
-@article{ferrari2021assessment,
-  title={Assessment on the in-field lightpath QoT computation including connector loss uncertainties},
-  author={Ferrari, Alessio and Balasubramanian, Karthikeyan and Filer, Mark and Yin, Yawei and Le Rouzic, Esther and Kundr{\'a}t, Jan and Grammel, Gert and Galimberti, Gabriele and Curri, Vittorio},
-  journal={Journal of Optical Communications and Networking},
-  volume={13},
-  number={2},
-  pages={A156--A164},
-  year={2021},
-  publisher={Optica Publishing Group}
-}
-
-@inproceedings{kundrat2021gnpy,
-  title={GNPy \& YANG: open APIs for end-to-end service provisioning in optical networks},
-  author={Kundr{\'a}t, Jan and Le Rouzic, Esther and M{\aa}rtensson, Jonas and Campanella, Andrea and Havli{\v{s}}, Ond{\v{r}}ej and D’Amico, Andrea and Grammel, Gert and Galimberti, Gabriele and Curri, Vittorio and Vojt{\v{e}}ch, Josef},
-  booktitle={Optical Fiber Communication Conference},
-  pages={M1B--6},
-  year={2021},
-  organization={Optica Publishing Group}
-}
-
-@inproceedings{d2021gnpy,
-  title={GNPy experimental validation on flex-grid, flex-rate WDM optical transport scenarios},
-  author={D’Amico, Andrea and London, Elliot and Le Guyader, Bertrand and Frank, Florian and Le Rouzic, Esther and Pincemin, Erwan and Brochier, Nicolas and Curri, Vittorio},
-  booktitle={Optical fiber communication conference},
-  pages={W1G--2},
-  year={2021},
-  organization={Optica Publishing Group}
-}
-
-@inproceedings{virgillito2021testing,
-  title={Testing TIP open source solutions in deployed optical networks},
-  author={Virgillito, Emanuele and Braun, Ralf-Peter and Breuer, Dirk and Gladisch, Andreas and Curri, Vittorio and Grammel, Gert},
-  booktitle={Optical Fiber Communication Conference},
-  pages={F1C--3},
-  year={2021},
-  organization={Optica Publishing Group}
-}
-
-@article{d2022experimental,
-  title={Experimental validation of GNPy in a multi-vendor flex-grid flex-rate WDM optical transport scenario},
-  author={D’Amico, Andrea and London, Elliot and Le Guyader, Bertrand and Frank, Florian and Le Rouzic, Esther and Pincemin, Erwan and Brochier, Nicolas and Curri, Vittorio},
-  journal={Journal of Optical Communications and Networking},
-  volume={14},
-  number={3},
-  pages={79--88},
-  year={2022},
-  publisher={Optica Publishing Group}
-}
-
-@inproceedings{mano2022accuracy,
-  title={Accuracy of nonlinear interference estimation on launch power optimization in short-reach systems with field trial},
-  author={Mano, Toru and D’Amico, Andrea and Virgillito, Emanuele and Borraccini, Giacomo and Huang, Yue-Kai and Kitamura, Kei and Anazawa, Kazuya and Masuda, Akira and Nishizawa, Hideki and Wang, Ting and others},
-  booktitle={European Conference and Exhibition on Optical Communication},
-  pages={We3B--1},
-  year={2022},
-  organization={Optica Publishing Group}
-}
-
-@inproceedings{kundrat2022gnpy,
-  title={GNPy: Lessons learned and future plans},
-  author={Kundr{\'a}t, Jan and Le Rouzic, Esther and M{\aa}rtensson, Jonas and Melin, Stefan and D’Amico, Andrea and Grammel, Gert and Galimberti, Gabriele and Curri, Vittorio},
-  booktitle={European Conference and Exhibition on Optical Communication},
-  pages={We3B--6},
-  year={2022},
-  organization={Optica Publishing Group}
-}
-
-@inproceedings{grammel2023open,
-  title={Open Optical Networks: the good, the bad and the ugly},
-  author={Grammel, Gert and Kundrat, Jan and Le Rouzic, Esther and Melin, Stefan and Curri, Vittorio and d'Amico, Andrea and Manzotti, Roberto},
-  booktitle={49th European Conference on Optical Communications (ECOC 2023)},
-  volume={2023},
-  pages={1585--1588},
-  year={2023},
-  organization={IET}
-}
-
-@inproceedings{d2024gnpy,
-  title={GNPy Experimental Validation in a C+ L Multiband Optical Multiplex Section},
-  author={D’Amico, Andrea and Gatto, Vittorio and Nespola, Antonino and Borraccini, Giacomo and Jiang, Yanchao and Poggiolini, Pierluigi and Le Rouzic, Esther and de Lerma, Arturo Mayoral L{\'o}pez and Grammel, Gert and Manzotti, Roberto and others},
-  booktitle={2024 24th International Conference on Transparent Optical Networks (ICTON)},
-  pages={1--4},
-  year={2024},
-  organization={IEEE}
-}

docs/calendar.html

@@ -1,29 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <title>Project Calendar</title>
-    <style>
-      body { font-family: system-ui, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif; margin: 20px; }
-      .container { max-width: 1000px; margin: 0 auto; }
-      h1 { font-size: 1.8rem; margin-bottom: 1rem; }
-      iframe { border: 0; width: 100%; height: 800px; }
-      .note { color: #555; margin-top: 1rem; font-size: 0.9rem; }
-    </style>
-  </head>
-  <body>
-    <div class="container">
-      <h1>Project Calendar</h1>
-      <p>This page embeds the public project calendar. It updates automatically when events change in Google Calendar.</p>
-      <iframe
-        src="https://calendar.google.com/calendar/embed?src=c_0895d13d880537c3e54db61ba95e9df167db19a49b96d41e42e2c6d842f30a6a%40group.calendar.google.com&ctz=Europe%2FMadrid"
-        frameborder="0"
-        scrolling="no"
-      ></iframe>
-      <p class="note">Timezone: Europe/Madrid. If you prefer your local timezone, add <code>&amp;ctz=Your%2FTimezone</code> to the URL.</p>
-    </div>
-  </body>
-  </html>
-
-

docs/cli_options.rst

@@ -1,297 +0,0 @@
-.. _cli-options:
-
-***********************************************************
-`gnpy-path-request` and `gnpy-transmission-example` scripts
-***********************************************************
-
-Common options
-==============
-
-**Option**: `--no-insert-edfas`
--------------------------------
-
-**Purpose**: Disables the automatic insertion of EDFAs after ROADMs and fibers, as well as the splitting
-of fibers during the auto-design process.
-
-The `--no-insert-edfas` option is a command-line argument available in GNPy that allows users to control the
-automatic insertion of amplifiers during the network design process. This option provides flexibility for
-users who may want to manually manage amplifier placements or who have specific design requirements that
-do not necessitate automatic amplification.
-
-To use the `--no-insert-edfas` option, simply include it in the command line when running your GNPy program. For example:
-
-.. code-block:: shell-session
-
-  gnpy-transmission-example my_network.json --no-insert-edfas
-
-When the `--no-insert-edfas` option is specified:
-
-1. **No Automatic Amplifiers**: The program will not automatically add EDFAs to the network topology after
-   ROADMs or fiber elements. This means that if the network design requires amplification, users must ensure
-   that amplifiers are manually defined in the network topology file. Users should be aware that disabling
-   automatic amplifier insertion may lead to insufficient amplification in the network if not managed properly.
-   It is essential to ensure that the network topology includes the necessary amplifiers to meet performance requirements.
-
-2. **No Fiber Splitting**: The option also prevents the automatic splitting of fibers during the design process.
-   This is particularly useful for users who want to maintain specific fiber lengths or configurations without
-   the program altering them.
-
-
-**Option**: `--equipment`, `-e`
--------------------------------
-
-**Description**: Specifies the equipment library file.
-
-**Usage**: 
-
-.. code-block:: shell-session
-
-  gnpy-transmission-example my_network.json --equipment <FILE.json>
-
-**Default**: Uses the default equipment configuration in the example-data folder if not specified.
-
-**Functionality**: This option allows users to load a specific equipment configuration that defines the characteristics of the network elements.
-
-**Option**: `--extra-equipment` and `--extra-config`
-----------------------------------------------------
-
-The `--extra-equipment` and `--extra-config` options allow users to extend the default equipment library and configuration
-settings used by the GNPy program. This feature is particularly useful for users who need to incorporate additional
-equipment types or specific configurations that are not included in the standard equipment library (such as third party pluggables).
-
-**Usage**:
-  
-.. code-block:: shell-session
-
-  --extra-equipment <file1.json> [<file2.json> ...]
-
-**Parameters**:
-
-  - `<file1.json>`: Path to the first additional equipment file.
-  - `<file2.json>`: Path to any subsequent additional equipment files (optional).
-
-**Functionality**:
-
-  - The program will merge the equipment definitions from the specified files into the main equipment library.
-  - If an equipment type defined in the additional files has the same name as one in the main library, the program
-    will issue a warning about the duplicate entry and will include ony the last definition.
-  - This allows for flexibility in defining equipment that may be specific to certain use cases or vendor-specific models.
-
-**`--extra-config`**:
-
-**Description**: This option allows users to specify additional configuration files that can override
-  or extend the default configuration settings used by the program. This is useful for customizing simulation
-  parameters or equipment settings. To set an amplifier with a specific such config, it must be defined in the
-  library with the keyword "default_config_from_json" filled with the file name containing the config in the case of
-  "variable_gain" amplifier or with the "advanced_config_from_json" for the "advanced_model" amplifier.
-
-**Usage**:
-  
-.. code-block:: shell-session
-
-  --extra-config <file1.json> [<file2.json> ...]
-
-**Parameters**:
-  - `<file1.json>`: Path to the first additional configuration file.
-  - `<file2.json>`: Path to any subsequent additional configuration files (optional).
-
-**Functionality**:
-  The program will load the configurations from the specified files and consider them instead of the
-  default configurations for the amplifiers that use the "default_config_from_json" or "advanced_config_from_json" keywords.
-
-To run the program with additional equipment and configuration files, you can use the following command:
-
-.. code-block:: shell-session
-
-gnpy-transmission-example --equipment main_equipment.json \
-                          --extra-equipment additional_equipment1.json additional_equipment2.json \
-                          --extra-config additional_config1.json
-
-
-In this example:
-- `main_equipment.json` is the primary equipment file.
-- `additional_equipment1.json` and `additional_equipment2.json` are additional equipment files that will be merged into the main library.
-- `additional_config1.json` is an additional configuration file that will override the default settings for the amplifiers pointing to it.
-
-
-**Option**: `--save-network`
-----------------------------
-
-**Description**: Saves the final network configuration to a specified JSON file.
-
-**Usage**:
-
-.. code-block:: shell-session
-
-  --save-network <FILE.json>
-
-**Functionality**: This option allows users to save the network state after the simulation, which can be useful for future reference or analysis.
-
-
-**Option**: `--save-network-before-autodesign`
-----------------------------------------------
-
-**Description**: Dumps the network into a JSON file prior to autodesign.
-
-**Usage**:
-
-.. code-block:: shell-session
-
-  gnpy-path-request my_network.json my_services.json --save-network-before-autodesign <FILE.json>
-
-**Functionality**: This option is useful for users who want to inspect the network configuration before any automatic design adjustments are made.
-
-
-**Option**: `--sim-params`
---------------------------
-
-**Description**: Path to the JSON file containing simulation parameters.
-
-**Usage**:
-
-.. code-block:: shell-session
-
-  gnpy-transmission-example my_network.json --sim-params <FILE.json>
-
-**Functionality**: The `--sim-params` option is a command-line argument available in GNPy that allows users to specify a
-JSON file containing simulation parameters. This option is crucial for customizing the behavior of the simulation:
-the file ``sim_params.json`` contains the tuning parameters used within both the ``gnpy.science_utils.RamanSolver`` and
-the ``gnpy.science_utils.NliSolver`` for the evaluation of the Raman profile and the NLI generation, respectively.
-
-The tuning of the parameters is detailed here: :ref:`json input sim-params<sim-params>`.
-
-
-`gnpy-transmission-example` options
-===================================
-
-**Option**: `--show-channels`
------------------------------
-
-**Description**: Displays the final per-channel OSNR and GSNR summary.
-
-**Usage**: 
-
-.. code-block:: shell-session
-
-  gnpy-transmission-example my_network.json --show-channels
-
-**Functionality**: This option provides a summary of the optical signal-to-noise ratio (OSNR)
-and generalized signal-to-noise ratio (GSNR) for each channel after the simulation.
-
-
-**Option**: `-pl`, `--plot`
----------------------------
-
-**Description**: Generates plots of the results.
-
-**Usage**: 
-
-.. code-block:: shell-session
-
-  gnpy-transmission-example my_network.json -pl
-  
-**Functionality**: This option allows users to visualize the results of the simulation through graphical plots.
-
-
-**Option**: `-l`, `--list-nodes`
---------------------------------
-
-**Description**: Lists all transceiver nodes in the network.
-
-**Usage**: 
-
-.. code-block:: shell-session
-
-  gnpy-transmission-example my_network.json -l
-
-**Functionality**: This option provides a quick way to view all transceiver nodes present in the network topology.
-
-**Option**: `-po`, `--power`
-----------------------------
-
-**Description**: Specifies the reference channel power in span in dBm.
-
-**Usage**:
-
-.. code-block:: shell-session
-
-  gnpy-transmission-example my_network.json -po <value>
-
-**Functionality**: This option allows users to set the input power level for the reference channel used in the simulation.
-It replaces the value specified in the `SI` section of the equipment library (:ref:`power_dbm<spectral_info>`).
-
-
-**Option**: `--spectrum`
-------------------------
-
-**Description**: Specifies a user-defined mixed rate spectrum JSON file for propagation.
-
-**Usage**:
-
-.. code-block:: shell-session
-
-  gnpy-transmission-example my_network.json --spectrum <FILE.json>
-
-**Functionality**: This option allows users to define a custom spectrum for the simulation, which can
-include varying channel rates and configurations. More details here: :ref:`mixed-rate<mixed-rate>`.
-
-
-Options for `path_requests_run`
-===============================
-
-The `gnpy-path-request` script provides a simple path computation function that supports routing, transceiver mode selection, and spectrum assignment.
-
-It supports include and disjoint constraints for the path computation, but does not provide any optimisation.
-It requires two mandatory arguments: network file and service file (see :ref:`XLS files<excel-service-sheet>` or :ref:`JSON files<legacy-json>`).
-
-The `gnpy-path-request` computes:
-
-  - design network once and propagate the service requests on this design
-  - computes performance of each request defined in the service file independently from each other, considering full load (based on the request settings),
-  - assigns spectrum for each request according to the remaining spectrum, on a first arrived first served basis.
-    Lack of spectrum leads to blocking, but performance estimation is still returned for information.
-
-
-**Option**: `-bi`, `--bidir`
-----------------------------
-
-**Description**: Indicates that all demands are bidirectional.
-
-**Usage**:
-
-.. code-block:: shell-session
-
-  gnpy-path-request my_network.json my_service.json -e my_equipment.json -bi
-
-**Functionality**: This option allows users to specify that the performance of the service requests should be
-computed in both directions (source to destination and destination to source). This forces the 'bidirectional'
-attribute to true in the service file, possibly affecting feasibility if one direction is not feasible.
-
-
-**Option**: `-o`, `--output`
-----------------------------
-
-**Description**: Stores computation results requests into a JSON or CSV file.
-
-**Usage**: 
-
-.. code-block:: shell-session
-
-  gnpy-path-request my_network.json my_service.json -o <FILE.json|FILE.csv>
-
-**Functionality**: This option allows users to save the results of the path requests into a specified output file
-for further analysis.
-
-
-**Option**: `--redesign-per-request`
-------------------------------------
-
-**Description**: Redesigns the network for each request using the request as the reference channel
-(replaces the `SI` section of the equipment library with the request specifications).
-
-**Usage**:
-.. code-block:: shell-session
-
-  gnpy-path-request my_network.json my_services.json --redesign-per-request
-
-**Functionality**: This option enables checking different scenarios for design.

docs/concepts.rst

@@ -1,271 +0,0 @@
-.. _concepts:
-
-*****************************
-Simulating networks with GNPy
-*****************************
-
-Running simulations with GNPy requires three pieces of information:
-
-- the :ref:`network topology<concepts-topology>`, which describes how the network looks like, what are the fiber lengths, what amplifiers are used, etc.,
-- the :ref:`equipment library<concepts-equipment>`, which holds machine-readable datasheets of the equipment used in the network,
-- the :ref:`simulation options<concepts-simulation>` holding instructions about what to simulate, and under which conditions.
-
-.. _concepts-topology:
-
-Network Topology
-================
-
-The *topology* acts as a "digital self" of the simulated network.
-When given a network topology, GNPy can either run a specific simulation as-is, or it can *optimize* the topology before performing the simulation.
-
-A network topology for GNPy is often a generic, mesh network.
-This enables GNPy to take into consideration the current spectrum allocation as well as availability and resiliency considerations.
-When the time comes to run a particular *propagation* of a signal and its impairments are computed, though, a linear path through the network is used.
-For this purpose, the *path* through the network refers to an ordered, acyclic sequence of *nodes* that are processed.
-This path is directional, and all "GNPy elements" along the path match the unidirectional part of a real-world network equipment.
-
-.. note::
-  In practical terms, an amplifier in GNPy refers to an entity with a single input port and a single output port.
-  A real-world inline EDFA enclosed in a single chassis will be therefore represented as two GNPy-level amplifiers.
-
-The network topology contains not just the physical topology of the network, but also references to the :ref:`equipment library<concepts-equipment>` and a set of *operating parameters* for each entity.
-These parameters include the **fiber length** of each fiber, the connector **attenutation losses**, or an amplifier's specific **gain setting**.
-The topology is specified via :ref:`XLS files<excel>` or via :ref:`JSON<legacy-json>`.
-
-.. _complete-vs-incomplete:
-
-Fully Specified vs. Partially Designed Networks
------------------------------------------------
-
-Let's consider a simple triangle topology with three :abbr:`PoPs (Points of Presence)` covering three cities:
-
-.. graphviz::
-  :layout: neato
-  :align: center
-
-  graph "High-level topology with three PoPs" {
-    A -- B
-    B -- C
-    C -- A
-  }
-
-In the real world, each city would probably host a ROADM and some transponders:
-
-.. graphviz::
-  :layout: neato
-  :align: center
-
-  graph "Simplified topology with transponders" {
-    "ROADM A" [pos="2,2!"]
-    "ROADM B" [pos="4,2!"]
-    "ROADM C" [pos="3,1!"]
-    "Transponder A" [shape=box, pos="0,2!"]
-    "Transponder B" [shape=box, pos="6,2!"]
-    "Transponder C" [shape=box, pos="3,0!"]
-
-    "ROADM A" -- "ROADM B"
-    "ROADM B" -- "ROADM C"
-    "ROADM C" -- "ROADM A"
-
-    "Transponder A" -- "ROADM A"
-    "Transponder B" -- "ROADM B"
-    "Transponder C" -- "ROADM C"
-  }
-
-GNPy simulation works by propagating the optical signal over a sequence of elements, which means that one has to add some preamplifiers and boosters.
-The amplifiers are, by definition, unidirectional, so the graph becomes quite complex:
-
-.. _topo-roadm-preamp-booster:
-
-.. graphviz::
-  :layout: neato
-  :align: center
-
-  digraph "Preamps and boosters are explicitly modeled in GNPy" {
-    "ROADM A" [pos="2,4!"]
-    "ROADM B" [pos="6,4!"]
-    "ROADM C" [pos="4,0!"]
-    "Transponder A" [shape=box, pos="1,5!"]
-    "Transponder B" [shape=box, pos="7,5!"]
-    "Transponder C" [shape=box, pos="4,-1!"]
-
-    "Transponder A" -> "ROADM A"
-    "Transponder B" -> "ROADM B"
-    "Transponder C" -> "ROADM C"
-    "ROADM A" -> "Transponder A"
-    "ROADM B" -> "Transponder B"
-    "ROADM C" -> "Transponder C"
-
-    "Booster A C" [shape=triangle, orientation=-150, fixedsize=true, width=0.5, height=0.5, pos="2.2,3.2!", color=red, label=""]
-    "Preamp A C" [shape=triangle, orientation=0, fixedsize=true, width=0.5, height=0.5, pos="1.5,3.0!", color=red, label=""]
-    "ROADM A" -> "Booster A C"
-    "Preamp A C" -> "ROADM A"
-
-    "Booster A B" [shape=triangle, orientation=-90, fixedsize=true, width=0.5, height=0.5, pos="3,4.3!", color=red, fontcolor=red, labelloc=b, label="\N\n\n"]
-    "Preamp A B" [shape=triangle, orientation=90, fixedsize=true, width=0.5, height=0.5, pos="3,3.6!", color=red, fontcolor=red, labelloc=t, label="\n        \N"]
-    "ROADM A" -> "Booster A B"
-    "Preamp A B" -> "ROADM A"
-
-    "Booster C B" [shape=triangle, orientation=-30, fixedsize=true, width=0.5, height=0.5, pos="4.7,0.9!", color=red, label=""]
-    "Preamp C B" [shape=triangle, orientation=120, fixedsize=true, width=0.5, height=0.5, pos="5.4,0.7!", color=red, label=""]
-    "ROADM C" -> "Booster C B"
-    "Preamp C B" -> "ROADM C"
-
-    "Booster C A" [shape=triangle, orientation=30, fixedsize=true, width=0.5, height=0.5, pos="2.6,0.7!", color=red, label=""]
-    "Preamp C A" [shape=triangle, orientation=-30, fixedsize=true, width=0.5, height=0.5, pos="3.3,0.9!", color=red, label=""]
-    "ROADM C" -> "Booster C A"
-    "Preamp C A" -> "ROADM C"
-
-    "Booster B A" [shape=triangle, orientation=90, fixedsize=true, width=0.5, height=0.5, pos="5,3.6!", labelloc=t, color=red, fontcolor=red, label="\n\N        "]
-    "Preamp B A" [shape=triangle, orientation=-90, fixedsize=true, width=0.5, height=0.5, pos="5,4.3!", labelloc=b, color=red, fontcolor=red, label="\N\n\n"]
-    "ROADM B" -> "Booster B A"
-    "Preamp B A" -> "ROADM B"
-
-    "Booster B C" [shape=triangle, orientation=-180, fixedsize=true, width=0.5, height=0.5, pos="6.5,3.0!", color=red, label=""]
-    "Preamp B C" [shape=triangle, orientation=-20, fixedsize=true, width=0.5, height=0.5, pos="5.8,3.2!", color=red, label=""]
-    "ROADM B" -> "Booster B C"
-    "Preamp B C" -> "ROADM B"
-
-    "Booster A C" -> "Preamp C A"
-    "Booster A B" -> "Preamp B A"
-    "Booster C A" -> "Preamp A C"
-    "Booster C B" -> "Preamp B C"
-    "Booster B C" -> "Preamp C B"
-    "Booster B A" -> "Preamp A B"
-  }
-
-In many regions, the ROADMs are not placed physically close to each other, so the long-haul fiber links (:abbr:`OMS (Optical Multiplex Section)`) are split into individual spans (:abbr:`OTS (Optical Transport Section)`) by in-line amplifiers, resulting in an even more complicated topology graphs:
-
-.. graphviz::
-  :layout: neato
-  :align: center
-
-  digraph "A subset of a real topology with inline amplifiers" {
-    "ROADM A" [pos="2,4!"]
-    "ROADM B" [pos="6,4!"]
-    "ROADM C" [pos="4,-3!"]
-    "Transponder A" [shape=box, pos="1,5!"]
-    "Transponder B" [shape=box, pos="7,5!"]
-    "Transponder C" [shape=box, pos="4,-4!"]
-
-    "Transponder A" -> "ROADM A"
-    "Transponder B" -> "ROADM B"
-    "Transponder C" -> "ROADM C"
-    "ROADM A" -> "Transponder A"
-    "ROADM B" -> "Transponder B"
-    "ROADM C" -> "Transponder C"
-
-    "Booster A C" [shape=triangle, orientation=-166, fixedsize=true, width=0.5, height=0.5, pos="2.2,3.2!", label=""]
-    "Preamp A C" [shape=triangle, orientation=0, fixedsize=true, width=0.5, height=0.5, pos="1.5,3.0!", label=""]
-    "ROADM A" -> "Booster A C"
-    "Preamp A C" -> "ROADM A"
-
-    "Booster A B" [shape=triangle, orientation=-90, fixedsize=true, width=0.5, height=0.5, pos="3,4.3!", label=""]
-    "Preamp A B" [shape=triangle, orientation=90, fixedsize=true, width=0.5, height=0.5, pos="3,3.6!", label=""]
-    "ROADM A" -> "Booster A B"
-    "Preamp A B" -> "ROADM A"
-
-    "Booster C B" [shape=triangle, orientation=-30, fixedsize=true, width=0.5, height=0.5, pos="4.7,-2.1!", label=""]
-    "Preamp C B" [shape=triangle, orientation=10, fixedsize=true, width=0.5, height=0.5, pos="5.4,-2.3!", label=""]
-    "ROADM C" -> "Booster C B"
-    "Preamp C B" -> "ROADM C"
-
-    "Booster C A" [shape=triangle, orientation=20, fixedsize=true, width=0.5, height=0.5, pos="2.6,-2.3!", label=""]
-    "Preamp C A" [shape=triangle, orientation=-30, fixedsize=true, width=0.5, height=0.5, pos="3.3,-2.1!", label=""]
-    "ROADM C" -> "Booster C A"
-    "Preamp C A" -> "ROADM C"
-
-    "Booster B A" [shape=triangle, orientation=90, fixedsize=true, width=0.5, height=0.5, pos="5,3.6!", label=""]
-    "Preamp B A" [shape=triangle, orientation=-90, fixedsize=true, width=0.5, height=0.5, pos="5,4.3!", label=""]
-    "ROADM B" -> "Booster B A"
-    "Preamp B A" -> "ROADM B"
-
-    "Booster B C" [shape=triangle, orientation=-180, fixedsize=true, width=0.5, height=0.5, pos="6.5,3.0!", label=""]
-    "Preamp B C" [shape=triangle, orientation=-20, fixedsize=true, width=0.5, height=0.5, pos="5.8,3.2!", label=""]
-    "ROADM B" -> "Booster B C"
-    "Preamp B C" -> "ROADM B"
-
-    "Inline A C 1" [shape=triangle, orientation=-166, fixedsize=true, width=0.5, pos="2.4,2.2!", label="                             \N", color=red, fontcolor=red]
-    "Inline A C 2" [shape=triangle, orientation=-166, fixedsize=true, width=0.5, pos="2.6,1.2!", label="                             \N", color=red, fontcolor=red]
-    "Inline A C 3" [shape=triangle, orientation=-166, fixedsize=true, width=0.5, pos="2.8,0.2!", label="                             \N", color=red, fontcolor=red]
-    "Inline A C n" [shape=triangle, orientation=-166, fixedsize=true, width=0.5, pos="3.0,-1.1!", label="                             \N", color=red, fontcolor=red]
-
-    "Booster A C" -> "Inline A C 1"
-    "Inline A C 1" -> "Inline A C 2"
-    "Inline A C 2" -> "Inline A C 3"
-    "Inline A C 3" -> "Inline A C n" [style=dotted]
-    "Inline A C n" -> "Preamp C A"
-    "Booster A B" -> "Preamp B A" [style=dotted]
-    "Booster C A" -> "Preamp A C" [style=dotted]
-    "Booster C B" -> "Preamp B C" [style=dotted]
-    "Booster B C" -> "Preamp C B" [style=dotted]
-    "Booster B A" -> "Preamp A B" [style=dotted]
-  }
-
-In such networks, GNPy's autodesign features becomes very useful.
-It is possible to connect ROADMs via "tentative links" which will be replaced by a sequence of actual fibers and specific amplifiers.
-In other cases where the location of amplifier huts is already known, but the specific EDFA models have not yet been decided, one can put in amplifier placeholders and let GNPy assign the best amplifier.
-
-.. _concepts-equipment:
-
-The Equipment Library
-=====================
-
-In order to produce an accurate simulation, GNPy needs to know the physical properties of each entity which affects the optical signal.
-Entries in the equipment library correspond to actual real-world, tangible entities.
-Unlike a typical :abbr:`NMS (Network Management System)`, GNPy considers not just the active :abbr:`NEs (Network Elements)` such as amplifiers and :abbr:`ROADMs (Reconfigurable Optical Add/Drop Multiplexers)`, but also the passive ones, such as the optical fiber.
-
-As the signal propagates through the network, the largest source of optical impairments is the noise introduced from amplifiers.
-An accurate description of the :abbr:`EDFA (Erbium-Doped Fiber Amplifier)` and especially its noise characteristics is required.
-GNPy describes this property in terms of the **Noise Figure (NF)** of an amplifier model as a function of its operating point.
-
-The amplifiers compensate power losses induced on the signal in the optical fiber.
-The linear losses, however, are just one phenomenon of a multitude of effects that affect the signals in a long fiber run.
-While a more detailed description is available :ref:`in the literature<physical-model>`, for the purpose of the equipment library, the description of the *optical fiber* comprises its **linear attenutation coefficient**, a set of parameters for the **Raman effect**, optical **dispersion**, etc.
-
-Signals are introduced into the network via *transponders*.
-The set of parameters that are required describe the physical properties of each supported *mode* of the transponder, including its **symbol rate**, spectral **width**, etc.
-
-In the junctions of the network, *ROADMs* are used for spectrum routing.
-GNPy currently does not take into consideration the spectrum filtering penalties of the :abbr:`WSSes (Wavelength Selective Switches)`, but the equipment library nonetheless contains a list of required parameters, such as the attenuation options, so that the network can be properly simulated.
-
-.. _concepts-nf-model:
-
-Amplifier Noise Figure Models
------------------------------
-
-One of the key parameters of an amplifier is the method to use for computing the Noise Figure (NF).
-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 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:
-
-Min-max NF
-^^^^^^^^^^
-
-This is an operator-focused model where performance is defined by the *minimal* and *maximal NF*.
-These are especially suited to model a dual-coil EDFA with a VOA in between.
-In these amplifiers, the minimal NF is achieved when the EDFA operates at its maximal (and usually optimal, in terms of flatness) gain.
-The worst (maximal) NF applies  when the EDFA operates at its minimal gain.
-
-This model is suitable for use when the vendor has not provided a more accurate performance description of the EDFA.
-
-Raman Approximation
-^^^^^^^^^^^^^^^^^^^
-
-While GNPy is fully Raman-aware, under certain scenarios it is useful to be able to run a simulation without an accurate Raman description.
-For these purposes the :ref:`polynomial NF<ext-nf-model-polynomial-NF>` model with :math:`\text{a} = \text{b} = \text{c} = 0`, and :math:`\text{d} = NF` can be used.
-
-.. _concepts-simulation:
-
-Simulation
-==========
-
-When the network model has been instantiated and the physical properties and operational settings of the actual physical devices are known, GNPy can start simulating how the signal propagate through the optical fiber.
-
-This set of input parameters include options such as the *spectrum allocation*, i.e., the number of channels and their spacing.
-Various strategies for network optimization can be provided as well.

docs/conf.py

@@ -19,8 +19,6 @@
 #
 import os
 import sys
-
-
 sys.path.insert(0, os.path.abspath('../'))
 
 # -- General configuration ------------------------------------------------
@@ -33,18 +31,8 @@ sys.path.insert(0, os.path.abspath('../'))
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinx.ext.autodoc',
-              'sphinx.ext.mathjax',
-              'sphinx.ext.githubpages',
-              'sphinxcontrib.bibtex',
-              'sphinx.ext.graphviz',
-              'myst_parser',
-              'sphinx_rtd_theme',
-              ]
-
-myst_enable_extensions = [
-    "deflist",
-    "dollarmath",
-]
+    'sphinx.ext.mathjax',
+    'sphinx.ext.githubpages','sphinxcontrib.bibtex']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -60,15 +48,24 @@ master_doc = 'index'
 
 # General information about the project.
 project = 'gnpy'
-copyright = '2018 - 2021, Telecom Infra Project - OOPT PSE Group'
-author = 'Telecom Infra Project - OOPT PSE Group'
+copyright = '2018, Telecom InfraProject - OOPT PSE Group'
+author = 'Telecom InfraProject - OOPT PSE Group'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'en'
+language = None
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -87,24 +84,11 @@ todo_include_todos = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
-html_theme_options = {
-    'logo': 'images/GNPy-logo.png',
-    'logo_name': False,
-    'prev_next_buttons_location': 'bottom',
-    # Toc options
-    'collapse_navigation': True,
-    'sticky_navigation': True,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False
-}
-html_theme_options = {
-    'navigation_depth': 4,
-}
-html_favicon = 'images/GNPy-logo.png'
-
-html_logo = 'images/GNPy-logo.png'
+on_rtd = os.environ.get('READTHEDOCS') == 'True'
+if on_rtd:
+    html_theme = 'default'
+else:
+    html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -116,9 +100,6 @@ html_logo = 'images/GNPy-logo.png'
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-html_css_files = [
-    'custom.css',  # Inclure votre fichier CSS personnalisé
-]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -135,7 +116,6 @@ html_sidebars = {
     ]
 }
 
-html_secnum_depth = 4
 
 # -- Options for HTMLHelp output ------------------------------------------
 
@@ -168,7 +148,7 @@ latex_elements = {
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'gnpy.tex', 'gnpy Documentation',
-     'Telecom Infra Project - OOPT PSE Group', 'manual'),
+     'Telecom InfraProject - OOPT PSE Group', 'manual'),
 ]
 
 
@@ -193,13 +173,4 @@ texinfo_documents = [
      'Miscellaneous'),
 ]
 
-autodoc_default_options = {
-    'members': True,
-    'undoc-members': True,
-    'private-members': True,
-    'show-inheritance': True,
-}
-
-graphviz_output_format = 'svg'
-
-bibtex_bibfiles = ['biblio.bib']
+autodoc_default_flags = ['members', 'undoc-members', 'private-members', 'show-inheritance']

docs/extending.rst

@@ -1,173 +0,0 @@
-.. _extending:
-
-****************************************
-Extending GNPy with vendor-specific data
-****************************************
-
-GNPy ships with an :ref:`equipment library<concepts-equipment>` containing machine-readable datasheets of networking equipment.
-Vendors who are willing to contribute descriptions of their supported products are encouraged to `submit a patch <https://review.gerrithub.io/Documentation/intro-gerrit-walkthrough-github.html>`__ -- or just :ref:`get in touch with us directly<contributing>`.
-
-This chapter discusses option for modeling performance of :ref:`EDFA amplifiers<extending-edfa>`, :ref:`Raman amplifiers<extending-raman>`, :ref:`transponders<extending-transponder>` and :ref:`ROADMs<extending-roadm>`.
-
-.. _extending-edfa:
-
-EDFAs
-=====
-
-An accurate description of the :abbr:`EDFA (Erbium-Doped Fiber Amplifier)` and especially its noise characteristics is required.
-GNPy describes this property in terms of the **Noise Figure (NF)** of an amplifier model as a function of its operating point.
-GNPy supports several different :ref:`noise models<concepts-nf-model>`, and vendors are encouraged to pick one which describes performance of their equipment most accurately.
-
-.. _ext-nf-model-polynomial-NF:
-
-Polynomial NF
--------------
-
-This model computes the NF as a function of the difference between the optimal gain and the current gain.
-The NF is expressed as a third-degree polynomial:
-
-.. math::
-
-       f(x) &= \text{a}x^3 + \text{b}x^2 + \text{c}x + \text{d}
-
-  \text{NF} &= f(G - G_\text{max})
-
-This model can be also used for fixed-gain fixed-NF amplifiers.
-In that case, use:
-
-.. math::
-
-  a = b = c &= 0
-
-          d &= \text{NF}
-
-.. _ext-nf-model-polynomial-OSNR-OpenROADM:
-
-Polynomial OSNR (OpenROADM-style for inline amplifier)
-------------------------------------------------------
-
-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
-----------
-
-When the vendor prefers not to share the amplifier description in full detail, GNPy also supports describing the NF characteristics via the *minimal* and *maximal NF*.
-This approximates a more accurate polynomial description reasonably well for some models of a dual-coil EDFA with a VOA in between.
-In these amplifiers, the minimal NF is achieved when the EDFA operates at its maximal (and usually optimal, in terms of flatness) gain.
-The worst (maximal) NF applies  when the EDFA operates at the minimal gain.
-
-.. _ext-nf-model-dual-stage-amplifier:
-
-Dual-stage
-----------
-
-Dual-stage amplifier combines two distinct amplifiers.
-Vendors which provide an accurate description of their preamp and booster stages separately can use the dual-stage model for an aggregate description of the whole amplifier.
-
-.. _ext-nf-model-advanced:
-
-Advanced Specification
-----------------------
-
-The amplifier performance can be further described in terms of gain ripple, NF ripple, and the dynamic gain tilt.
-When provided, the amplifier characteristic is fine-tuned as a function of carrier frequency. Note that in this advanced
-specification tilt is defined vs frequency while tilt_target specified in EDFA instances is defined vs wavelength.
-
-.. _extending-raman:
-
-Raman Amplifiers
-================
-
-An accurate simulation of Raman amplification requires knowledge of:
-
-* the *power* and *wavelength* of all Raman pumping lasers,
-* the *direction*, whether it is co-propagating or counter-propagating,
-* the Raman efficiency of the fiber,
-* the fiber temperature.
-
-Under certain scenarios it is useful to be able to run a simulation without an accurate Raman description.
-For these purposes, it is possible to approximate a Raman amplifier via a fixed-gain EDFA with the :ref:`polynomial NF<ext-nf-model-polynomial-NF>` model using :math:`\text{a} = \text{b} = \text{c} = 0`, and a desired effective :math:`\text{d} = NF`.
-This is also useful to quickly approximate a hybrid EDFA+Raman amplifier.
-
-.. _extending-transponder:
-
-Transponders
-============
-
-Since transponders are usually capable of operating in a variety of modes, these are described separately.
-A *mode* usually refers to a particular performance point that is defined by a combination of the symbol rate, modulation format, and :abbr:`FEC (Forward Error Correction)`.
-
-The following data are required for each mode:
-
-``bit_rate``
-  Data bit rate, in :math:`\text{bits}\times s^{-1}`.
-``baud_rate``
-  Symbol modulation rate, in :math:`\text{baud}`.
-``OSNR``
-  Minimal required OSNR for the receiver. In :math:`\text{dB}`
-``tx-osnr``
-  Initial OSNR at the transmitter's output. In :math:`\text{dB}`
-``min-spacing``
-  Minimal grid spacing, i.e., an effective channel spectral bandwidth.
-  In :math:`\text{Hz}`.
-``roll-off``
-  Roll-off parameter (:math:`\beta`) of the TX pulse shaping filter.
-  This assumes a raised-cosine filter.
-``rx-power-min`` and ``rx-power-max``
-  (work in progress) The allowed range of power at the receiver.
-  In :math:`\text{dBm}`.
-``penalties``
-  Impairments such as Chromatic Dispersion (CD), Polarization Mode Dispersion (PMD), and Polarization Dispersion Loss (PDL)
-  result in penalties at the receiver. The receiver's ability to handle these impairments can be defined for each mode as
-  a list of {impairment: in defined units, 'penalty_value' in dB} (see `transceiver section here <json.rst#_transceiver>`).
-  Maximum allowed CD, maximum allowed PMD, and maximum allowed PDL should be listed there with corresponding penalties.
-  Impairments experienced during propagation are linearly interpolated between given points to obtain the corresponding penalty.
-  The accumulated penalties are subtracted from the path GSNR before comparing with the minimum required OSNR.
-  Impairments: PMD in :math:`\text{ps}`, CD in :math:`\text{ps/nm}`, PDL in :math:`\text{dB}`, penalty_value in :math:`\text{dB}`
-
-
-GNPy does not directly track the FEC performance, so the type of chosen FEC is likely indicated in the *name* of the selected transponder mode alone.
-
-.. _extending-roadm:
-
-ROADMs
-======
-
-In a :abbr:`ROADM (Reconfigurable Add/Drop Multiplexer)`, GNPy simulates the impairments of the preamplifiers and boosters of line degrees :ref:`separately<topo-roadm-preamp-booster>`.
-The set of parameters for each ROADM model therefore includes:
-
-``add-drop-osnr``
-  OSNR penalty introduced by the Add and Drop stages of this ROADM type.
-``target-channel-out-power``
-  Per-channel target TX power towards the egress amplifier.
-  Within GNPy, a ROADM is expected to attenuate any signal that enters the ROADM node to this level.
-  This can be overridden on a per-link in the network topology.
-  Targets can be set using power or power spectral density (see `roadm section here <json.rst#__roadm>`)
-``pmd``
-  Polarization mode dispersion (PMD) penalty of the express path.
-  In :math:`\text{ps}`.
-
-Provisions are in place to define the list of all allowed booster and preamplifier types.
-This is useful for specifying constraints on what amplifier modules fit into ROADM chassis, and when using fully disaggregated ROADM topologies as well.

docs/gnpy-api-core.rst

@@ -1,13 +0,0 @@
-``gnpy.core``
--------------
-
-.. automodule:: gnpy.core
-.. automodule:: gnpy.core.ansi_escapes
-.. automodule:: gnpy.core.elements
-.. automodule:: gnpy.core.equipment
-.. automodule:: gnpy.core.exceptions
-.. automodule:: gnpy.core.info
-.. automodule:: gnpy.core.network
-.. automodule:: gnpy.core.parameters
-.. automodule:: gnpy.core.science_utils
-.. automodule:: gnpy.core.utils

docs/gnpy-api-tools.rst

@@ -1,10 +0,0 @@
-``gnpy.tools``
---------------
-
-.. automodule:: gnpy.tools
-.. automodule:: gnpy.tools.cli_examples
-.. automodule:: gnpy.tools.convert
-.. automodule:: gnpy.tools.json_io
-.. automodule:: gnpy.tools.plots
-.. automodule:: gnpy.tools.service_sheet
-.. automodule:: gnpy.tools.worker_utils

docs/gnpy-api-topology.rst

@@ -1,6 +0,0 @@
-``gnpy.topology``
------------------
-
-.. automodule:: gnpy.topology
-.. automodule:: gnpy.topology.request
-.. automodule:: gnpy.topology.spectrum_assignment

docs/gnpy-api.rst

@@ -1,14 +0,0 @@
-***************************
-API Reference Documentation
-***************************
-
-GNPy package
-============
-
-.. automodule:: gnpy
-
-.. toctree::
-
-   gnpy-api-core
-   gnpy-api-topology
-   gnpy-api-tools

docs/index.rst

@@ -1,36 +1,102 @@
-************************************
-GNPy: Optical Route Planning Library
-************************************
+.. gnpy documentation master file, created by
+   sphinx-quickstart on Mon Dec 18 14:41:01 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
 
-`GNPy <http://github.com/telecominfraproject/gnpy>`_ is an open-source,
-community-developed library for building route planning and optimization tools
-in real-world mesh optical networks. It is based on the Gaussian Noise Model.
+Welcome to gnpy's documentation!
+================================
+
+**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/gnpy>`_ is:
+
+- a sponsored project of the `OOPT/PSE <http://telecominfraproject.com/project-groups-2/backhaul-projects/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
+=============
+
+The following pages are meant to describe specific implementation details and
+modeling assumptions behind gnpy. 
 
 .. toctree::
-   :maxdepth: 4
-   :caption: Contents
+   :maxdepth: 2
 
-   intro 
-   concepts
-   install
-   cli_options
-   amplifier_models_description
-   json
-   json_instance_examples
-   excel
-   extending
-   about-project
    model
-   gnpy-api
-   release-notes
-   publications
-   genindex
-   modindex
 
 Indices and tables
-------------------
+==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
 
+Contributors in alphabetical order
+==================================
++----------+------------+-----------------------+--------------------------------------+
+| Name     | Surname    | Affiliation           | Contact                              |
++==========+============+=======================+======================================+
+| Alessio  | Ferrari    | Politecnico di Torino | alessio.ferrari@polito.it            |
++----------+------------+-----------------------+--------------------------------------+
+| Anders   | Lindgren   | Telia Company         | Anders.X.Lindgren@teliacompany.com   |
++----------+------------+-----------------------+--------------------------------------+
+| Andrea   | d'Amico    | Politecnico di Torino | andrea.damico@polito.it              |
++----------+------------+-----------------------+--------------------------------------+
+| Brian    | Taylor     | Facebook              | briantaylor@fb.com                   |
++----------+------------+-----------------------+--------------------------------------+
+| David    | Boertjes   | Ciena                 | dboertje@ciena.com                   |
++----------+------------+-----------------------+--------------------------------------+
+| Diego    | Landa      | Facebook              | dlanda@fb.com                        |
++----------+------------+-----------------------+--------------------------------------+
+| Esther   | Le Rouzic  | Orange                | esther.lerouzic@orange.com           |
++----------+------------+-----------------------+--------------------------------------+
+| Gabriele | Galimberti | Cisco                 | ggalimbe@cisco.com                   |
++----------+------------+-----------------------+--------------------------------------+
+| Gert     | Grammel    | Juniper Networks      | ggrammel@juniper.net                 |
++----------+------------+-----------------------+--------------------------------------+
+| Gilad    | Goldfarb   | Facebook              | giladg@fb.com                        |
++----------+------------+-----------------------+--------------------------------------+
+| James    | Powell     | Telecom Infra Project | james.powell@telecominfraproject.com |
++----------+------------+-----------------------+--------------------------------------+
+| Jan      | Kundrát    | Telecom Infra Project | jan.kundrat@telecominfraproject.com  |
++----------+------------+-----------------------+--------------------------------------+
+| Jeanluc  | Augé       | Orange                | jeanluc.auge@orange.com              |
++----------+------------+-----------------------+--------------------------------------+
+| Jonas    | Mårtensson | RISE Research Sweden  | jonas.martensson@ri.se               |
++----------+------------+-----------------------+--------------------------------------+
+| Mattia   | Cantono    | Politecnico di Torino | mattia.cantono@polito.it             |
++----------+------------+-----------------------+--------------------------------------+
+| Miguel   | Garrich    | University Catalunya  | miquel.garrich@upct.es               |
++----------+------------+-----------------------+--------------------------------------+
+| Raj      | Nagarajan  | Lumentum              | raj.nagarajan@lumentum.com           |
++----------+------------+-----------------------+--------------------------------------+
+| Roberts  | Miculens   | Lattelecom            | roberts.miculens@lattelecom.lv       |
++----------+------------+-----------------------+--------------------------------------+
+| Shengxiang | Zhu      | University of Arizona | szhu@email.arizona.edu               |
++----------+------------+-----------------------+--------------------------------------+
+| Stefan   | Melin      | Telia Company         | Stefan.Melin@teliacompany.com        |
++----------+------------+-----------------------+--------------------------------------+
+| Vittorio | Curri      | Politecnico di Torino | vittorio.curri@polito.it             |
++----------+------------+-----------------------+--------------------------------------+
+| Xufeng   | Liu        | Jabil                 | xufeng_liu@jabil.com                 |
++----------+------------+-----------------------+--------------------------------------+
+
+--------------
+
+- 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.
+

docs/install.rst

@@ -1,112 +0,0 @@
-***************
-Installing GNPy
-***************
-
-There are several methods on how to obtain GNPy.
-The easiest option for a non-developer is probably going via our :ref:`Docker images<install-docker>`.
-Developers are encouraged to install the :ref:`Python package in the same way as any other Python package<install-pip>`.
-Note that this needs a :ref:`working installation of Python<install-python>`, for example :ref:`via Anaconda<install-anaconda>`.
-
-.. _install-docker:
-
-Using prebuilt Docker images
-============================
-
-Our `Docker images <https://hub.docker.com/r/telecominfraproject/oopt-gnpy>`_ contain everything needed to run all examples from this guide.
-Docker transparently fetches the image over the network upon first use.
-On Linux and Mac, run:
-
-
-.. code-block:: shell-session
-
-    $ docker run -it --rm --volume $(pwd):/shared telecominfraproject/oopt-gnpy
-    root@bea050f186f7:/shared/example-data#
-
-On Windows, launch from Powershell as:
-
-.. code-block:: console
-
-    PS C:\> docker run -it --rm --volume ${PWD}:/shared telecominfraproject/oopt-gnpy
-    root@89784e577d44:/shared/example-data#
-
-In both cases, a directory named ``example-data/`` will appear in your current working directory.
-GNPy automaticallly populates it with example files from the current release.
-Remove that directory if you want to start from scratch.
-
-.. _install-python:
-
-Using Python on your computer
-=============================
-
-   **Note**: `gnpy` supports Python 3 only. Python 2 is not supported.
-   `gnpy` requires Python ≥3.8
-
-   **Note**: the `gnpy` maintainers strongly recommend the use of Anaconda for
-   managing dependencies.
-
-It is recommended that you use a "virtual environment" when installing `gnpy`.
-Do not install `gnpy` on your system Python.
-
-.. _install-anaconda:
-
-We recommend the use of the `Anaconda Python distribution <https://www.anaconda.com/download>`_ which comes with many scientific computing
-dependencies pre-installed. Anaconda creates a base "virtual environment" for
-you automatically. You can also create and manage your ``conda`` "virtual
-environments" yourself (see:
-https://conda.io/docs/user-guide/tasks/manage-environments.html)
-
-To activate your Anaconda virtual environment, you may need to do the
-following:
-
-.. code-block:: shell-session
-
-    $ source /path/to/anaconda/bin/activate # activate Anaconda base environment
-    (base) $                                # note the change to the prompt
-
-You can check which Anaconda environment you are using with:
-
-.. code-block:: shell-session
-
-    (base) $ conda env list                          # list all environments
-    # conda environments:
-    #
-    base                  *  /src/install/anaconda3
-
-    (base) $ echo $CONDA_DEFAULT_ENV                 # show default environment
-    base
-
-You can check your version of Python with the following. If you are using
-Anaconda's Python 3, you should see similar output as below. Your results may
-be slightly different depending on your Anaconda installation path and the
-exact version of Python you are using.
-
-.. code-block:: shell-session
-
-    $ which python                   # check which Python executable is used
-    /path/to/anaconda/bin/python
-    $ python -V                      # check your Python version
-    Python 3.8.0 :: Anaconda, Inc.
-
-.. _install-pip:
-
-Installing the Python package
------------------------------
-
-From within your Anaconda Python 3 environment, you can clone the master branch
-of the `gnpy` repo and install it with:
-
-.. code-block:: shell-session
-
-    $ git clone https://github.com/Telecominfraproject/oopt-gnpy # clone the repo
-    $ cd oopt-gnpy
-    $ pip install --editable . # note the trailing dot
-
-To test that `gnpy` was successfully installed, you can run this command. If it
-executes without a ``ModuleNotFoundError``, you have successfully installed
-`gnpy`.
-
-.. code-block:: shell-session
-
-    $ python -c 'import gnpy' # attempt to import gnpy
-
-    $ pytest                  # run tests

docs/intro.rst

@@ -1,97 +0,0 @@
-.. _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 maintainers
-    esther Le Rouzic <esther.lerouzic@orange.com>, Andrea D'Amico <adamico@nec-labs.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,
-or to run a planning script to check SNR of several services:
-
-.. image:: images/gnpy-transmission-example.svg
-   :width: 100%
-   :align: left
-   :alt: Running a simple simulation example
-
-By default, the gnpy-transmission-example script operates on a single span network defined in
-`gnpy/example-data/edfa_example_network.json <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/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 <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/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 <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/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 <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 <json.rst>`__ or `XLS <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 in fiber spans 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 <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/gnpy/example-data/raman_edfa_example_network.json>`_.
-General numeric parameters for simulation control are provided in the `gnpy/example-data/sim_params.json <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/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 <json.rst>`__ or `Excel <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/model.rst

@@ -1,11 +1,8 @@
-.. _physical-model:
-
-***************************
-Physical Model used in GNPy
-***************************
+The QoT estimation in the PSE framework of TIP-OOPT
+=======================================================
 
 QoT-E including ASE noise and NLI accumulation 
-==============================================
+----------------------------------------------
 
 The operations of PSE simulative framework are based on the capability to
 estimate the QoT of one or more channels operating lightpaths over a given
@@ -84,7 +81,7 @@ ps/nm/km, the analytical approximation ensures an excellent accuracy
 with a computational time compatible with real-time operations.
 
 The Gaussian Noise Model to evaluate the NLI
-============================================
+--------------------------------------------
 
 As previously stated, fiber propagation of multilevel modulation formats
 relying on the polarization-division-multiplexing  generates impairments that
@@ -127,9 +124,9 @@ that can be easily evaluated extending the FWM theory from a set of discrete
 tones - the standard FWM theory introduced back in the 90s by Inoue
 :cite:`Innoue-FWM`- to a continuity of tones, possibly spectrally shaped.
 Signals propagating in the fiber are not equivalent to Gaussian noise, but
-thanks to the absence of in-line compensation for chromatic dispersion, the
+thanks to the absence of in-line compensation for choromatic dispersion, the
 become so, over short distances.  So, the Gaussian noise model with incoherent
-accumulation of NLI has extensively proved to be a quick yet accurate and
+accumulation of NLI has estensively proved to be a quick yet accurate and
 conservative tool to estimate propagation impairments of fiber propagation.
 Note that the GN-model has not been derived with the aim of an *exact*
 performance estimation, but to pursue a conservative performance prediction.
@@ -146,4 +143,4 @@ Raman Scattering in order to give a proper estimation for all channels
 :cite:`cantono2018modeling`.  This will be the main upgrade required within the
 PSE framework.
 
-.. bibliography::
+.. bibliography:: biblio.bib  

docs/publications.rst

@@ -1,25 +0,0 @@
-.. _publications:
-
-************
-Publications
-************
-
-Below is a chronological list of notable publications that emerged from the PSE group's collaborative work.
-These articles detail the evolution of GNPy and confirm its performance through experimental trials:
-
-- `G. Grammel, V. Curri, and J. Auge, "Physical Simulation Environment of The Telecommunications Infrastructure Project (TIP)," in Optical Fiber Communication Conference, OSA Technical Digest (online) (Optica Publishing Group, 2018), paper M1D.3. <https://opg.optica.org/abstract.cfm?uri=OFC-2018-M1D.3>`_
-- `B. D. Taylor, G. Goldfarb, S. Bandyopadhyay, V. Curri, and H. Schmidtke, "Towards a Route Planning Tool for Open Optical Networks in the Telecom Infrastructure Project," in Optical Fiber Communication Conference, OSA Technical Digest (online) (Optica Publishing Group, 2018), paper Tu3E.4. <https://opg.optica.org/abstract.cfm?uri=OFC-2018-Tu3E.4>`_
-- `M. Filer, M. Cantono, A. Ferrari, G. Grammel, G. Galimberti, and V. Curri, "Multi-Vendor Experimental Validation of an Open Source QoT Estimator for Optical Networks," J. Lightwave Technol. 36, 3073-3082 (2018). <https://opg.optica.org/jlt/abstract.cfm?uri=jlt-36-15-3073>`_
-- `J. Auge, G. Grammel, E. le Rouzic, V. Curri, G. Galimberti, and J. Powell, "Open optical network planning demonstration," in Optical Fiber Communication Conference (OFC) 2019, OSA Technical Digest (Optica Publishing Group, 2019), paper M3Z.9. <https://opg.optica.org/abstract.cfm?uri=OFC-2019-M3Z.9>`_
-- `J. Kundrát, A. Campanella, E. Le Rouzic, A. Ferrari, O. Havliš, M. Hažlinský, G. Grammel, G. Galimberti, and V. Curri, "Physical-Layer Awareness: GNPy and ONOS for End-to-End Circuits in Disaggregated Networks," in Optical Fiber Communication Conference (OFC) 2020, OSA Technical Digest (Optica Publishing Group, 2020), paper M3Z.17. <https://opg.optica.org/abstract.cfm?uri=ofc-2020-m3z.17>`_
-- `A. Ferrari, M. Filer, K. Balasubramanian, Y. Yin, E. Le Rouzic, J. Kundrát, G. Grammel, G. Galimberti, and V. Curri, "Experimental Validation of an Open Source Quality of Transmission Estimator for Open Optical Networks," in Optical Fiber Communication Conference (OFC) 2020, OSA Technical Digest (Optica Publishing Group, 2020), paper W3C.2. <https://opg.optica.org/abstract.cfm?uri=ofc-2020-W3C.2>`_
-- `A. Ferrari, M. Filer, K. Balasubramanian, Y. Yin, E. Le Rouzic, J. Kundrát, G. Grammel, G. Galimberti, and V. Curri, "GNPy: an open source application for physical layer aware open optical networks," J. Opt. Commun. Netw. 12, C31-C40 (2020). <https://opg.optica.org/jocn/fulltext.cfm?uri=jocn-12-6-C31&id=429003>`_
-- `A. Ferrari, K. Balasubramanian, M. Filer, Y. Yin, E. Le Rouzic, J. Kundrát, G. Grammel, G. Galimberti, and V. Curri, "Softwarized Optical Transport QoT in Production Optical Network: a Brownfield Validation," 2020 European Conference on Optical Communications (ECOC), Brussels, Belgium, 2020. <https://ieeexplore.ieee.org/document/9333280>`_
-- `A. Ferrari, K. Balasubramanian, M. Filer, Y. Yin, E. Le Rouzic, J. Kundrát, G. Grammel, G. Galimberti, and V. Curri, "Assessment on the in-field lightpath QoT computation including connector loss uncertainties," in Journal of Optical Communications and Networking, vol. 13, no. 2, pp. A156-A164, February 2021. <https://ieeexplore.ieee.org/document/9308057>`_
-- `J. Kundrát, E. Le Rouzic, J. Mårtensson, A. Campanella, O. Havliš, A. D’Amico, G. Grammel, G. Galimberti, V. Curri, and J. Vojtěch, "GNPy & YANG: Open APIs for End-to-End Service Provisioning in Optical Networks," in Optical Fiber Communication Conference (OFC) 2021, P. Dong, J. Kani, C. Xie, R. Casellas, C. Cole, and M. Li, eds., OSA Technical Digest (Optica Publishing Group, 2021), paper M1B.6. <https://opg.optica.org/abstract.cfm?uri=ofc-2021-M1B.6>`_
-- `A. D’Amico, E. London, B. Le Guyader, F. Frank, E. Le Rouzic, E. Pincemin, N. Brochier, and V. Curri, "GNPy experimental validation on flex-grid, flex-rate WDM optical transport scenarios," in Optical Fiber Communication Conference (OFC) 2021, P. Dong, J. Kani, C. Xie, R. Casellas, C. Cole, and M. Li, eds., OSA Technical Digest (Optica Publishing Group, 2021), paper W1G.2. <https://opg.optica.org/abstract.cfm?uri=ofc-2021-W1G.2>`_
-- `E. Virgillito, R. Braun, D. Breuer, A. Gladisch, V. Curri, and G. Grammel, "Testing TIP Open Source Solutions in Deployed Optical Networks," in Optical Fiber Communication Conference (OFC) 2021, P. Dong, J. Kani, C. Xie, R. Casellas, C. Cole, and M. Li, eds., OSA Technical Digest (Optica Publishing Group, 2021), paper F1C.3. <https://opg.optica.org/abstract.cfm?uri=ofc-2021-F1C.3>`_
-- `A. D’Amico, E. London, B. Le Guyader, F. Frank, E. Le Rouzic, E. Pincemin, N. Brochier, and V. Curri, "Experimental validation of GNPy in a multi-vendor flex-grid flex-rate WDM optical transport scenario," J. Opt. Commun. Netw. 14, 79-88 (2022). <https://opg.optica.org/jocn/fulltext.cfm?uri=jocn-14-3-79&id=466355>`_
-- `J. Kundrát, E. Le Rouzic, J. Mårtensson, S. Melin, A. D’Amico, G. Grammel, G. Galimberti, and V. Curri, "GNPy: Lessons Learned and Future Plans [Invited]," in European Conference on Optical Communication (ECOC) 2022, J. Leuthold, C. Harder, B. Offrein, and H. Limberger, eds., Technical Digest Series (Optica Publishing Group, 2022), paper We3B.6. <https://opg.optica.org/abstract.cfm?uri=ECEOC-2022-We3B.6>`_
-- `G. Grammel, J. Kundrat, E. Le Rouzic, S. Melin, V. Curri, A. D'Amico, R. Manzotti, "Open Optical Networks: the good, the bad and the ugly," 49th European Conference on Optical Communications (ECOC 2023), Hybrid Conference, Glasgow, UK, 2023. <https://ieeexplore.ieee.org/document/10484723>`_
-- `A. D’Amico, V. Gatto, A. Nespola, G. Borraccini, Y. Jiang, P. Poggiolini, E. Le Rouzic,  A. M. L. de Lerma, G. Grammel, R. Manzotti, V. Curri, "GNPy Experimental Validation in a C+L Multiband Optical Multiplex Section," 2024 24th International Conference on Transparent Optical Networks (ICTON), Bari, Italy, 2024. <https://ieeexplore.ieee.org/document/10648172>`_

docs/release-notes.rst

@@ -1,527 +0,0 @@
-.. _release-notes:
-
-******************
-Release change log
-******************
-
-Each release introduces some changes and new features.
-
-(prepare text for next release)
-
-v2.13
-=====
-
-**Environment**
-
-The windows-2019 environment is no more supported.
-
-**Yang Conversion Utilities**
-
-This release introduces new conversion utilities to facilitate conversion between YANG and legacy formats,
-ensuring full compatibility with GNPy. The "legacy" format also benefit from the YANG validation for
-a stricter verification of input files.
-Console Script for Yang Conversion: Added a new command-line script to perform Yang format conversions easily.
-
-**Design Enhancements**
-
-This release adds the ability to parametrize power target calculations, allowing customization of reference
-span loss and deviation ratios. It implements the use of a reference channel per OMS (Optical Multiplex Section)
-instead of total power for design calculations, improving accuracy and performance.
-It also includes spacing information in design band data to assist in maximum power computation for EDFA
-targets compution during autodesign.
-
-**Excel handling**
-
-XLSX files are now read with openpyxl library (while XLS files are still read with xlrd library). Latest release of
-xlrd is supported, which solves compatibility issues with anaconda install.
-
-v2.12
-=====
-
-**Important Changes:**
-
-The default values for EDFA configuration, including frequency range, gain ripple, noise figure ripple, or dynamic gain tilt
-are now hardcoded in parameters.py and are no longer read from the default_edfa_config.json file (the file has been removed).
-However, users can define their own custom parameters using the default_config_from_json variable, which should be populated with a file name containing the desired parameter description. This applies to both variable_gain and fixed_gain amplifier types.
-
-This change streamlines the configuration process but requires users to explicitly set parameters through the new
-model if the default values do not suit their needs via the --extra-config option.
-
-v2.11.1
--------
-
-**Environment**
-
-The macOS-12 environment is no more supported.
-
-**per degree impairment enabled in xls input**
-
-This release now read per degre roadm-path impairment from roadm sheet
-Several optional columns are added: 'type_variety' and 'from degrees'
-and 'from degree to degree impairment id'.
-
-- 'from degrees' can contain a list of degrees separated with ' | ', then the
-  'from degree to degree impairment id' must contain a list of ids of the same
-  length.
-
-Impairment ids are expected to be defined in the ROADM equipment library and
-from degree must be among the previous node from this ROADM.
-
-**optimizing computation speed**
-The computation of path is skipped if the provided include nodes provides
-a complete explicit path (speeds simulation time).
-
-v2.11
-=====
-
-**New feature**
-
-A new type_def for amplifiers has been introduced: multi_band. This allows the definition of a
-multiband amplifier site composed of several amplifiers per band (a typical application is C+L transmission). The
-release also includes autodesign for links (Optical Multiplex Section, OMS) composed of multi_band amplifiers.
-Multi_band autodesign includes basic tilt and tilt_target calculation when the Raman flag is enabled with the
---sim-params option. The spectrum is demultiplexed before propagation in the amplifier and multiplexed in the output
-fiber at the amplifier output.
-
-
-In the library:
-
-    .. code-block:: json
-
-        {
-            "type_variety": "std_medium_gain_C",
-            "f_min": 191.225e12,
-            "f_max": 196.125e12,
-            "type_def": "variable_gain",
-            "gain_flatmax": 26,
-            "gain_min": 15,
-            "p_max": 21,
-            "nf_min": 6,
-            "nf_max": 10,
-            "out_voa_auto": false,
-            "allowed_for_design": false
-        },
-        {
-            "type_variety": "std_medium_gain_L",
-            "f_min": 186.5e12,
-            "f_max": 190.1e12,
-            "type_def": "variable_gain",
-            "gain_flatmax": 26,
-            "gain_min": 15,
-            "p_max": 21,
-            "nf_min": 6,
-            "nf_max": 10,
-            "out_voa_auto": false,
-            "allowed_for_design": true
-        },
-        {
-            "type_variety": "std_medium_gain_multiband",
-            "type_def": "multi_band",
-            "amplifiers": [
-                "std_medium_gain_C",
-                "std_medium_gain_L"
-            ],
-            "allowed_for_design": false
-        },
-
-In the network topology:
-
-    .. code-block:: json
-
-      {
-          "uid": "east edfa in Site_A to Site_B",
-          "type": "Multiband_amplifier",
-          "type_variety": "std_medium_gain_multiband",
-          "amplifiers": [{
-                  "type_variety": "std_medium_gain_C",
-                  "operational": {
-                      "gain_target": 22.55,
-                      "delta_p": 0.9,
-                      "out_voa": 3.0,
-                      "tilt_target": 0.0
-                  }
-              }, {
-                  "type_variety": "std_medium_gain_L",
-                  "operational": {
-                      "gain_target": 21,
-                      "delta_p": 3.0,
-                      "out_voa": 3.0,
-                      "tilt_target": 0.0
-                  }
-              }
-          ]
-      }
-
-**Network design**
-
-Optionally, users can define a design target per OMS (single or multi-band), with specific frequency ranges.
-Default design bands are defined in the SI.
-
-    .. code-block:: json
-
-      {
-          "uid": "roadm Site_A",
-          "type": "Roadm",
-          "params": {
-              "target_pch_out_db": -20,
-              "design_bands": [{"f_min": 191.3e12, "f_max": 195.1e12}]
-          }
-      }
-
-It is possible to define a set of bands in the SI block instead of a single Spectrum Information.
-In this case type_variety must be used.
-Each set defines a reference channel used for design functions and autodesign.
-
-The default design settings for the path-request-run script have been modified.
-Now, design is performed once for the reference channel defined in the SI block of the eqpt_config,
-and requests are propagated based on this design.
-The --redesign-per-request option can be used to restore previous behaviour
-(design using request channel types).
-
-The autodesign function has been updated to insert multiband booster, preamp or inline amplifiers based on the OMS
-nature. If nothing is stated (no amplifier defined in the OMS, no design_bands attribute in the ROADM), then
-it uses single band Edfas.
-
-**Propagation**
-
-Only carriers within the amplifier bandwidth are propagated, improving system coherence. This more rigorous checking
-of the spectrum to be propagated and the amplifier bandwidth may lead to changes in the total number of channels
-compared to previous releases. The range can be adjusted by changing the values ​​of ``f_min`` and ``f_max``
-in the amplifier library.
-
-
-``f_min`` and ``f_max`` represent the boundary frequencies of the amplification bandwidth (the entire channel must fit
-within this range).
-In the example below, a signal center frequency of 190.05THz with a 50GHz width cannot fit within the amplifier band.
-Note that this has a different meaning in the SI or Transceiver blocks, where ``f_min`` and ``f_max`` refers to the
-minimum / maximum values of the carrier center frequency.
-
-    .. code-block:: json
-
-      {
-          "type_variety": "std_booster_L",
-          "f_min": 186.55e12,
-          "f_max": 190.05e12,
-          "type_def": "fixed_gain",
-          "gain_flatmax": 21,
-          "gain_min": 20,
-          "p_max": 21,
-          "nf0": 5,
-          "allowed_for_design": false
-      }
-
-
-**Display**
-
-The CLI output for the transmission_main_example now displays the channels used for design and simulation,
-as well as the tilt target of amplifiers.
-
-  .. code-block:: text
-
-    Reference used for design: (Input optical power reference in span = 0.00dBm,
-                                spacing = 50.00GHz
-                                nb_channels = 76)
-
-    Channels propagating: (Input optical power deviation in span = 0.00dB,
-                          spacing = 50.00GHz,
-                          transceiver output power = 0.00dBm,
-                          nb_channels = 76)
-
-The CLI output displays the settings of each amplifier:
-
-  .. code-block:: text
-
-    Multiband_amplifier east edfa in Site_A to Site_B
-      type_variety:           std_medium_gain_multiband
-      type_variety:           std_medium_gain_C    type_variety:           std_medium_gain_L
-      effective gain(dB):     20.90                effective gain(dB):     22.19
-      (before att_in and before output VOA)        (before att_in and before output VOA)
-      tilt-target(dB)         0.00                 tilt-target(dB)         0.00
-      noise figure (dB):      6.38                 noise figure (dB):      6.19
-      (including att_in)                           (including att_in)
-      pad att_in (dB):        0.00                 pad att_in (dB):        0.00
-      Power In (dBm):         -1.08                Power In (dBm):         -1.49
-      Power Out (dBm):        19.83                Power Out (dBm):        20.71
-      Delta_P (dB):           0.90                 Delta_P (dB):           2.19
-      target pch (dBm):       0.90                 target pch (dBm):       3.00
-      actual pch out (dBm):   -2.09                actual pch out (dBm):   -0.80
-      output VOA (dB):        3.00                 output VOA (dB):        3.00
-
-
-**New feature**
-
-The preturbative Raman and the approximated GGN models are introduced for a faster evaluation of the Raman and
-Kerr effects, respectively.
-These implementation are intended to reduce the computational effort required by multiband transmission scenarios.
-
-Both the novel models have been validated with exstensive simulations
-(see `arXiv:2304.11756 <https://arxiv.org/abs/2304.11756>`_ for the new Raman model and
-`jlt:9741324 <https://eeexplore.ieee.org/document/9741324>`_ for the new NLI model).
-Additionally, they have been experimentally validated in a laboratory setup composed of commertial equipment
-(see `icton:10648172 <https://eeexplore.ieee.org/document/10648172>`_).
-
-
-v2.10
-=====
-
-ROADM impairments can be defined per degree and roadm-path type (add, drop or express).
-Minimum loss when crossing a ROADM is no more 0 dB. It can be set per ROADM degree with roadm-path-impairments.
-
-The transceiver output power, which was previously set using the same parameter as the input span power (power_dbm),
-can now be set using a different parameter. It can be set as:
-
-  - for all channels, with tx_power_dbm using SI similarly to tx_osnr (gnpy-transmission-example script)
-
-    .. code-block:: json
-
-      "SI": [{
-              "f_min": 191.35e12,
-              "baud_rate": 32e9,
-              "f_max": 196.1e12,
-              "spacing": 50e9,
-              "power_dbm": 3,
-              "power_range_db": [0, 0, 1],
-              "roll_off": 0.15,
-              "tx_osnr": 40,
-              "tx_power_dbm": -10,
-              "sys_margins": 2
-          }
-      ]
-
-  - for certain channels, using -spectrum option and tx_channel_power_dbm option (gnpy-transmission-example script).
-
-    .. code-block:: json
-
-      {
-        "spectrum": [
-          {
-            "f_min": 191.35e12,
-            "f_max":193.1e12,
-            "baud_rate": 32e9,
-            "slot_width": 50e9,
-            "power_dbm": 0,
-            "roll_off": 0.15,
-            "tx_osnr": 40
-          },
-          {
-            "f_min": 193.15e12,
-            "f_max":193.15e12,
-            "baud_rate": 32e9,
-            "slot_width": 50e9,
-            "power_dbm": 0,
-            "roll_off": 0.15,
-            "tx_osnr": 40,
-            "tx_power_dbm": -10
-          },
-          {
-            "f_min": 193.2e12,
-            "f_max":195.1e12,
-            "baud_rate": 32e9,
-            "slot_width": 50e9,
-            "power_dbm": 0,
-            "roll_off": 0.15,
-            "tx_osnr": 40
-          }
-        ]
-      }
-
-  - per service using the additional parameter ``tx_power`` which similarly to ``power`` should be defined in Watt (gnpy-path-request script)
-
-    .. code-block:: json
-
-      {
-        "path-request": [
-          {
-            "request-id": "0",
-            "source": "trx SITE1",
-            "destination": "trx SITE2",
-            "src-tp-id": "trx SITE1",
-            "dst-tp-id": "trx SITE2",
-            "bidirectional": false,
-            "path-constraints": {
-              "te-bandwidth": {
-                "technology": "flexi-grid",
-                "trx_type": "Voyager",
-                "trx_mode": "mode 1",
-                "spacing": 50000000000.0,
-                "path_bandwidth": 100000000000.0
-              }
-            }
-          },
-          {
-            "request-id": "0 with tx_power",
-            "source": "trx SITE1",
-            "destination": "trx SITE2",
-            "src-tp-id": "trx SITE1",
-            "dst-tp-id": "trx SITE2",
-            "bidirectional": false,
-            "path-constraints": {
-              "te-bandwidth": {
-                "technology": "flexi-grid",
-                "trx_type": "Voyager",
-                "trx_mode": "mode 1",
-                "tx_power": 0.0001,
-                "spacing": 50000000000.0,
-                "path_bandwidth": 100000000000.0
-              }
-            }
-          }
-        ]
-      }
-
-v2.9
-====
-
-The revision introduces a major refactor that separates design and propagation. Most of these changes have no impact
-on the user experience, except the following ones:
-
-**Network design - amplifiers**: amplifier saturation is checked during design in all cases, even if type_variety is
-set; amplifier gain is no more computed on the fly but only at design phase.
-
-Before, the design did not consider amplifier power saturation during design if amplifier type_variety was stated.
-With this revision, the saturation is always applied:
-If design is made for a per channel power that leads to saturation, the target are properly reduced and the design
-is freezed. So that when a new simulation is performed on the same network for lower levels of power per channel
-the same gain target is applied. Before these were recomputed, changing the gain targets, so the simulation was
-not considering the exact same working points for amplifiers in case of saturation.
-
-Note that this case (working with saturation settings) is not recommended.
-
-The gain of amplifiers was estimated on the fly also in case of RamanFiber preceding elements. The refactor now
-requires that an estimation of Raman gain of the RamanFiber is done during design to properly compute a gain target.
-The Raman gain is estimated at design for every RamanFiber span and also during propagation instead of being only
-estimated at propagation stage for those Raman Fiber spans concerned with the transmission. The auto-design is more
-accurate for unpropagated spans, but this results in an increase overall computation time.
-This will be improved in the future.
-
-**Network design - ROADMs**: ROADM target power settings are verified during design.
-
-Design checks that expected power coming from every directions ingress from a ROADM are consistent with output power
-targets. The checks only considers the adjacent previous hop. If the expected power at the input of this ROADM is
-lower than the target power on the out-degree of the ROADM, a warning is displayed, and user is asked to review the
-input network to avoid this situation. This does not change the design or propagation behaviour.
-
-**Propagation**: amplifier gain target is no more recomputed during propagation. It is now possible to freeze
-the design and propagate without automatic changes.
-
-In previous release, gain was recomputed during propagation based on an hypothetical reference noiseless channel
-propagation. It was not possible to «freeze» the autodesign, and propagate without recomputing the gain target
-of amplifiers.
-With this new release, the design is freezed, so that it is possible to compare performances on same basis.
-
-**Display**: "effective pch (dbm)" is removed. Display contains the target pch which is the target power per channel
-in dBm, computed based on reference channel used for design and the amplifier delta_p in dB (and before out VOA
-contribution). Note that "actual pch out (dBm)" is the actual propagated total power per channel averaged per spectrum
-band definition at the output of the amplifier element, including noises and out VOA contribution.
-
-v2.8
-====
-
-**Spectrum assignment**: requests can now support multiple slots.
-The definition in service file supports multiple assignments (unchanged syntax):
-
-  .. code-block:: json
-
-          "effective-freq-slot": [
-            {
-              "N": 0,
-              "M": 4
-            }, {
-              "N": 50,
-              "M": 4
-            }
-          ],
-
-But in results, label-hop is now a list of slots and center frequency index:
-
-  .. code-block:: json
-
-          {
-            "path-route-object": {
-              "index": 4,
-              "label-hop": [
-                {
-                  "N": 0,
-                  "M": 4
-                }, {
-                  "N": 50,
-                  "M": 4
-                }
-              ]
-            }
-          },
-
-instead of 
-
-  .. code-block:: json
-
-          {
-            "path-route-object": {
-              "index": 4,
-              "label-hop": {
-                "N": 0,
-                "M": 4
-              }
-            }
-          },
-
-
-
-**change in display**: only warnings are displayed ; information are disabled and needs the -v (verbose)
-option to be displayed on standard output.
-
-**frequency scaling**: A more accurate description of fiber parameters is implemented, including frequency scaling of
-chromatic dispersion, effective area, Raman gain coefficient, and nonlinear coefficient.
-
-In particular:
-
-1. Chromatic dispersion can be defined with ``'dispersion'`` and ``'dispersion_slope'``, as in previous versions, or
-with ``'dispersion_per_frequency'``; the latter must be defined as a dictionary with two keys, ``'value'`` and
-``'frequency'`` and it has higher priority than the entries ``'dispersion'`` and ``'dispersion_slope'``.
-Essential change: In previous versions, when it was not provided the ``'dispersion_slope'`` was calculated in an
-involute manner to get a vanishing beta3 , and this was a mere artifact for NLI evaluation purposes (namely to evaluate
-beta2 and beta3, not for total dispersion accumulation). Now, the evaluation of beta2 and beta3 is performed explicitly
-in the element.py module.
-
-1. The effective area is provided as a scalar value evaluated at the Fiber reference frequency and properly scaled
-considering the Fiber refractive indices n1 and n2, and the core radius. These quantities are assumed to be fixed and
-are hard coded in the parameters.py module. Essential change: The effective area is always scaled along the frequency.
-
-1. The Raman gain coefficient is properly scaled considering the overlapping of fiber effective area values scaled at
-the interacting frequencies. Essential change: In previous version the Raman gain coefficient depends only on
-the frequency offset.
-
-1. The nonlinear coefficient ``'gamma'`` is properly scaled considering the refractive index n2 and the scaling
-effective area.  Essential change: As the effective area, the nonlinear coefficient is always scaled along the
-frequency.
-
-**power offset**: Power equalization now enables defining a power offset in transceiver library to represent
-the deviation from the general equalisation strategy defined in ROADMs.
-
-  .. code-block:: json
-
-            "mode": [{
-                    "format": "100G",
-                    "baud_rate": 32.0e9,
-                    "tx_osnr": 35.0,
-                    "min_spacing": 50.0e9,
-                    "cost": 1,
-                    "OSNR": 10.0,
-                    "bit_rate": 100.0e9,
-                    "roll_off": 0.2,
-                    "equalization_offset_db": 0.0
-                }, {
-                    "format": "200G",
-                    "baud_rate": 64.0e9,
-                    "tx_osnr": 35.0,
-                    "min_spacing": 75.0e9,
-                    "cost": 1,
-                    "OSNR": 13.0,
-                    "bit_rate": 200.0e9,
-                    "roll_off": 0.2,
-                    "equalization_offset_db": 1.76
-                }
-            ]
-
-v2.7
-====

docs/source/gnpy.core.rst

@@ -0,0 +1,94 @@
+gnpy\.core package
+==================
+
+Submodules
+----------
+
+gnpy\.core\.ansi_escapes module
+-------------------------------
+
+.. automodule:: gnpy.core.ansi_escapes
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+gnpy\.core\.convert module
+--------------------------
+
+.. automodule:: gnpy.core.convert
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+gnpy\.core\.elements module
+---------------------------
+
+.. automodule:: gnpy.core.elements
+
+gnpy\.core\.equipment module
+----------------------------
+
+.. automodule:: gnpy.core.equipment
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+gnpy\.core\.exceptions module
+-----------------------------
+
+.. automodule:: gnpy.core.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+gnpy\.core\.execute module
+--------------------------
+
+.. automodule:: gnpy.core.execute
+
+gnpy\.core\.info module
+-----------------------
+
+.. automodule:: gnpy.core.info
+
+gnpy\.core\.network module
+--------------------------
+
+.. automodule:: gnpy.core.network
+
+gnpy\.core\.node module
+-----------------------
+
+.. automodule:: gnpy.core.node
+
+gnpy\.core\.request module
+--------------------------
+
+.. automodule:: gnpy.core.request
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+gnpy\.core\.service_sheet module
+--------------------------------
+
+.. automodule:: gnpy.core.service_sheet
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+gnpy\.core\.units module
+------------------------
+
+.. automodule:: gnpy.core.units
+
+gnpy\.core\.utils module
+------------------------
+
+.. automodule:: gnpy.core.utils
+
+
+Module contents
+---------------
+
+.. automodule:: gnpy.core

docs/source/gnpy.rst

@@ -0,0 +1,14 @@
+gnpy package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+
+    gnpy.core
+
+Module contents
+---------------
+
+.. automodule:: gnpy

docs/source/modules.rst

@@ -0,0 +1,7 @@
+gnpy
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   gnpy

examples/2019-demo-equipment.json

@@ -0,0 +1,124 @@
+{     "Edfa":[
+
+            {
+            "type_variety": "fixed27",
+            "type_def": "fixed_gain",
+            "gain_flatmax": 27,
+            "gain_min": 27,
+            "p_max": 21,
+            "nf0": 5.5,
+            "allowed_for_design": false
+            },
+
+            {
+            "type_variety": "fixed22",
+            "type_def": "fixed_gain",
+            "gain_flatmax": 22,
+            "gain_min": 22,
+            "p_max": 21,
+            "nf0": 5.5,
+            "allowed_for_design": false
+            }
+      ],
+      "Fiber":[{
+            "type_variety": "SSMF",
+            "dispersion": 1.67e-05,
+            "gamma": 0.00127
+            },
+            {
+            "type_variety": "NZDF",
+            "dispersion": 0.5e-05,
+            "gamma": 0.00146
+            },
+            {
+            "type_variety": "LOF",
+            "dispersion": 2.2e-05,
+            "gamma": 0.000843
+            }
+      ],
+      "Span":[{
+            "power_mode": false,
+            "delta_power_range_db": [-2,3,0.5],
+            "max_fiber_lineic_loss_for_raman": 0.25,
+            "target_extended_gain": 2.5,
+            "max_length": 150,
+            "length_units": "km",
+            "max_loss": 28,
+            "padding": 10,
+            "EOL": 0,
+            "con_in": 0,
+            "con_out": 0
+            }
+      ],
+      "Roadm":[{
+            "target_pch_out_db": -25,
+            "add_drop_osnr": 30.00,
+            "restrictions": {
+                            "preamp_variety_list":[],
+                            "booster_variety_list":[]
+                            }            
+            }],
+      "SI":[{
+            "f_min": 191.6e12,
+            "baud_rate": 32e9,
+            "f_max":195.1e12,
+            "spacing": 50e9,
+            "power_dbm": 0,
+            "power_range_db": [0,0,1],
+            "roll_off": 0.15,
+            "tx_osnr": 40,
+            "sys_margins": 2
+            }],
+      "Transceiver":[
+            {
+            "type_variety": "Cassini",
+            "frequency":{
+                        "min": 191.35e12,
+                        "max": 196.1e12
+                        },
+            "mode":[
+                       {
+
+                       "format": "dp-qpsk",
+                       "baud_rate": 32e9,
+                       "OSNR": 11,
+                       "bit_rate": 100e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 40,
+                       "min_spacing": 37.5e9,
+                       "cost":1
+                       },
+                       {
+                       "format": "16-qam",
+                       "baud_rate": 66e9,
+                       "OSNR": 15,
+                       "bit_rate": 200e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 40,
+                       "min_spacing": 75e9,
+                       "cost":1
+                       }
+                   ]
+            },
+            {
+            "type_variety": "Voyager",
+            "frequency":{
+                        "min": 191.35e12,
+                        "max": 196.1e12
+                        },
+            "mode":[
+                       {
+                       "format": "mode 1",
+                       "baud_rate": 32e9,
+                       "OSNR": 12,
+                       "bit_rate": 100e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 40,
+                       "min_spacing": 37.5e9,
+                       "cost":1
+                       }
+                   ]
+            }
+      ]
+
+}

examples/2019-demo-services.json

@@ -0,0 +1,67 @@
+{
+  "path-request": [
+    {
+      "request-id": "first",
+      "source": "netconf:10.0.254.93:830",
+      "destination": "netconf:10.0.254.94:830",
+      "src-tp-id": "trx-Amsterdam",
+      "dst-tp-id": "trx-Bremen",
+      "bidirectional": true,
+      "path-constraints": {
+        "te-bandwidth": {
+          "technology": "flexi-grid",
+          "trx_type": "Cassini",
+          "trx_mode": null,
+          "effective-freq-slot": [
+            {
+              "N": "null",
+              "M": "null"
+            }
+          ],
+          "spacing": 50000000000.0,
+          "max-nb-of-channel": null,
+          "output-power": null,
+          "path_bandwidth": 100000000000.0
+        }
+      }
+    },
+    {
+      "request-id": "second",
+      "source": "netconf:10.0.254.93:830",
+      "destination": "netconf:10.0.254.94:830",
+      "src-tp-id": "trx-Amsterdam",
+      "dst-tp-id": "trx-Bremen",
+      "bidirectional": true,
+      "path-constraints": {
+        "te-bandwidth": {
+          "technology": "flexi-grid",
+          "trx_type": "Cassini",
+          "trx_mode": null,
+          "effective-freq-slot": [
+            {
+              "N": "null",
+              "M": "null"
+            }
+          ],
+          "spacing": 50000000000.0,
+          "max-nb-of-channel": null,
+          "output-power": null,
+          "path_bandwidth": 100000000000.0
+        }
+      }
+    }
+  ],
+  "synchronization": [
+    {
+      "synchronization-id": "some redundancy please",
+      "svec": {
+        "relaxable": "false",
+        "disjointness": "node link",
+        "request-id-number": [
+          "first",
+          "second"
+        ]
+      }
+    }
+  ]
+}

examples/2019-generate-tip-demo.py

@@ -0,0 +1,172 @@
+# How many nodes in the ring topology? Up to eight is supported, then I ran out of cities..
+HOW_MANY = 3
+
+# city names
+ALL_CITIES = [
+    'Amsterdam',
+    'Bremen',
+    'Cologne',
+    'Dueseldorf',
+    'Eindhoven',
+    'Frankfurt',
+    'Ghent',
+    'Hague',
+]
+# end of configurable parameters
+
+
+J = {
+    "elements": [],
+    "connections": [],
+}
+
+def unidir_join(a, b):
+    global J
+    J["connections"].append(
+        {"from_node": a, "to_node": b}
+    )
+
+def mk_edfa(name, gain, voa=0.0):
+    global J
+    J["elements"].append(
+        {"uid": name, "type": "Edfa", "type_variety": f"fixed{gain}", "operational": {"gain_target": gain, "out_voa": voa}}
+    )
+
+def add_att(a, b, att):
+    global J
+    if att > 0:
+        uid = f"att-({a})-({b})"
+    else:
+        uid = f"splice-({a})-({b})"
+    J["elements"].append(
+        {"uid": uid, "type": "Fused", "params": {"loss": att}},
+    )
+    unidir_join(a, uid)
+    unidir_join(uid, b)
+    return uid
+
+def build_fiber(city1, city2):
+    global J
+    J["elements"].append(
+        {
+            "uid": f"fiber-{city1}-{city2}",
+            "type": "Fiber",
+            "type_variety": "SSMF",
+            "params": {
+                "length": 50,
+                "length_units": "km",
+                "loss_coef": 0.2,
+                "con_in": 1.5,
+                "con_out": 1.5,
+            }
+        }
+    )
+
+def unidir_patch(a, b):
+    global J
+    uid = f"patch-({a})-({b})"
+    J["elements"].append(
+        {
+            "uid": uid,
+            "type": "Fiber",
+            "type_variety": "SSMF",
+            "params": {
+                "length": 0,
+                "length_units": "km",
+                "loss_coef": 0.2,
+                "con_in": 0.5,
+                "con_out": 0.5,
+            }
+        }
+    )
+    add_att(a, uid, 0.0)
+    add_att(uid, b, 0.0)
+
+for CITY in (ALL_CITIES[x] for x in range(0, HOW_MANY)):
+    J["elements"].append(
+        {"uid": f"trx-{CITY}", "type": "Transceiver"}
+    )
+    target_pwr = [
+        {"to_node": f"trx-{CITY}", "target_pch_out_db": -25},
+        {"to_node": f"splice-(roadm-{CITY}-AD)-(patch-(roadm-{CITY}-AD)-(roadm-{CITY}-L1))", "target_pch_out_db": -12},
+        {"to_node": f"splice-(roadm-{CITY}-AD)-(patch-(roadm-{CITY}-AD)-(roadm-{CITY}-L2))", "target_pch_out_db": -12},
+    ]
+    J["elements"].append(
+        {"uid": f"roadm-{CITY}-AD", "type": "Roadm", "params": {"target_pch_out_db": -2.0, "per_degree_target_pch_out_db": target_pwr}}
+    )
+    unidir_join(f"trx-{CITY}", f"roadm-{CITY}-AD")
+    unidir_join(f"roadm-{CITY}-AD", f"trx-{CITY}")
+
+    for n in (1,2):
+        target_pwr = [
+            {"to_node": f"roadm-{CITY}-L{n}-booster", "target_pch_out_db": -23},
+            {"to_node": f"splice-(roadm-{CITY}-L{n})-(patch-(roadm-{CITY}-L{n})-(roadm-{CITY}-AD))", "target_pch_out_db": -12},
+        ]
+        for m in (1,2):
+            if m == n:
+                continue
+            target_pwr.append(
+              {"to_node": f"splice-(roadm-{CITY}-L{n})-(patch-(roadm-{CITY}-L{n})-(roadm-{CITY}-L{m}))", "target_pch_out_db": -12},
+            )
+        J["elements"].append(
+            {"uid": f"roadm-{CITY}-L{n}", "type": "Roadm", "params": {"target_pch_out_db": -23.0, "per_degree_target_pch_out_db": target_pwr}}
+        )
+        mk_edfa(f"roadm-{CITY}-L{n}-booster", 22)
+        mk_edfa(f"roadm-{CITY}-L{n}-preamp", 27)
+        unidir_join(f"roadm-{CITY}-L{n}", f"roadm-{CITY}-L{n}-booster")
+        unidir_join(f"roadm-{CITY}-L{n}-preamp", f"roadm-{CITY}-L{n}")
+
+        unidir_patch(f"roadm-{CITY}-AD", f"roadm-{CITY}-L{n}")
+        unidir_patch(f"roadm-{CITY}-L{n}", f"roadm-{CITY}-AD")
+        for m in (1,2):
+            if m == n:
+                continue
+            #add_att(f"roadm-{CITY}-L{n}", f"roadm-{CITY}-L{m}", 22)
+            unidir_patch(f"roadm-{CITY}-L{n}", f"roadm-{CITY}-L{m}")
+
+for city1, city2 in ((ALL_CITIES[i], ALL_CITIES[i + 1] if i < HOW_MANY - 1 else ALL_CITIES[0]) for i in range(0, HOW_MANY)):
+    build_fiber(city1, city2)
+    unidir_join(f"roadm-{city1}-L1-booster", f"fiber-{city1}-{city2}")
+    unidir_join(f"fiber-{city1}-{city2}", f"roadm-{city2}-L2-preamp")
+    build_fiber(city2, city1)
+    unidir_join(f"roadm-{city2}-L2-booster", f"fiber-{city2}-{city1}")
+    unidir_join(f"fiber-{city2}-{city1}", f"roadm-{city1}-L1-preamp")
+
+
+for _, E in enumerate(J["elements"]):
+    uid = E["uid"]
+    if uid.startswith("roadm-") and (uid.endswith("-L1-booster") or uid.endswith("-L2-booster")):
+        E["operational"]["out_voa"] = 12.0
+    #if uid.endswith("-AD-add"):
+    #    E["operational"]["out_voa"] = 21
+
+translate = {
+    "trx-Amsterdam": "10.0.254.93",
+    "trx-Bremen": "10.0.254.94",
+
+    # coherent-v9u
+    "roadm-Amsterdam-AD": "10.0.254.107",
+    # -spi
+    "roadm-Bremen-AD": "10.0.254.225",
+
+    # Amsterdam -> Bremen ...QC8B
+    "roadm-Amsterdam-L1": "10.0.254.101",
+    # ...QCP9
+    "roadm-Bremen-L2": "10.0.254.102",
+
+    # WKP: Bremen -> Cologne
+    "roadm-Bremen-L1": "10.0.254.100",
+    # LK6: Cologne -> Bremen
+    "roadm-Cologne-L2": "10.0.254.104",
+
+    # TQQ: Cologne -> Amsterdam
+    "roadm-Cologne-L1": "10.0.254.99",
+    # NFP: Amsterdam -> Cologne
+    "roadm-Amsterdam-L2": "10.0.254.235",
+}
+
+import json
+s = json.dumps(J, indent=2)
+for (old, new) in translate.items():
+    s = s.replace(f'"{old}"', f'"netconf:{new}:830"')
+print(s)

examples/Juniper-BoosterHG.json

@@ -1,7 +1,13 @@
 {
-    "f_min": 193.0e12,
-    "f_max": 195.0e12,
-    "nf_ripple": [
+      "nf_fit_coeff": [
+        0.0008,
+        0.0272,
+        -0.2249,
+        6.4902
+       ],
+      "f_min": 191.35e12,
+      "f_max": 196.1e12,
+       "nf_ripple": [
         0.0,
         0.0,
         0.0,
@@ -52,103 +58,103 @@
         0.0
     ],
     "gain_ripple": [
-        -0.15656302345061,
-        -0.22244242043552,
-        -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.15017064489112,
         0.14157768006701,
-        0.15017064489112
+        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.22244242043552,
+        -0.15656302345061
     ],
     "dgt": [
-        2.714526681131686,
-        2.6947834587664494,
-        2.630396440815385,
-        2.602860350286428,
-        2.5696460593920065,
-        2.5364027376452056,
-        2.414398437185221,
-        2.2174389328192197,
-        2.16337565384239,
-        2.1183028432496016,
-        2.082225099873648,
-        2.0279625371819305,
-        1.9245345552113182,
-        1.8806927939516411,
-        1.862235672444246,
-        1.847275503201129,
-        1.8045606557581335,
-        1.7793941781790852,
-        1.737780757913635,
-        1.7297783508684146,
-        1.7057507692361864,
-        1.6201194134191075,
-        1.5986915141218316,
-        1.5817353179379183,
-        1.5353620432989845,
-        1.5097346239790443,
-        1.4670307626366115,
-        1.445565137158368,
-        1.4340878115214444,
-        1.418273806730323,
-        1.3981208704326855,
-        1.3779439775587023,
-        1.3598972673004606,
-        1.3439818461440451,
-        1.316383926863083,
-        1.2932153453410835,
-        1.2744470198196236,
-        1.2650555289898042,
-        1.2556591482982988,
-        1.2428104897182262,
-        1.1672278304018044,
-        1.1476135933863398,
-        1.1280891949729075,
-        1.108555289615659,
-        1.0895983485572227,
-        1.0712204022764056,
-        1.017807767853702,
+        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.03941448941778,
         1.0
     ]
-}
+}

examples/create_eqpt_sheet.py

@@ -1,11 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# SPDX-License-Identifier: BSD-3-Clause
-# Utility functions that creates an Eqpt sheet template
-# Copyright (C) 2025 Telecom Infra Project and GNPy contributors
-# see AUTHORS.rst for a list of contributors
-
 """
 create_eqpt_sheet.py
 ====================
@@ -16,22 +11,20 @@ If not present in the "Nodes" sheet, the "Type" column will be implicitly
 determined based on the topology.
 """
 
-from xlrd import open_workbook
+try:
+    from xlrd import open_workbook
+except ModuleNotFoundError:
+    exit('Required: `pip install xlrd`')
 from argparse import ArgumentParser
 
 PARSER = ArgumentParser()
 PARSER.add_argument('workbook', nargs='?', default='meshTopologyExampleV2.xls',
                     help='create the mandatory columns in Eqpt sheet')
-
-
-def ALL_ROWS(sh, start=0):
-    return (sh.row(x) for x in range(start, sh.nrows))
-
+ALL_ROWS = lambda sh, start=0: (sh.row(x) for x in range(start, sh.nrows))
 
 class Node:
     """ Node element contains uid, list of connected nodes and eqpt type
     """
-
     def __init__(self, uid, to_node):
         self.uid = uid
         self.to_node = to_node
@@ -43,7 +36,6 @@ class Node:
     def __str__(self):
         return f'uid {self.uid} \nto_node {[node for node in self.to_node]}\neqpt {self.eqpt}\n'
 
-
 def read_excel(input_filename):
     """ read excel Nodes and Links sheets and create a dict of nodes with
     their to_nodes and type of eqpt
@@ -81,7 +73,6 @@ def read_excel(input_filename):
                 exit()
         return nodes
 
-
 def create_eqt_template(nodes, input_filename):
     """ writes list of node A node Z corresponding to Nodes and Links sheets in order
     to help user populating Eqpt
@@ -94,6 +85,7 @@ def create_eqt_template(nodes, input_filename):
            \nNode A \tNode Z \tamp type \tatt_in \tamp gain \ttilt \tatt_out\
            amp type   \tatt_in \tamp gain   \ttilt   \tatt_out\n')
 
+
         for node in nodes.values():
             if node.eqpt == 'ILA':
                 my_file.write(f'{node.uid}\t{node.to_node[0]}\n')
@@ -101,8 +93,8 @@ def create_eqt_template(nodes, input_filename):
                 for to_node in node.to_node:
                     my_file.write(f'{node.uid}\t{to_node}\n')
 
-        print(f'File {output_filename} successfully created with Node A - Node Z entries for Eqpt sheet in excel file.')
-
+        print(f'File {output_filename} successfully created with Node A - Node Z ' +
+              ' entries for Eqpt sheet in excel file.')
 
 if __name__ == '__main__':
     ARGS = PARSER.parse_args()

examples/default_edfa_config.json

@@ -0,0 +1,296 @@
+{
+    "nf_ripple": [
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0
+    ],
+    "gain_ripple": [
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        0.0,
+        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.017807767853702,
+        1.0
+    ]
+}

examples/edfa_example_network.json

@@ -0,0 +1,80 @@
+{
+    "network_name": "EDFA Example Network - P2P",
+    "elements": [{
+            "uid": "Site_A",
+            "type": "Transceiver",
+            "metadata": {
+                "location": {
+                    "city": "Site A",
+                    "region": "",
+                    "latitude": 0,
+                    "longitude": 0
+                }
+            }
+        },
+        {
+            "uid": "Span1",
+            "type": "Fiber",
+            "type_variety": "SSMF",
+            "params": {
+                "length": 80,
+                "loss_coef": 0.2,
+                "length_units": "km",
+                "att_in": 0,
+                "con_in": 0.5,
+                "con_out": 0.5                
+                },
+            "metadata": {
+                "location": {
+                    "region": "",
+                    "latitude": 1,
+                    "longitude": 0
+                }
+            }
+        },
+        {
+            "uid": "Edfa1",
+            "type": "Edfa",
+            "type_variety": "std_low_gain",            
+            "operational": {
+                "gain_target": 17,
+                "tilt_target": 0,
+                "out_voa": 0
+            },
+            "metadata": {
+                "location": {
+                    "region": "",
+                    "latitude": 2,
+                    "longitude": 0
+                }
+            }
+        },
+        {
+            "uid": "Site_B",
+            "type": "Transceiver",
+            "metadata": {
+                "location": {
+                    "city": "Site B",
+                    "region": "",
+                    "latitude": 2,
+                    "longitude": 0
+                }
+            }
+        }
+
+    ],
+    "connections": [{
+            "from_node": "Site_A",
+            "to_node": "Span1"
+        },
+        {
+            "from_node": "Span1",
+            "to_node": "Edfa1"
+        },
+        {
+            "from_node": "Edfa1",
+            "to_node": "Site_B"
+        }
+
+    ]
+}

examples/edfa_model/amplifier_models_description.rst

@@ -1,20 +1,18 @@
-.. _amp_models:
-
-**********************************
-Amplifier models and Configuration
-**********************************
+*********************************************
+Amplifier models and configuration
+*********************************************
 
 
 1. Equipment configuration description
-======================================
+#######################################
 
 Equipment description defines equipment types and parameters.
-It takes place in the equipment library such as **eqpt_config.json** file defined in example-data folder.
-By default **gnpy-transmission-example** uses **eqpt_config.json** file and that
+It takes place in the default **eqpt_config.json** file. 
+By default **transmission_main_example.py** uses **eqpt_config.json** file and that
 can be changed with **-e** or **--equipment** command line parameter.
 
 2. Amplifier parameters and subtypes
-====================================
+#######################################
 
 Several amplifiers can be used by GNpy, so they are defined as an array of equipment parameters in **eqpt_config.json** file.
 
@@ -30,16 +28,9 @@ Several amplifiers can be used by GNpy, so they are defined as an array of equip
     - *"variable_gain"*
     - *"fixed_gain"*
     - *"dual_stage"*
-    - *"multi_band"*
     - *"openroadm"*
         *see next section for a full description of these models*
 
-
-- *"default_config_from_json"*:
-    Use a custom per frequency dynamic gain tilt, gain and noise ripple arrays defined in the file specified with
-    this option, instead of the default values from GNPy.
-
-
 - *"advanced_config_from_json"*:
     **This parameter is only applicable to the _"advanced_model"_ model**
     
@@ -144,7 +135,7 @@ Several amplifiers can be used by GNpy, so they are defined as an array of equip
 
 
 3. Amplifier models
-===================
+#######################################
 
 In an opensource and multi-vendor environnement, it is needed to support different use cases and context. Therefore several models are supported for amplifiers.
 
@@ -188,7 +179,7 @@ In an opensource and multi-vendor environnement, it is needed to support differe
 - *"variable_gain"* 
     This model is refered as an operator model because a lower level of knowledge is required. A full polynomial description of the NF cross the gain range is not required. Instead, NF_min and NF_max values are required and used by the code to model a dual stage amplifier with an internal mid stage VOA. NF_min and NF_max values are typically available from equipment suppliers data-sheet.
 
-    There is a default configuration to enforce 0 tilt and ripple values because GNPy core algorithm is a multi-carrier propagation.
+    There is a default JSON file ”default_edfa_config.json”* to enforce 0 tilt and ripple values because GNpy core algorithm is a multi-carrier propogation.
     - gain_ripple =[0,...,0]
     - nf_ripple = [0,...,0]
     - dgt = [...] generic dgt comb
@@ -236,7 +227,7 @@ In an opensource and multi-vendor environnement, it is needed to support differe
     .. code-block:: json-object
 
         "Edfa":[{
-                "type_variety": "openroadm_ila_low_noise",
+                "type_variety": "low_noise",
                 "type_def": "openroadm",
                 "gain_flatmax": 27,
                 "gain_min": 12,
@@ -259,7 +250,7 @@ In an opensource and multi-vendor environnement, it is needed to support differe
     
     - gain_min indicates to auto_design when this dual_stage should be used
     
-    But unlike other models the 1st stage input will not be padded: it is always operated to its maximum gain and min NF. Therefore if gain adaptation and padding is needed it will be performed by the 2nd stage.
+    But unlike other models the 1st stage input will not be padded: it is always operated to its maximu gain and min NF. Therefore if gain adaptation and padding is needed it will be performed by the 2nd stage.
 
     .. code-block:: json
 
@@ -272,20 +263,10 @@ In an opensource and multi-vendor environnement, it is needed to support differe
                 "allowed_for_design": true
                 }
 
-
-- *"multiband"*
-    This model enables the definition of multiband amplifiers that consist of multiple single-band
-    amplifier elements, with each amplifier responsible for amplifying a different portion of the spectrum.
-    The types of single-band amplifiers that can be included in these multiband amplifiers are specified,
-    allowing for multiple options to be available for the same spectrum band (for instance, providing
-    several permitted type varieties for both the C-band and the L-band). The actual element utilizing the
-    type_variety must implement only one option for each band.
-
-
 4. advanced_config_from_json 
-============================
+#######################################
 
-The build_oa_json.py library in ``gnpy/example-data/edfa_model/`` can be used to build the json file required for the amplifier advanced_model type_def:
+The build_oa_json.py library in gnpy/examples/edfa_model can be used to build the json file required for the amplifier advanced_model type_def:
 
 Update an existing json file with all the 96ch txt files for a given amplifier type
 amplifier type 'OA_type1' is hard coded but can be modified and other types added
@@ -316,3 +297,4 @@ the json input file should have the following fields:
             "gain_ripple": "DFG_filename.txt",
             "dgt": "DGT_filename.txt"
         }
+

examples/edfa_model/build_oa_json.py

@@ -1,11 +1,5 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-
-# SPDX-License-Identifier: BSD-3-Clause
-# update an existing json file with all the 96ch txt files for a given amplifier type
-# Copyright (C) 2025 Telecom Infra Project and GNPy contributors
-# see AUTHORS.rst for a list of contributors
-
 """
 Created on Tue Jan 30 12:32:00 2018
 
@@ -19,6 +13,7 @@ import re
 import sys
 import json
 import numpy as np
+from gnpy.core.utils import lin2db, db2lin
 
 """amplifier file names
 convert a set of amplifier files + input json definiton file into a valid edfa_json_file:
@@ -33,63 +28,60 @@ input json file in argument (defult = 'OA.json')
 the json input file should have the following fields:
 {
     "nf_fit_coeff": "nf_filename.txt",
-    "nf_ripple": "nf_ripple_filename.txt",
+    "nf_ripple": "nf_ripple_filename.txt", 
     "gain_ripple": "DFG_filename.txt",
     "dgt": "DGT_filename.txt",
 }
 
 """
 
-input_json_file_name = "OA.json"  # default path
+input_json_file_name = "OA.json" #default path
 output_json_file_name = "default_edfa_config.json"
 gain_ripple_field = "gain_ripple"
 nf_ripple_field = "nf_ripple"
 nf_fit_coeff = "nf_fit_coeff"
 
-
 def read_file(field, file_name):
     """read and format the 96 channels txt files describing the amplifier NF and ripple
         convert dfg into gain ripple by removing the mean component
     """
 
-    # with open(path + file_name,'r') as this_file:
+    #with open(path + file_name,'r') as this_file:
     #   data = this_file.read()
-    # data.strip()
+    #data.strip()
     #data = re.sub(r"([0-9])([ ]{1,3})([0-9-+])",r"\1,\3",data)
     #data = list(data.split(","))
     #data = [float(x) for x in data]
     data = np.loadtxt(file_name)
     print(len(data), file_name)
     if field == gain_ripple_field or field == nf_ripple_field:
-        # consider ripple excursion only to avoid redundant information
-        # because the max flat_gain is already given by the 'gain_flat' field in json
-        # remove the mean component
+        #consider ripple excursion only to avoid redundant information
+        #because the max flat_gain is already given by the 'gain_flat' field in json
+        #remove the mean component
         print(file_name, ', mean value =', data.mean(), ' is substracted')
         data = data - data.mean()
     data = data.tolist()
     return data
 
-
 def input_json(path):
     """read the json input file and add all the 96 channels txt files
     create the output json file with output_json_file_name"""
-    with open(path, 'r') as edfa_json_file:
+    with open(path,'r') as edfa_json_file:
         amp_text = edfa_json_file.read()
     amp_dict = json.loads(amp_text)
 
     for k, v in amp_dict.items():
-        if re.search(r'.txt$', str(v)):
+        if re.search(r'.txt$',str(v)) :
             amp_dict[k] = read_file(k, v)
 
     amp_text = json.dumps(amp_dict, indent=4)
-    # print(amp_text)
-    with open(output_json_file_name, 'w') as edfa_json_file:
+    #print(amp_text)
+    with  open(output_json_file_name,'w') as edfa_json_file:
         edfa_json_file.write(amp_text)
 
-
 if __name__ == '__main__':
     if len(sys.argv) == 2:
         path = sys.argv[1]
     else:
         path = input_json_file_name
-    input_json(path)
+    input_json(path)

examples/eqpt_config.json

@@ -0,0 +1,307 @@
+{     "Edfa":[{
+            "type_variety": "high_detail_model_example",
+            "type_def": "advanced_model",
+            "gain_flatmax": 25,
+            "gain_min": 15,
+            "p_max": 21,
+            "advanced_config_from_json": "std_medium_gain_advanced_config.json",
+            "out_voa_auto": false,
+            "allowed_for_design": false
+            },                  {
+            "type_variety": "Juniper_BoosterHG",
+            "type_def": "advanced_model",
+            "gain_flatmax": 25,
+            "gain_min": 10,
+            "p_max": 21,
+            "advanced_config_from_json": "Juniper-BoosterHG.json",
+            "out_voa_auto": false,
+            "allowed_for_design": false
+            }, 
+            {
+            "type_variety": "operator_model_example",
+            "type_def": "variable_gain",
+            "gain_flatmax": 26,
+            "gain_min": 15,
+            "p_max": 23,
+            "nf_min": 6,
+            "nf_max": 10,
+            "out_voa_auto": false,
+            "allowed_for_design": false           
+            },
+            {
+            "type_variety": "low_noise",
+            "type_def": "openroadm",
+            "gain_flatmax": 27,
+            "gain_min": 12,
+            "p_max": 22,
+            "nf_coef": [-8.104e-4,-6.221e-2,-5.889e-1,37.62],
+            "allowed_for_design": false
+            },          
+            {
+            "type_variety": "standard",
+            "type_def": "openroadm",
+            "gain_flatmax": 27,
+            "gain_min": 12,
+            "p_max": 22,
+            "nf_coef": [-5.952e-4,-6.250e-2,-1.071,28.99],
+            "allowed_for_design": false
+            },
+            {
+            "type_variety": "std_high_gain",
+            "type_def": "variable_gain",
+            "gain_flatmax": 35,
+            "gain_min": 25,
+            "p_max": 21,
+            "nf_min": 5.5,
+            "nf_max": 7,
+            "out_voa_auto": false,
+            "allowed_for_design": true
+            },            
+            {
+            "type_variety": "std_medium_gain",
+            "type_def": "variable_gain",
+            "gain_flatmax": 26,
+            "gain_min": 15,
+            "p_max": 23,
+            "nf_min": 6,
+            "nf_max": 10,
+            "out_voa_auto": false,
+            "allowed_for_design": true
+            },
+            {
+            "type_variety": "std_low_gain",
+            "type_def": "variable_gain",
+            "gain_flatmax": 16,
+            "gain_min": 8,
+            "p_max": 23,
+            "nf_min": 6.5,
+            "nf_max": 11,
+            "out_voa_auto": false,
+            "allowed_for_design": true
+            },
+            {
+            "type_variety": "high_power",
+            "type_def": "variable_gain",
+            "gain_flatmax": 16,
+            "gain_min": 8,
+            "p_max": 25,
+            "nf_min": 9,
+            "nf_max": 15,
+            "out_voa_auto": false,
+            "allowed_for_design": false
+            },            
+            {
+            "type_variety": "std_fixed_gain",
+            "type_def": "fixed_gain",
+            "gain_flatmax": 21,
+            "gain_min": 20,
+            "p_max": 21,
+            "nf0": 5.5,
+            "allowed_for_design": false
+            },
+            {
+            "type_variety": "4pumps_raman",
+            "type_def": "fixed_gain",
+            "gain_flatmax": 12,
+            "gain_min": 12,
+            "p_max": 21,
+            "nf0": -1,
+            "allowed_for_design": false
+            },   
+            {
+            "type_variety": "hybrid_4pumps_lowgain",
+            "type_def": "dual_stage",
+            "raman": true,
+            "gain_min": 25,
+            "preamp_variety": "4pumps_raman",
+            "booster_variety": "std_low_gain",
+            "allowed_for_design": true
+            },
+            {
+            "type_variety": "hybrid_4pumps_mediumgain",
+            "type_def": "dual_stage",
+            "raman": true,
+            "gain_min": 25,
+            "preamp_variety": "4pumps_raman",
+            "booster_variety": "std_medium_gain",
+            "allowed_for_design": true
+            },            
+            {
+            "type_variety": "medium+low_gain",
+            "type_def": "dual_stage",
+            "gain_min": 25,
+            "preamp_variety": "std_medium_gain",
+            "booster_variety": "std_low_gain",
+            "allowed_for_design": true
+            },
+            {
+            "type_variety": "medium+high_power",
+            "type_def": "dual_stage",
+            "gain_min": 25,
+            "preamp_variety": "std_medium_gain",
+            "booster_variety": "high_power",
+            "allowed_for_design": false
+            }                                  
+      ],
+      "Fiber":[{
+            "type_variety": "SSMF",
+            "dispersion": 1.67e-05,
+            "gamma": 0.00127
+            },
+            {
+            "type_variety": "NZDF",
+            "dispersion": 0.5e-05,
+            "gamma": 0.00146
+            },
+            {
+            "type_variety": "LOF",
+            "dispersion": 2.2e-05,
+            "gamma": 0.000843
+            }
+      ],
+      "RamanFiber":[{
+            "type_variety": "SSMF",
+            "dispersion": 1.67e-05,
+            "gamma": 0.00127,
+            "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": [-2,3,0.5],
+            "max_fiber_lineic_loss_for_raman": 0.25,
+            "target_extended_gain": 2.5,
+            "max_length": 150,
+            "length_units": "km",
+            "max_loss": 28,
+            "padding": 10,
+            "EOL": 0,
+            "con_in": 0,
+            "con_out": 0
+            }
+      ],
+      "Roadm":[{
+            "target_pch_out_db": -20,
+            "add_drop_osnr": 38,
+            "restrictions": {
+                            "preamp_variety_list":[],
+                            "booster_variety_list":[]
+                            }            
+            }],
+      "SI":[{
+            "f_min": 191.3e12,
+            "baud_rate": 32e9,
+            "f_max":195.1e12,
+            "spacing": 50e9,
+            "power_dbm": 0,
+            "power_range_db": [0,0,1],
+            "roll_off": 0.15,
+            "tx_osnr": 40,
+            "sys_margins": 2
+            }],
+      "Transceiver":[
+            {
+            "type_variety": "vendorA_trx-type1",
+            "frequency":{
+                        "min": 191.35e12,
+                        "max": 196.1e12
+                        },
+            "mode":[
+                       {
+
+                       "format": "mode 1",
+                       "baud_rate": 32e9,
+                       "OSNR": 11,
+                       "bit_rate": 100e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 40,
+                       "min_spacing": 37.5e9,
+                       "cost":1
+                       },
+                       {
+                       "format": "mode 2",
+                       "baud_rate": 66e9,
+                       "OSNR": 15,
+                       "bit_rate": 200e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 40,
+                       "min_spacing": 75e9,
+                       "cost":1
+                       }
+                   ]
+            },
+            {
+            "type_variety": "Voyager",
+            "frequency":{
+                        "min": 191.35e12,
+                        "max": 196.1e12
+                        },
+            "mode":[
+                       {
+                       "format": "mode 1",
+                       "baud_rate": 32e9,
+                       "OSNR": 12,
+                       "bit_rate": 100e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 40,
+                       "min_spacing": 37.5e9,
+                       "cost":1
+                       },
+                       {
+                       "format": "mode 3",
+                       "baud_rate": 44e9,
+                       "OSNR": 18,
+                       "bit_rate": 300e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 40,
+                       "min_spacing": 62.5e9,
+                       "cost":1
+                       },
+                       {
+                       "format": "mode 2",
+                       "baud_rate": 66e9,
+                       "OSNR": 21,
+                       "bit_rate": 400e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 40,
+                       "min_spacing": 75e9,
+                       "cost":1
+                       },
+                       {
+                       "format": "mode 4",
+                       "baud_rate": 66e9,
+                       "OSNR": 16,
+                       "bit_rate": 200e9,
+                       "roll_off": 0.15,
+                       "tx_osnr": 40,
+                       "min_spacing": 75e9,
+                       "cost":1
+                       }
+                   ]
+            }
+      ]
+
+}

examples/meshTopologyExampleV2.json

@@ -624,70 +624,6 @@
         "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": {
@@ -699,7 +635,7 @@
         }
       },
       "type": "Edfa",
-      "type_variety": "std_medium_gain",
+      "type_variety": "std_low_gain",
       "operational": {
         "gain_target": null,
         "delta_p": 1.0,
@@ -708,18 +644,41 @@
       }
     },
     {
-      "uid": "east edfa in Lorient_KMA to Vannes_KBE",
+      "uid": "east edfa in Corlay to Loudeac",
       "metadata": {
         "location": {
-          "city": "Lorient_KMA",
+          "city": "Corlay",
           "region": "RLD",
           "latitude": 2.0,
-          "longitude": 3.0
+          "longitude": 1.0
         }
       },
-      "type": "Fused",
-      "params": {
-        "loss": 0
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": null,
+        "delta_p": 1.0,
+        "tilt_target": 0,
+        "out_voa": null
+      }
+    },
+    {
+      "uid": "east edfa in Loudeac to Lorient_KMA",
+      "metadata": {
+        "location": {
+          "city": "Loudeac",
+          "region": "RLD",
+          "latitude": 2.0,
+          "longitude": 2.0
+        }
+      },
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": null,
+        "delta_p": 1.0,
+        "tilt_target": 0,
+        "out_voa": null
       }
     },
     {
@@ -733,7 +692,7 @@
         }
       },
       "type": "Edfa",
-      "type_variety": "std_medium_gain",
+      "type_variety": "std_low_gain",
       "operational": {
         "gain_target": null,
         "delta_p": 1.0,
@@ -771,7 +730,7 @@
         }
       },
       "type": "Edfa",
-      "type_variety": "std_medium_gain",
+      "type_variety": "std_low_gain",
       "operational": {
         "gain_target": null,
         "delta_p": 1.0,
@@ -790,7 +749,7 @@
         }
       },
       "type": "Edfa",
-      "type_variety": "std_medium_gain",
+      "type_variety": "std_low_gain",
       "operational": {
         "gain_target": null,
         "delta_p": 1.0,
@@ -809,7 +768,7 @@
         }
       },
       "type": "Edfa",
-      "type_variety": "std_medium_gain",
+      "type_variety": "std_low_gain",
       "operational": {
         "gain_target": null,
         "delta_p": 1.0,
@@ -828,7 +787,7 @@
         }
       },
       "type": "Edfa",
-      "type_variety": "std_medium_gain",
+      "type_variety": "std_low_gain",
       "operational": {
         "gain_target": null,
         "delta_p": 1.0,
@@ -847,7 +806,7 @@
         }
       },
       "type": "Edfa",
-      "type_variety": "std_medium_gain",
+      "type_variety": "std_low_gain",
       "operational": {
         "gain_target": null,
         "delta_p": 1.0,
@@ -866,7 +825,45 @@
         }
       },
       "type": "Edfa",
-      "type_variety": "std_high_gain",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": null,
+        "delta_p": 1.0,
+        "tilt_target": 0,
+        "out_voa": null
+      }
+    },
+    {
+      "uid": "west edfa in Corlay to Loudeac",
+      "metadata": {
+        "location": {
+          "city": "Corlay",
+          "region": "RLD",
+          "latitude": 2.0,
+          "longitude": 1.0
+        }
+      },
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": null,
+        "delta_p": 1.0,
+        "tilt_target": 0,
+        "out_voa": null
+      }
+    },
+    {
+      "uid": "west edfa in Loudeac to Lorient_KMA",
+      "metadata": {
+        "location": {
+          "city": "Loudeac",
+          "region": "RLD",
+          "latitude": 2.0,
+          "longitude": 2.0
+        }
+      },
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
       "operational": {
         "gain_target": null,
         "delta_p": 1.0,
@@ -961,7 +958,7 @@
         }
       },
       "type": "Edfa",
-      "type_variety": "std_high_gain",
+      "type_variety": "std_low_gain",
       "operational": {
         "gain_target": null,
         "delta_p": 1.0,
@@ -980,7 +977,7 @@
         }
       },
       "type": "Edfa",
-      "type_variety": "std_medium_gain",
+      "type_variety": "std_low_gain",
       "operational": {
         "gain_target": null,
         "delta_p": 1.0,
@@ -1025,6 +1022,21 @@
         "tilt_target": 0,
         "out_voa": null
       }
+    },
+    {
+      "uid": "east edfa in Lorient_KMA to Vannes_KBE",
+      "metadata": {
+        "location": {
+          "city": "Lorient_KMA",
+          "region": "RLD",
+          "latitude": 2.0,
+          "longitude": 3.0
+        }
+      },
+      "type": "Fused",
+      "params": {
+        "loss": 0
+      }
     }
   ],
   "connections": [
@@ -1254,34 +1266,18 @@
     },
     {
       "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)-"
     },
     {
@@ -1325,4 +1321,4 @@
       "to_node": "trx Brest_KLA"
     }
   ]
-}
+}

examples/meshTopologyExampleV2_services.json

@@ -14,8 +14,8 @@
           "trx_mode": null,
           "effective-freq-slot": [
             {
-              "N": null,
-              "M": null
+              "N": "null",
+              "M": "null"
             }
           ],
           "spacing": 50000000000.0,
@@ -39,8 +39,8 @@
           "trx_mode": "mode 1",
           "effective-freq-slot": [
             {
-              "N": null,
-              "M": null
+              "N": "null",
+              "M": "null"
             }
           ],
           "spacing": 50000000000.0,
@@ -52,8 +52,8 @@
       "explicit-route-objects": {
         "route-object-include-exclude": [
           {
-            "index": 0,
             "explicit-route-usage": "route-include-ero",
+            "index": 0,
             "num-unnum-hop": {
               "node-id": "roadm Brest_KLA",
               "link-tp-id": "link-tp-id is not used",
@@ -61,8 +61,8 @@
             }
           },
           {
-            "index": 1,
             "explicit-route-usage": "route-include-ero",
+            "index": 1,
             "num-unnum-hop": {
               "node-id": "roadm Lannion_CAS",
               "link-tp-id": "link-tp-id is not used",
@@ -70,8 +70,8 @@
             }
           },
           {
-            "index": 2,
             "explicit-route-usage": "route-include-ero",
+            "index": 2,
             "num-unnum-hop": {
               "node-id": "roadm Lorient_KMA",
               "link-tp-id": "link-tp-id is not used",
@@ -79,8 +79,8 @@
             }
           },
           {
-            "index": 3,
             "explicit-route-usage": "route-include-ero",
+            "index": 3,
             "num-unnum-hop": {
               "node-id": "roadm Vannes_KBE",
               "link-tp-id": "link-tp-id is not used",
@@ -104,8 +104,8 @@
           "trx_mode": "mode 1",
           "effective-freq-slot": [
             {
-              "N": null,
-              "M": null
+              "N": "null",
+              "M": "null"
             }
           ],
           "spacing": 50000000000.0,
@@ -129,8 +129,8 @@
           "trx_mode": null,
           "effective-freq-slot": [
             {
-              "N": null,
-              "M": null
+              "N": "null",
+              "M": "null"
             }
           ],
           "spacing": 75000000000.0,
@@ -154,8 +154,8 @@
           "trx_mode": "mode 2",
           "effective-freq-slot": [
             {
-              "N": null,
-              "M": null
+              "N": "null",
+              "M": "null"
             }
           ],
           "spacing": 75000000000.0,
@@ -179,8 +179,8 @@
           "trx_mode": "mode 1",
           "effective-freq-slot": [
             {
-              "N": null,
-              "M": null
+              "N": "null",
+              "M": "null"
             }
           ],
           "spacing": 50000000000.0,
@@ -204,8 +204,8 @@
           "trx_mode": "mode 1",
           "effective-freq-slot": [
             {
-              "N": null,
-              "M": null
+              "N": "null",
+              "M": "null"
             }
           ],
           "spacing": 50000000000.0,
@@ -229,8 +229,8 @@
           "trx_mode": "mode 1",
           "effective-freq-slot": [
             {
-              "N": null,
-              "M": null
+              "N": "null",
+              "M": "null"
             }
           ],
           "spacing": 75000000000.0,

examples/path_requests_run.py

@@ -0,0 +1,569 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+path_requests_run.py
+====================
+
+Reads a JSON request file in accordance with the Yang model
+for requesting path computation and returns path results in terms
+of path and feasibilty.
+
+See: draft-ietf-teas-yang-path-computation-01.txt
+"""
+
+from sys import exit
+from argparse import ArgumentParser
+from pathlib import Path
+from collections import namedtuple
+from logging import getLogger, basicConfig, CRITICAL, DEBUG, INFO
+from json import dumps, loads
+from numpy import mean
+from gnpy.core.service_sheet import convert_service_sheet, Request_element, Element
+from gnpy.core.utils import load_json
+from gnpy.core.network import load_network, build_network, save_network, network_from_json
+from gnpy.core.equipment import load_equipment, trx_mode_params, automatic_nch
+from gnpy.core.elements import Transceiver, Roadm
+from gnpy.core.utils import db2lin, lin2db
+from gnpy.core.request import (Path_request, Result_element,
+                               propagate, jsontocsv, Disjunction, compute_path_dsjctn,
+                               requests_aggregation, propagate_and_optimize_mode,
+                               BLOCKING_NOPATH, BLOCKING_NOMODE,
+                               find_reversed_path)
+from gnpy.core.exceptions import (ConfigurationError, EquipmentConfigError, NetworkTopologyError,
+                                  ServiceError, DisjunctionError)
+import gnpy.core.ansi_escapes as ansi_escapes
+from gnpy.core.spectrum_assignment import (build_oms_list, pth_assign_spectrum)
+from copy import copy, deepcopy
+from textwrap import dedent
+from math import ceil
+
+from flask import Flask, jsonify, make_response, request
+from flask_restful import Api, Resource, reqparse, fields
+
+#EQPT_LIBRARY_FILENAME = Path(__file__).parent / 'eqpt_config.json'
+
+LOGGER = getLogger(__name__)
+
+PARSER = ArgumentParser(description='A function that computes performances for a list of ' +
+                        'services provided in a json file or an excel sheet.')
+PARSER.add_argument('network_filename', nargs='?', type=Path,\
+                    default=Path(__file__).parent / 'meshTopologyExampleV2.xls',\
+                    help='input topology file in xls or json')
+PARSER.add_argument('service_filename', nargs='?', type=Path,\
+                    default=Path(__file__).parent / 'meshTopologyExampleV2.xls',\
+                    help='input service file in xls or json')
+PARSER.add_argument('eqpt_filename', nargs='?', type=Path,\
+                    default=Path(__file__).parent / 'eqpt_config.json',\
+                    help='input equipment library in json. Default is eqpt_config.json')
+PARSER.add_argument('-bi', '--bidir', action='store_true',\
+                    help='considers that all demands are bidir')
+PARSER.add_argument('-v', '--verbose', action='count', default=0,\
+                    help='increases verbosity for each occurence')
+PARSER.add_argument('-o', '--output', type=Path)
+PARSER.add_argument('-r', '--rest', action='count', default=0, help='use the REST API')
+
+NETWORK_FILENAME = 'topoDemov1.json' #'disagregatedTopoDemov1.json' #
+
+APP = Flask(__name__, static_url_path="")
+API = Api(APP)
+
+def requests_from_json(json_data, equipment):
+    """ converts the json data into a list of requests elements
+    """
+    requests_list = []
+
+    for req in json_data['path-request']:
+        # init all params from request
+        params = {}
+        params['request_id'] = req['request-id']
+        params['source'] = req['source']
+        params['bidir'] = req['bidirectional']
+        params['destination'] = req['destination']
+        params['trx_type'] = req['path-constraints']['te-bandwidth']['trx_type']
+        params['trx_mode'] = req['path-constraints']['te-bandwidth']['trx_mode']
+        params['format'] = params['trx_mode']
+        params['spacing'] = req['path-constraints']['te-bandwidth']['spacing']
+        try:
+            nd_list = req['explicit-route-objects']['route-object-include-exclude']
+        except KeyError:
+            nd_list = []
+        params['nodes_list'] = [n['num-unnum-hop']['node-id'] for n in nd_list]
+        params['loose_list'] = [n['num-unnum-hop']['hop-type'] for n in nd_list]
+        # recover trx physical param (baudrate, ...) from type and mode
+        # in trx_mode_params optical power is read from equipment['SI']['default'] and
+        # nb_channel is computed based on min max frequency and spacing
+        trx_params = trx_mode_params(equipment, params['trx_type'], params['trx_mode'], True)
+        params.update(trx_params)
+        # print(trx_params['min_spacing'])
+        # optical power might be set differently in the request. if it is indicated then the
+        # params['power'] is updated
+        try:
+            if req['path-constraints']['te-bandwidth']['output-power']:
+                params['power'] = req['path-constraints']['te-bandwidth']['output-power']
+        except KeyError:
+            pass
+        # same process for nb-channel
+        f_min = params['f_min']
+        f_max_from_si = params['f_max']
+        try:
+            if req['path-constraints']['te-bandwidth']['max-nb-of-channel'] is not None:
+                nch = req['path-constraints']['te-bandwidth']['max-nb-of-channel']
+                params['nb_channel'] = nch
+                spacing = params['spacing']
+                params['f_max'] = f_min + nch*spacing
+            else:
+                params['nb_channel'] = automatic_nch(f_min, f_max_from_si, params['spacing'])
+        except KeyError:
+            params['nb_channel'] = automatic_nch(f_min, f_max_from_si, params['spacing'])
+        consistency_check(params, f_max_from_si)
+
+        try:
+            params['path_bandwidth'] = req['path-constraints']['te-bandwidth']['path_bandwidth']
+        except KeyError:
+            pass
+        requests_list.append(Path_request(**params))
+    return requests_list
+
+def consistency_check(params, f_max_from_si):
+    """ checks that the requested parameters are consistant (spacing vs nb channel,
+        vs transponder mode...)
+    """
+    f_min = params['f_min']
+    f_max = params['f_max']
+    max_recommanded_nb_channels = automatic_nch(f_min, f_max, params['spacing'])
+    if params['baud_rate'] is not None:
+        #implicitely means that a mode is defined with min_spacing
+        if params['min_spacing'] > params['spacing']:
+            msg = f'Request {params["request_id"]} has spacing below transponder ' +\
+                  f'{params["trx_type"]} {params["trx_mode"]} min spacing value ' +\
+                  f'{params["min_spacing"]*1e-9}GHz.\nComputation stopped'
+            print(msg)
+            LOGGER.critical(msg)
+            raise ServiceError(msg)
+        if f_max > f_max_from_si:
+            msg = dedent(f'''
+            Requested channel number {params["nb_channel"]}, baud rate {params["baud_rate"]} GHz and requested spacing {params["spacing"]*1e-9}GHz 
+            is not consistent with frequency range {f_min*1e-12} THz, {f_max*1e-12} THz, min recommanded spacing {params["min_spacing"]*1e-9}GHz.
+            max recommanded nb of channels is {max_recommanded_nb_channels}
+            Computation stopped.''')
+            LOGGER.critical(msg)
+            raise ServiceError(msg)
+
+
+def disjunctions_from_json(json_data):
+    """ reads the disjunction requests from the json dict and create the list
+        of requested disjunctions for this set of requests
+    """
+    disjunctions_list = []
+    try:
+        temp_test = json_data['synchronization']
+    except KeyError:
+        temp_test = []
+    if temp_test:
+        for snc in json_data['synchronization']:
+            params = {}
+            params['disjunction_id'] = snc['synchronization-id']
+            params['relaxable'] = snc['svec']['relaxable']
+            params['link_diverse'] = 'link' in snc['svec']['disjointness']
+            params['node_diverse'] = 'node' in snc['svec']['disjointness']
+            params['disjunctions_req'] = snc['svec']['request-id-number']
+            disjunctions_list.append(Disjunction(**params))
+
+    return disjunctions_list
+
+
+def load_requests(filename, eqpt_filename, bidir):
+    """ loads the requests from a json or an excel file into a data string
+    """
+    if filename.suffix.lower() == '.xls':
+        LOGGER.info('Automatically converting requests from XLS to JSON')
+        try:
+            json_data = convert_service_sheet(filename, eqpt_filename, bidir=bidir)
+        except ServiceError as this_e:
+            print(f'{ansi_escapes.red}Service error:{ansi_escapes.reset} {this_e}')
+            exit(1)
+    else:
+        with open(filename, encoding='utf-8') as my_f:
+            json_data = loads(my_f.read())
+    return json_data
+
+def compute_path_with_disjunction(network, equipment, pathreqlist, pathlist):
+    """ use a list but a dictionnary might be helpful to find path based on request_id
+        TODO change all these req, dsjct, res lists into dict !
+    """
+    path_res_list = []
+    reversed_path_res_list = []
+    propagated_reversed_path_res_list = []
+
+    for i, pathreq in enumerate(pathreqlist):
+
+        # use the power specified in requests but might be different from the one
+        # specified for design the power is an optional parameter for requests
+        # definition if optional, use the one defines in eqt_config.json
+        p_db = lin2db(pathreq.power*1e3)
+        p_total_db = p_db + lin2db(pathreq.nb_channel)
+        print(f'request {pathreq.request_id}')
+        print(f'Computing path from {pathreq.source} to {pathreq.destination}')
+        # adding first node to be clearer on the output
+        print(f'with path constraint: {[pathreq.source] + pathreq.nodes_list}')
+
+        # pathlist[i] contains the whole path information for request i
+        # last element is a transciver and where the result of the propagation is
+        # recorded.
+        # Important Note: since transceivers attached to roadms are actually logical
+        # elements to simulate performance, several demands having the same destination
+        # may use the same transponder for the performance simulation. This is why
+        # we use deepcopy: to ensure that each propagation is recorded and not overwritten
+        total_path = deepcopy(pathlist[i])
+        print(f'Computed path (roadms):{[e.uid for e in total_path  if isinstance(e, Roadm)]}')
+        # for debug
+        # print(f'{pathreq.baud_rate}   {pathreq.power}   {pathreq.spacing}   {pathreq.nb_channel}')
+        if total_path:
+            if pathreq.baud_rate is not None:
+                # means that at this point the mode was entered/forced by user and thus a
+                # baud_rate was defined
+                total_path = propagate(total_path, pathreq, equipment)
+                temp_snr01nm = round(mean(total_path[-1].snr+lin2db(pathreq.baud_rate/(12.5e9))), 2)
+                if temp_snr01nm < pathreq.OSNR:
+                    msg = f'\tWarning! Request {pathreq.request_id} computed path from' +\
+                          f' {pathreq.source} to {pathreq.destination} does not pass with' +\
+                          f' {pathreq.tsp_mode}\n\tcomputedSNR in 0.1nm = {temp_snr01nm} ' +\
+                          f'- required osnr {pathreq.OSNR}'
+                    print(msg)
+                    LOGGER.warning(msg)
+                    pathreq.blocking_reason = 'MODE_NOT_FEASIBLE'
+            else:
+                total_path, mode = propagate_and_optimize_mode(total_path, pathreq, equipment)
+                # if no baudrate satisfies spacing, no mode is returned and the last explored mode
+                # a warning is shown in the propagate_and_optimize_mode
+                # propagate_and_optimize_mode function returns the mode with the highest bitrate
+                # that passes. if no mode passes, then a attribute blocking_reason is added on
+                # pathreq that contains the reason for blocking: 'NO_PATH', 'NO_FEASIBLE_MODE', ...
+                try:
+                    if pathreq.blocking_reason in BLOCKING_NOPATH:
+                        total_path = []
+                    elif pathreq.blocking_reason in BLOCKING_NOMODE:
+                        pathreq.baud_rate = mode['baud_rate']
+                        pathreq.tsp_mode = mode['format']
+                        pathreq.format = mode['format']
+                        pathreq.OSNR = mode['OSNR']
+                        pathreq.tx_osnr = mode['tx_osnr']
+                        pathreq.bit_rate = mode['bit_rate']
+                    # other blocking reason should not appear at this point
+                except AttributeError:
+                    pathreq.baud_rate = mode['baud_rate']
+                    pathreq.tsp_mode = mode['format']
+                    pathreq.format = mode['format']
+                    pathreq.OSNR = mode['OSNR']
+                    pathreq.tx_osnr = mode['tx_osnr']
+                    pathreq.bit_rate = mode['bit_rate']
+
+            # 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
+                rev_p = deepcopy(reversed_path)
+
+                print(f'\n\tPropagating Z to A direction {pathreq.destination} to {pathreq.source}')
+                print(f'\tPath (roadsm) {[r.uid for r in rev_p if isinstance(r,Roadm)]}\n')
+                propagated_reversed_path = propagate(rev_p, pathreq, equipment)
+                temp_snr01nm = round(mean(propagated_reversed_path[-1].snr +\
+                                          lin2db(pathreq.baud_rate/(12.5e9))), 2)
+                if temp_snr01nm < pathreq.OSNR:
+                    msg = f'\tWarning! Request {pathreq.request_id} computed path from' +\
+                          f' {pathreq.source} to {pathreq.destination} does not pass with' +\
+                          f' {pathreq.tsp_mode}\n' +\
+                          f'\tcomputedSNR in 0.1nm = {temp_snr01nm} - required osnr {pathreq.OSNR}'
+                    print(msg)
+                    LOGGER.warning(msg)
+                    # TODO selection of mode should also be on reversed direction !!
+                    pathreq.blocking_reason = 'MODE_NOT_FEASIBLE'
+            else:
+                propagated_reversed_path = []
+        else:
+            msg = 'Total path is empty. No propagation'
+            print(msg)
+            LOGGER.info(msg)
+            reversed_path = []
+            propagated_reversed_path = []
+
+        path_res_list.append(total_path)
+        reversed_path_res_list.append(reversed_path)
+        propagated_reversed_path_res_list.append(propagated_reversed_path)
+        # print to have a nice output
+        print('')
+    return path_res_list, reversed_path_res_list, propagated_reversed_path_res_list
+
+def correct_route_list(network, pathreqlist):
+    """ prepares the format of route list of nodes to be consistant
+        remove wrong names, remove endpoints
+        also correct source and destination
+    """
+    anytype = [n.uid for n in network.nodes()]
+    # TODO there is a problem of identification of fibers in case of parallel fibers
+    # between two adjacent roadms so fiber constraint is not supported
+    transponders = [n.uid for n in network.nodes() if isinstance(n, Transceiver)]
+    for pathreq in pathreqlist:
+        for i, n_id in enumerate(pathreq.nodes_list):
+            # replace possibly wrong name with a formated roadm name
+            # print(n_id)
+            if n_id not in anytype:
+                # find nodes name that include constraint among all possible names except
+                # transponders (not yet supported as constraints).
+                nodes_suggestion = [uid for uid in anytype \
+                    if n_id.lower() in uid.lower() and uid not in transponders]
+                if pathreq.loose_list[i] == 'LOOSE':
+                    if len(nodes_suggestion) > 0:
+                        new_n = nodes_suggestion[0]
+                        print(f'invalid route node specified:\
+                        \n\'{n_id}\', replaced with \'{new_n}\'')
+                        pathreq.nodes_list[i] = new_n
+                    else:
+                        print(f'\x1b[1;33;40m'+f'invalid route node specified \'{n_id}\',' +\
+                              f' could not use it as constraint, skipped!'+'\x1b[0m')
+                        pathreq.nodes_list.remove(n_id)
+                        pathreq.loose_list.pop(i)
+                else:
+                    msg = f'\x1b[1;33;40m'+f'could not find node: {n_id} in network topology.' +\
+                          f' Strict constraint can not be applied.' + '\x1b[0m'
+                    LOGGER.critical(msg)
+                    raise ValueError(msg)
+        if pathreq.source not in transponders:
+            msg = f'\x1b[1;31;40m' + f'Request: {pathreq.request_id}: could not find' +\
+                  f' transponder source: {pathreq.source}.'+'\x1b[0m'
+            LOGGER.critical(msg)
+            print(f'{msg}\nComputation stopped.')
+            raise ServiceError(msg)
+
+        if pathreq.destination not in transponders:
+            msg = f'\x1b[1;31;40m'+f'Request: {pathreq.request_id}: could not find' +\
+                  f' transponder destination: {pathreq.destination}.'+'\x1b[0m'
+            LOGGER.critical(msg)
+            print(f'{msg}\nComputation stopped.')
+            raise ServiceError(msg)
+
+        # TODO remove endpoints from this list in case they were added by the user
+        # in the xls or json files
+    return pathreqlist
+
+def correct_disjn(disjn):
+    """ clean disjunctions to remove possible repetition
+    """
+    local_disjn = disjn.copy()
+    for elem in local_disjn:
+        for dis_elem in local_disjn:
+            if set(elem.disjunctions_req) == set(dis_elem.disjunctions_req) and\
+             elem.disjunction_id != dis_elem.disjunction_id:
+                local_disjn.remove(dis_elem)
+    return local_disjn
+
+
+def path_result_json(pathresult):
+    """ create the response dictionnary
+    """
+    data = {
+        'response': [n.json for n in pathresult]
+    }
+    return data
+
+def compute_requests(network, data, equipment):
+    """ Main program calling functions
+    """
+    # Build the network once using the default power defined in SI in eqpt config
+    # TODO power density: db2linp(ower_dbm": 0)/power_dbm": 0 * nb channels as defined by
+    # spacing, f_min and f_max
+    p_db = equipment['SI']['default'].power_dbm
+
+    p_total_db = p_db + lin2db(automatic_nch(equipment['SI']['default'].f_min,\
+        equipment['SI']['default'].f_max, equipment['SI']['default'].spacing))
+    build_network(network, equipment, p_db, p_total_db)
+    save_network(ARGS.network_filename, network)
+
+    oms_list = build_oms_list(network, equipment)
+
+    try:
+        rqs = requests_from_json(data, equipment)
+    except ServiceError as this_e:
+        print(f'{ansi_escapes.red}Service error:{ansi_escapes.reset} {this_e}')
+        raise this_e
+    # check that request ids are unique. Non unique ids, may
+    # mess the computation: better to stop the computation
+    all_ids = [r.request_id for r in rqs]
+    if len(all_ids) != len(set(all_ids)):
+        for item in list(set(all_ids)):
+            all_ids.remove(item)
+        msg = f'Requests id {all_ids} are not unique'
+        LOGGER.critical(msg)
+        raise ServiceError(msg)
+    try:
+        rqs = correct_route_list(network, rqs)
+    except ServiceError as this_e:
+        print(f'{ansi_escapes.red}Service error:{ansi_escapes.reset} {this_e}')
+        raise this_e
+        #exit(1)
+    # pths = compute_path(network, equipment, rqs)
+    dsjn = disjunctions_from_json(data)
+
+    print('\x1b[1;34;40m' + f'List of disjunctions' + '\x1b[0m')
+    print(dsjn)
+    # need to warn or correct in case of wrong disjunction form
+    # disjunction must not be repeated with same or different ids
+    dsjn = correct_disjn(dsjn)
+
+    # Aggregate demands with same exact constraints
+    print('\x1b[1;34;40m' + f'Aggregating similar requests' + '\x1b[0m')
+
+    rqs, dsjn = requests_aggregation(rqs, dsjn)
+    # TODO export novel set of aggregated demands in a json file
+
+    print('\x1b[1;34;40m' + 'The following services have been requested:' + '\x1b[0m')
+    print(rqs)
+
+    print('\x1b[1;34;40m' + f'Computing all paths with constraints' + '\x1b[0m')
+    try:
+        pths = compute_path_dsjctn(network, equipment, rqs, dsjn)
+    except DisjunctionError as this_e:
+        print(f'{ansi_escapes.red}Disjunction error:{ansi_escapes.reset} {this_e}')
+        raise this_e
+
+    print('\x1b[1;34;40m' + f'Propagating on selected path' + '\x1b[0m')
+    propagatedpths, reversed_pths, reversed_propagatedpths = \
+        compute_path_with_disjunction(network, equipment, rqs, pths)
+    # Note that deepcopy used in compute_path_with_disjunction returns
+    # a list of nodes which are not belonging to network (they are copies of the node objects).
+    # so there can not be propagation on these nodes.
+
+    pth_assign_spectrum(pths, rqs, oms_list, reversed_pths)
+
+    print('\x1b[1;34;40m'+f'Result summary'+ '\x1b[0m')
+    header = ['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']
+    data = []
+    data.append(header)
+    for i, this_p in enumerate(propagatedpths):
+        rev_pth = reversed_propagatedpths[i]
+        if rev_pth and this_p:
+            psnrb = f'{round(mean(this_p[-1].snr),2)} ({round(mean(rev_pth[-1].snr),2)})'
+            psnr = f'{round(mean(this_p[-1].snr_01nm), 2)}' +\
+                   f' ({round(mean(rev_pth[-1].snr_01nm),2)})'
+        elif this_p:
+            psnrb = f'{round(mean(this_p[-1].snr),2)}'
+            psnr = f'{round(mean(this_p[-1].snr_01nm),2)}'
+
+        try :
+            if rqs[i].blocking_reason in  BLOCKING_NOPATH:
+                line = [f'{rqs[i].request_id}', f' {rqs[i].source} to {rqs[i].destination} :',\
+                        f'-', f'-', f'-', f'{rqs[i].tsp_mode}', f'{round(rqs[i].path_bandwidth * 1e-9,2)}',\
+                        f'-', f'{rqs[i].blocking_reason}']
+            else:
+                line = [f'{rqs[i].request_id}', f' {rqs[i].source} to {rqs[i].destination} : ', psnrb,\
+                        psnr, f'-', f'{rqs[i].tsp_mode}', f'{round(rqs[i].path_bandwidth * 1e-9, 2)}',\
+                        f'-', f'{rqs[i].blocking_reason}']
+        except AttributeError:
+            line = [f'{rqs[i].request_id}', f' {rqs[i].source} to {rqs[i].destination} : ', psnrb,\
+                    psnr, f'{rqs[i].OSNR}', f'{rqs[i].tsp_mode}', f'{round(rqs[i].path_bandwidth * 1e-9,2)}',\
+                    f'{ceil(rqs[i].path_bandwidth / rqs[i].bit_rate) }', f'({rqs[i].N},{rqs[i].M})']
+        data.append(line)
+
+    col_width = max(len(word) for row in data for word in row[2:])   # padding
+    firstcol_width = max(len(row[0]) for row in data)   # padding
+    secondcol_width = max(len(row[1]) for row in data)   # padding
+    for row in data:
+        firstcol = ''.join(row[0].ljust(firstcol_width))
+        secondcol = ''.join(row[1].ljust(secondcol_width))
+        remainingcols = ''.join(word.center(col_width, ' ') for word in row[2:])
+        print(f'{firstcol} {secondcol} {remainingcols}')
+    print('\x1b[1;33;40m'+f'Result summary shows mean SNR and OSNR (average over all channels)' +\
+          '\x1b[0m')
+
+    return propagatedpths, reversed_propagatedpths, rqs
+
+
+def launch_cli(network, data, equipment):
+    """ Compute requests using network, data and equipment with client line interface
+    """
+    propagatedpths, reversed_propagatedpths, rqs = compute_requests(network, data, equipment)
+    #Generate the output
+    if ARGS.output :
+        result = []
+        # assumes that list of rqs and list of propgatedpths have same order
+        for i, pth in enumerate(propagatedpths):
+            result.append(Result_element(rqs[i], pth, reversed_propagatedpths[i]))
+        temp = path_result_json(result)
+        fnamecsv = f'{str(ARGS.output)[0:len(str(ARGS.output))-len(str(ARGS.output.suffix))]}.csv'
+        fnamejson = f'{str(ARGS.output)[0:len(str(ARGS.output))-len(str(ARGS.output.suffix))]}.json'
+        with open(fnamejson, 'w', encoding='utf-8') as fjson:
+            fjson.write(dumps(path_result_json(result), indent=2, ensure_ascii=False))
+            with open(fnamecsv, "w", encoding='utf-8') as fcsv:
+                jsontocsv(temp, equipment, fcsv)
+                print('\x1b[1;34;40m'+f'saving in {ARGS.output} and {fnamecsv}'+ '\x1b[0m')
+
+class GnpyAPI(Resource):
+    """ Compute requests using network, data and equipment with rest api
+    """
+    def get(self):
+        return {"ping": True}, 200
+
+    def post(self):
+        data = request.get_json()
+        equipment = load_equipment('examples/2019-demo-equipment.json')
+        topo_json = load_json('examples/2019-demo-topology.json')
+        network = network_from_json(topo_json, equipment)
+        try:
+            propagatedpths, reversed_propagatedpths, rqs = compute_requests(network, data, equipment)
+            # Generate the output
+            result = []
+            #assumes that list of rqs and list of propgatedpths have same order
+            for i, pth in enumerate(propagatedpths):
+                result.append(Result_element(rqs[i], pth, reversed_propagatedpths[i]))
+
+            return {"result":path_result_json(result)}, 201
+        except ServiceError as this_e:
+            msg = f'Service error: {this_e}'
+            return {"result": msg}, 400
+
+API.add_resource(GnpyAPI, '/gnpy-experimental')
+
+def main(args):
+    """ main function that calls all functions
+    """
+    LOGGER.info(f'Computing path requests {args.service_filename} into JSON format')
+    print('\x1b[1;34;40m' +\
+          f'Computing path requests {args.service_filename} into JSON format'+ '\x1b[0m')
+    # for debug
+    # print( args.eqpt_filename)
+
+    try:
+        data = load_requests(args.service_filename, args.eqpt_filename, args.bidir)
+        equipment = load_equipment(args.eqpt_filename)
+        network = load_network(args.network_filename, equipment)
+    except EquipmentConfigError as this_e:
+        print(f'{ansi_escapes.red}Configuration error in the equipment library:{ansi_escapes.reset} {this_e}')
+        exit(1)
+    except NetworkTopologyError as this_e:
+        print(f'{ansi_escapes.red}Invalid network definition:{ansi_escapes.reset} {this_e}')
+        exit(1)
+    except ConfigurationError as this_e:
+        print(f'{ansi_escapes.red}Configuration error:{ansi_escapes.reset} {this_e}')
+        exit(1)
+    except ServiceError as this_e:
+        print(f'{ansi_escapes.red}Service error:{ansi_escapes.reset} {this_e}')
+        exit(1)
+    # input_str = raw_input("How will you use your program: c:[cli] , a:[api] ?")
+    # print(input_str)
+    #
+    if ((args.rest == 1) and (args.output is None)):
+        print('you have chosen the rest mode')
+        APP.run(host='0.0.0.0', port=5000, debug=True)
+    elif ((args.rest > 1) or ((args.rest == 1) and (args.output is not None))):
+        print('command is not well formulated')
+    else:
+        launch_cli(network, data, equipment)
+
+if __name__ == '__main__':
+    ARGS = PARSER.parse_args()
+    basicConfig(level={2: DEBUG, 1: INFO, 0: CRITICAL}.get(ARGS.verbose, DEBUG))
+    main(ARGS)

examples/raman_edfa_example_network.json

@@ -20,18 +20,19 @@
         "temperature": 283,
         "raman_pumps": [
           {
-            "power": 224.403e-3,
+            "power": 200e-3,
             "frequency": 205e12,
             "propagation_direction": "counterprop"
           },
           {
-            "power": 231.135e-3,
+            "power": 206e-3,
             "frequency": 201e12,
             "propagation_direction": "counterprop"
           }
         ]
       },
       "params": {
+        "type_variety": "SSMF",
         "length": 80.0,
         "loss_coef": 0.2,
         "length_units": "km",
@@ -48,21 +49,6 @@
         }
       }
     },
-    {
-      "uid": "Fused1",
-      "type": "Fused",
-      "params": {
-        "loss": 0
-      },
-      "metadata": {
-        "location": {
-          "latitude": 1.5,
-          "longitude": 0,
-          "city": null,
-          "region": ""
-        }
-      }
-    },
     {
       "uid": "Edfa1",
       "type": "Edfa",
@@ -102,10 +88,6 @@
     },
     {
       "from_node": "Span1",
-      "to_node": "Fused1"
-    },
-    {
-      "from_node": "Fused1",
       "to_node": "Edfa1"
     },
     {

examples/serviceDemov1.json

@@ -0,0 +1,180 @@
+{
+  "path-request": [
+    {
+      "request-id": "0",
+      "source": "trx site_a",
+      "destination": "trx site_b",
+      "src-tp-id": "trx site_a",
+      "dst-tp-id": "trx site_b",
+      "bidirectional": false,
+      "path-constraints": {
+        "te-bandwidth": {
+          "technology": "flexi-grid",
+          "trx_type": "Voyager",
+          "trx_mode": null,
+          "effective-freq-slot": [
+            {
+              "N": "null",
+              "M": "null"
+            }
+          ],
+          "spacing": 50000000000.0,
+          "max-nb-of-channel": null,
+          "output-power": null,
+          "path_bandwidth": 100000000000.0
+        }
+      }
+    },
+    {
+      "request-id": "1",
+      "source": "trx site_a",
+      "destination": "trx site_b",
+      "src-tp-id": "trx site_a",
+      "dst-tp-id": "trx site_b",
+      "bidirectional": false,
+      "path-constraints": {
+        "te-bandwidth": {
+          "technology": "flexi-grid",
+          "trx_type": "Voyager",
+          "trx_mode": "mode 1",
+          "effective-freq-slot": [
+            {
+              "N": "null",
+              "M": "null"
+            }
+          ],
+          "spacing": 50000000000.0,
+          "max-nb-of-channel": null,
+          "output-power": null,
+          "path_bandwidth": 200000000000.0
+        }
+      },
+      "explicit-route-objects": {
+        "route-object-include-exclude": [
+          {
+            "explicit-route-usage": "route-include-ero",
+            "index": 0,
+            "num-unnum-hop": {
+              "node-id": "Span1ab",
+              "link-tp-id": "link-tp-id is not used",
+              "hop-type": "STRICT"
+            }
+          }
+        ]
+      }
+    },
+    {
+      "request-id": "2",
+      "source": "trx site_a",
+      "destination": "trx site_b",
+      "src-tp-id": "trx site_a",
+      "dst-tp-id": "trx site_b",
+      "bidirectional": false,
+      "path-constraints": {
+        "te-bandwidth": {
+          "technology": "flexi-grid",
+          "trx_type": "Voyager",
+          "trx_mode": "mode 1",
+          "effective-freq-slot": [
+            {
+              "N": "null",
+              "M": "null"
+            }
+          ],
+          "spacing": 50000000000.0,
+          "max-nb-of-channel": null,
+          "output-power": null,
+          "path_bandwidth": 200000000000.0
+        }
+      },
+      "explicit-route-objects": {
+        "route-object-include-exclude": [
+          {
+            "explicit-route-usage": "route-include-ero",
+            "index": 0,
+            "num-unnum-hop": {
+              "node-id": "roadm site_c",
+              "link-tp-id": "link-tp-id is not used",
+              "hop-type": "STRICT"
+            }
+          }
+        ]
+      }
+    },
+    {
+      "request-id": "3",
+      "source": "trx site_a",
+      "destination": "trx site_b",
+      "src-tp-id": "trx site_a",
+      "dst-tp-id": "trx site_b",
+      "bidirectional": false,
+      "path-constraints": {
+        "te-bandwidth": {
+          "technology": "flexi-grid",
+          "trx_type": "Voyager",
+          "trx_mode": null,
+          "effective-freq-slot": [
+            {
+              "N": "null",
+              "M": "null"
+            }
+          ],
+          "spacing": 50000000000.0,
+          "max-nb-of-channel": null,
+          "output-power": null,
+          "path_bandwidth": 100000000000.0
+        }
+      }
+    },
+    {
+      "request-id": "4",
+      "source": "trx site_a",
+      "destination": "trx site_b",
+      "src-tp-id": "trx site_a",
+      "dst-tp-id": "trx site_b",
+      "bidirectional": false,
+      "path-constraints": {
+        "te-bandwidth": {
+          "technology": "flexi-grid",
+          "trx_type": "Voyager",
+          "trx_mode": null,
+          "effective-freq-slot": [
+            {
+              "N": "null",
+              "M": "null"
+            }
+          ],
+          "spacing": 50000000000.0,
+          "max-nb-of-channel": null,
+          "output-power": null,
+          "path_bandwidth": 100000000000.0
+        }
+      }
+    }
+  ],
+  "synchronization": [
+    {
+      "synchronization-id": "x",
+      "svec": {
+        "relaxable": "false",
+        "disjointness": "node link",
+        "request-id-number": [
+          "3",
+          "0"
+        ]
+      }
+    },
+    {
+      "synchronization-id": "y",
+      "svec": {
+        "relaxable": "false",
+        "disjointness": "node link",
+        "request-id-number": [
+          "4",
+          "3",
+          "0"
+        ]
+      }
+    }
+  ]
+}

examples/sim_params.json

@@ -0,0 +1,14 @@
+{
+  "raman_computed_channels": [1, 18, 37, 56, 75],
+  "raman_parameters": {
+    "flag_raman": true,
+    "space_resolution": 10e3,
+    "tolerance": 1e-8
+  },
+  "nli_parameters": {
+  	"nli_method_name": "ggn_spectrally_separated",
+  	"wdm_grid_size": 50e9,
+  	"dispersion_tolerance": 1,
+  	"phase_shift_tollerance": 0.1
+  }
+}

examples/std_medium_gain_advanced_config.json

@@ -0,0 +1,303 @@
+{     "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
+      ]
+}

examples/topoDemov1.json

@@ -0,0 +1,703 @@
+{
+  "elements": [
+    {
+      "uid": "trx site_a",
+      "type": "Transceiver",
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": "Site a",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "roadm site_a",
+      "type": "Roadm",
+      "params": {
+        "target_pch_out_db": -20,
+        "restrictions": {
+          "preamp_variety_list": [],
+          "booster_variety_list": []
+        }
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": "Site a",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "Span1ab",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "type_variety": "SSMF",
+        "length": 100.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.5,
+        "con_out": 0.5
+      },
+      "metadata": {
+        "location": {
+          "latitude": 1,
+          "longitude": 0,
+          "city": null,
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "Span1ba",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "type_variety": "SSMF",
+        "length": 100.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.5,
+        "con_out": 0.5
+      },
+      "metadata": {
+        "location": {
+          "latitude": 1,
+          "longitude": 0,
+          "city": null,
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "Span2ab",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "type_variety": "SSMF",
+        "length": 80.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.5,
+        "con_out": 0.5
+      },
+      "metadata": {
+        "location": {
+          "latitude": 1,
+          "longitude": 0,
+          "city": null,
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "Span2ba",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "type_variety": "SSMF",
+        "length": 80.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.5,
+        "con_out": 0.5
+      },
+      "metadata": {
+        "location": {
+          "latitude": 1,
+          "longitude": 0,
+          "city": null,
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "roadm site_b",
+      "type": "Roadm",
+      "params": {
+        "target_pch_out_db": -20,
+        "restrictions": {
+          "preamp_variety_list": [],
+          "booster_variety_list": []
+        }
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": "Site b",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "trx site_b",
+      "type": "Transceiver",
+      "metadata": {
+        "location": {
+          "latitude": 2,
+          "longitude": 0,
+          "city": "Site b",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "booster1 site_a",
+      "type": "Edfa",
+      "type_variety": "std_medium_gain",
+      "operational": {
+        "gain_target": 19.0,
+        "delta_p": -1.0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site a",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "preamp site_b",
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": 18.0,
+        "delta_p": 0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site b",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "booster1 site_b",
+      "type": "Edfa",
+      "type_variety": "std_medium_gain",
+      "operational": {
+        "gain_target": 19.0,
+        "delta_p": -1.0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site b",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "preamp1 site_a",
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": 18.0,
+        "delta_p": 0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site_a",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "booster2 site_a",
+      "type": "Edfa",
+      "type_variety": "std_medium_gain",
+      "operational": {
+        "gain_target": 19.0,
+        "delta_p": -1.0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site a",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "preamp2 site_b",
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": 18.0,
+        "delta_p": 0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site_b",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "booster2 site_b",
+      "type": "Edfa",
+      "type_variety": "std_medium_gain",
+      "operational": {
+        "gain_target": 19.0,
+        "delta_p": -1.0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site b",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "preamp2 site_a",
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": 18.0,
+        "delta_p": 0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site_a",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "booster3 site_a",
+      "type": "Edfa",
+      "type_variety": "std_medium_gain",
+      "operational": {
+        "gain_target": 19.0,
+        "delta_p": -1.0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site a",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "preamp3 site_b",
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": 18.0,
+        "delta_p": 0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site_b",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "booster3 site_b",
+      "type": "Edfa",
+      "type_variety": "std_medium_gain",
+      "operational": {
+        "gain_target": 19.0,
+        "delta_p": -1.0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site b",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "preamp3 site_a",
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": 18.0,
+        "delta_p": 0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site_a",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "roadm site_c",
+      "type": "Roadm",
+      "params": {
+        "target_pch_out_db": -20,
+        "restrictions": {
+          "preamp_variety_list": [],
+          "booster_variety_list": []
+        }
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0,
+          "longitude": 0,
+          "city": "Site c",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "booster1 site_c",
+      "type": "Edfa",
+      "type_variety": "std_medium_gain",
+      "operational": {
+        "gain_target": 19.0,
+        "delta_p": -1.0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site c",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "preamp1 site_c",
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": 18.0,
+        "delta_p": 0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site_c",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "booster2 site_c",
+      "type": "Edfa",
+      "type_variety": "std_medium_gain",
+      "operational": {
+        "gain_target": 19.0,
+        "delta_p": -1.0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site c",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "preamp2 site_c",
+      "type": "Edfa",
+      "type_variety": "std_low_gain",
+      "operational": {
+        "gain_target": 18.0,
+        "delta_p": 0,
+        "tilt_target": 0,
+        "out_voa": 0
+      },
+      "metadata": {
+        "location": {
+          "latitude": 0.5,
+          "longitude": 0.0,
+          "city": "Site_c",
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "Span1ac",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "type_variety": "SSMF",
+        "length": 80.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.5,
+        "con_out": 0.5
+      },
+      "metadata": {
+        "location": {
+          "latitude": 1,
+          "longitude": 0,
+          "city": null,
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "Span1ca",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "type_variety": "SSMF",
+        "length": 80.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.5,
+        "con_out": 0.5
+      },
+      "metadata": {
+        "location": {
+          "latitude": 1,
+          "longitude": 0,
+          "city": null,
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "Span1bc",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "type_variety": "SSMF",
+        "length": 80.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.5,
+        "con_out": 0.5
+      },
+      "metadata": {
+        "location": {
+          "latitude": 1,
+          "longitude": 0,
+          "city": null,
+          "region": ""
+        }
+      }
+    },
+    {
+      "uid": "Span1cb",
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "type_variety": "SSMF",
+        "length": 80.0,
+        "loss_coef": 0.2,
+        "length_units": "km",
+        "att_in": 0,
+        "con_in": 0.5,
+        "con_out": 0.5
+      },
+      "metadata": {
+        "location": {
+          "latitude": 1,
+          "longitude": 0,
+          "city": null,
+          "region": ""
+        }
+      }
+    }
+  ],
+  "connections": [
+    {
+      "from_node": "trx site_a",
+      "to_node": "roadm site_a"
+    },
+    {
+      "from_node": "roadm site_a",
+      "to_node": "booster1 site_a"
+    },
+    {
+      "from_node": "booster1 site_a",
+      "to_node": "Span1ab"
+    },
+    {
+      "from_node": "Span1ab",
+      "to_node": "preamp site_b"
+    },
+    {
+      "from_node": "preamp site_b",
+      "to_node": "roadm site_b"
+    },
+    {
+      "from_node": "roadm site_b",
+      "to_node": "trx site_b"
+    },
+    {
+      "from_node": "roadm site_a",
+      "to_node": "booster2 site_a"
+    },
+    {
+      "from_node": "booster2 site_a",
+      "to_node": "Span2ab"
+    },
+    {
+      "from_node": "Span2ab",
+      "to_node": "preamp2 site_b"
+    },
+    {
+      "from_node": "preamp2 site_b",
+      "to_node": "roadm site_b"
+    },
+    {
+      "from_node": "roadm site_b",
+      "to_node": "booster1 site_b"
+    },
+    {
+      "from_node": "booster1 site_b",
+      "to_node": "Span1ba"
+    },
+    {
+      "from_node": "Span1ba",
+      "to_node": "preamp1 site_a"
+    },
+    {
+      "from_node": "preamp1 site_a",
+      "to_node": "roadm site_a"
+    },
+    {
+      "from_node": "roadm site_b",
+      "to_node": "booster2 site_b"
+    },
+    {
+      "from_node": "booster2 site_b",
+      "to_node": "Span2ba"
+    },
+    {
+      "from_node": "Span2ba",
+      "to_node": "preamp2 site_a"
+    },
+    {
+      "from_node": "preamp2 site_a",
+      "to_node": "roadm site_a"
+    },
+    {
+      "from_node": "roadm site_a",
+      "to_node": "booster3 site_a"
+    },
+    {
+      "from_node": "booster3 site_a",
+      "to_node": "Span1ac"
+    },
+    {
+      "from_node": "Span1ac",
+      "to_node": "preamp1 site_c"
+    },
+    {
+      "from_node": "preamp1 site_c",
+      "to_node": "roadm site_c"
+    },
+    {
+      "from_node": "roadm site_c",
+      "to_node": "booster1 site_c"
+    },
+    {
+      "from_node": "booster1 site_c",
+      "to_node": "Span1cb"
+    },
+    {
+      "from_node": "Span1cb",
+      "to_node": "preamp3 site_b"
+    },
+    {
+      "from_node": "preamp3 site_b",
+      "to_node": "roadm site_b"
+    },
+    {
+      "from_node": "roadm site_b",
+      "to_node": "booster3 site_b"
+    },
+    {
+      "from_node": "booster3 site_b",
+      "to_node": "Span1bc"
+    },
+    {
+      "from_node": "Span1bc",
+      "to_node": "preamp2 site_c"
+    },
+    {
+      "from_node": "preamp2 site_c",
+      "to_node": "roadm site_c"
+    },
+    {
+      "from_node": "roadm site_c",
+      "to_node": "booster2 site_c"
+    },
+    {
+      "from_node": "booster2 site_c",
+      "to_node": "Span1ca"
+    },
+    {
+      "from_node": "Span1ca",
+      "to_node": "preamp3 site_a"
+    },
+    {
+      "from_node": "preamp3 site_a",
+      "to_node": "roadm site_a"
+    }
+  ]
+}

examples/transmission_main_example.py

@@ -0,0 +1,319 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+'''
+transmission_main_example.py
+============================
+
+Main example for transmission simulation.
+
+Reads from network JSON (by default, `edfa_example_network.json`)
+'''
+
+from gnpy.core.equipment import load_equipment, trx_mode_params
+from gnpy.core.utils import db2lin, lin2db, write_csv
+from argparse import ArgumentParser
+from sys import exit
+from pathlib import Path
+from json import loads
+from collections import Counter
+from logging import getLogger, basicConfig, INFO, ERROR, DEBUG
+from numpy import linspace, mean, log10
+from matplotlib.pyplot import show, axis, figure, title, text
+from networkx import (draw_networkx_nodes, draw_networkx_edges,
+                      draw_networkx_labels, dijkstra_path)
+from gnpy.core.network import load_network, build_network, save_network, load_sim_params, configure_network
+from gnpy.core.elements import Transceiver, Fiber, RamanFiber, Edfa, Roadm
+from gnpy.core.info import create_input_spectral_information, SpectralInformation, Channel, Power, Pref
+from gnpy.core.request import Path_request, RequestParams, compute_constrained_path, propagate2
+from gnpy.core.exceptions import ConfigurationError, EquipmentConfigError, NetworkTopologyError
+import gnpy.core.ansi_escapes as ansi_escapes
+
+logger = getLogger(__name__)
+
+def plot_baseline(network):
+    edges = set(network.edges())
+    pos = {n: (n.lng, n.lat) for n in network.nodes()}
+    labels = {n: n.location.city 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})
+    axis('off')
+    show()
+
+def plot_results(network, path, source, destination, infos):
+    path_edges = set(zip(path[:-1], path[1:]))
+    edges = set(network.edges()) - path_edges
+    pos = {n: (n.lng, n.lat) for n in network.nodes()}
+    nodes = {}
+    for k, (x, y) in pos.items():
+        nodes.setdefault((round(x, 1), round(y, 1)), []).append(k)
+    labels = {n: n.location.city 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})
+    title(f'Propagating from {source.loc.city} to {destination.loc.city}')
+    axis('off')
+
+    heading = 'Spectral Information\n\n'
+    textbox = text(0.85, 0.20, heading, fontsize=14, fontname='Ubuntu Mono',
+                   verticalalignment='top', transform=fig.axes[0].transAxes,
+                   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()}
+
+    def hover(event):
+        if event.xdata is None or event.ydata is None:
+            return
+        if fig.contains(event):
+            x, y = round(event.xdata, 1), round(event.ydata, 1)
+            if (x, y) in msgs:
+                textbox.set_text(msgs[x, y])
+            else:
+                textbox.set_text(heading)
+            fig.canvas.draw_idle()
+
+    fig.canvas.mpl_connect('motion_notify_event', hover)
+    show()
+
+
+def main(network, equipment, source, destination, sim_params, req=None):
+    result_dicts = {}
+    network_data = [{
+                    'network_name'  : str(args.filename),
+                    'source'        : source.uid,
+                    'destination'   : destination.uid
+                    }]
+    result_dicts.update({'network': network_data})
+    design_data = [{
+                    'power_mode'        : equipment['Span']['default'].power_mode,
+                    'span_power_range'  : equipment['Span']['default'].delta_power_range_db,
+                    'design_pch'        : equipment['SI']['default'].power_dbm,
+                    'baud_rate'         : equipment['SI']['default'].baud_rate
+                    }]
+    result_dicts.update({'design': design_data})
+    simulation_data = []
+    result_dicts.update({'simulation results': simulation_data})
+
+    power_mode = equipment['Span']['default'].power_mode
+    print('\n'.join([f'Power mode is set to {power_mode}',
+                     f'=> it can be modified in eqpt_config.json - Span']))
+
+    pref_ch_db = lin2db(req.power*1e3) #reference channel power / span (SL=20dB)
+    pref_total_db = pref_ch_db + lin2db(req.nb_channel) #reference total power / span (SL=20dB)
+    build_network(network, equipment, pref_ch_db, pref_total_db)
+    path = compute_constrained_path(network, req)
+
+    if len([s.length for s in path if isinstance(s, RamanFiber)]):
+        if sim_params is None:
+            print(f'{ansi_escapes.red}Invocation error:{ansi_escapes.reset} RamanFiber requires passing simulation params via --sim-params')
+            exit(1)
+        configure_network(network, sim_params)
+
+    spans = [s.length for s in path if isinstance(s, RamanFiber) or isinstance(s, Fiber)]
+    print(f'\nThere are {len(spans)} fiber spans over {sum(spans)/1000:.0f} km between {source.uid} and {destination.uid}')
+    print(f'\nNow propagating between {source.uid} and {destination.uid}:')
+
+    try:
+        p_start, p_stop, p_step = equipment['SI']['default'].power_range_db
+        p_num = abs(int(round((p_stop - p_start)/p_step))) + 1 if p_step != 0 else 1
+        power_range = list(linspace(p_start, p_stop, p_num))
+    except TypeError:
+        print('invalid power range definition in eqpt_config, should be power_range_db: [lower, upper, step]')
+        power_range = [0]
+
+    if not power_mode:
+        #power cannot be changed in gain mode
+        power_range = [0]
+    for dp_db in power_range:
+        req.power = db2lin(pref_ch_db + dp_db)*1e-3
+        if power_mode:
+            print(f'\nPropagating with input power = {ansi_escapes.cyan}{lin2db(req.power*1e3):.2f} dBm{ansi_escapes.reset}:')
+        else:
+            print(f'\nPropagating in {ansi_escapes.cyan}gain mode{ansi_escapes.reset}: power cannot be set manually')
+        infos = propagate2(path, req, equipment)
+        if len(power_range) == 1:
+            for elem in path:
+                print(elem)
+            if power_mode:
+                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}')
+        else:
+            print(path[-1])
+
+        #print(f'\n !!!!!!!!!!!!!!!!!     TEST POINT         !!!!!!!!!!!!!!!!!!!!!')
+        #print(f'carriers ase output of {path[1]} =\n {list(path[1].carriers("out", "nli"))}')
+        # => use "in" or "out" parameter
+        # => use "nli" or "ase" or "signal" or "total" parameter        
+        if power_mode:
+            simulation_data.append({
+                        'Pch_dBm'               : pref_ch_db + dp_db,
+                        'OSNR_ASE_0.1nm'        : round(mean(destination.osnr_ase_01nm),2),
+                        'OSNR_ASE_signal_bw'    : round(mean(destination.osnr_ase),2),
+                        'SNR_nli_signal_bw'     : round(mean(destination.osnr_nli),2),
+                        'SNR_total_signal_bw'   : round(mean(destination.snr),2)
+                                })
+        else:
+            simulation_data.append({
+                        'gain_mode'             : 'power canot be set',
+                        'OSNR_ASE_0.1nm'        : round(mean(destination.osnr_ase_01nm),2),
+                        'OSNR_ASE_signal_bw'    : round(mean(destination.osnr_ase),2),
+                        'SNR_nli_signal_bw'     : round(mean(destination.osnr_nli),2),
+                        'SNR_total_signal_bw'   : round(mean(destination.snr),2)
+                                })
+    write_csv(result_dicts, 'simulation_result.csv')
+    return path, infos
+
+
+parser = ArgumentParser()
+parser.add_argument('-e', '--equipment', type=Path,
+                    default=Path(__file__).parent / 'eqpt_config.json')
+parser.add_argument('--sim-params', type=Path,
+                    default=None, help='Path to the JSON containing simulation parameters (required for Raman)')
+parser.add_argument('--show-channels', action='store_true', help='Show final per-channel OSNR summary')
+parser.add_argument('-pl', '--plot', action='store_true')
+parser.add_argument('-v', '--verbose', action='count', default=0, help='increases verbosity for each occurence')
+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')
+parser.add_argument('-names', '--names-matching', action='store_true', help='display network names that are closed matches')
+parser.add_argument('filename', nargs='?', type=Path,
+                    default=Path(__file__).parent / 'edfa_example_network.json')
+parser.add_argument('source', nargs='?', help='source node')
+parser.add_argument('destination',   nargs='?', help='destination node')
+
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    basicConfig(level={0: ERROR, 1: INFO, 2: DEBUG}.get(args.verbose, DEBUG))
+
+    try:
+        equipment = load_equipment(args.equipment)
+        network = load_network(args.filename, equipment, args.names_matching)
+        sim_params = load_sim_params(args.sim_params) if args.sim_params is not None else None
+    except EquipmentConfigError as e:
+        print(f'{ansi_escapes.red}Configuration error in the equipment library:{ansi_escapes.reset} {e}')
+        exit(1)
+    except NetworkTopologyError as e:
+        print(f'{ansi_escapes.red}Invalid network definition:{ansi_escapes.reset} {e}')
+        exit(1)
+    except ConfigurationError as e:
+        print(f'{ansi_escapes.red}Configuration error:{ansi_escapes.reset} {e}')
+        exit(1)
+
+    if args.plot:
+        plot_baseline(network)
+
+    transceivers = {n.uid: n for n in network.nodes() if isinstance(n, Transceiver)}
+
+    if not transceivers:
+        exit('Network has no transceivers!')
+    if len(transceivers) < 2:
+        exit('Network has only one transceiver!')
+
+    if args.list_nodes:
+        for uid in transceivers:
+            print(uid)
+        exit()
+
+    #First try to find exact match if source/destination provided
+    if args.source:
+        source = transceivers.pop(args.source, None)
+        valid_source = True if source else False
+    else:
+        source = None
+        logger.info('No source node specified: picking random transceiver')
+
+    if args.destination:
+        destination = transceivers.pop(args.destination, None)
+        valid_destination = True if destination else False
+    else:
+        destination = None
+        logger.info('No destination node specified: picking random transceiver')
+
+    #If no exact match try to find partial match
+    if args.source and not source:
+        #TODO code a more advanced regex to find nodes match
+        source = next((transceivers.pop(uid) for uid in transceivers \
+                  if args.source.lower() in uid.lower()), None)
+
+    if args.destination and not destination:
+        #TODO code a more advanced regex to find nodes match
+        destination = next((transceivers.pop(uid) for uid in transceivers \
+                  if args.destination.lower() in uid.lower()), None)
+
+    #If no partial match or no source/destination provided pick random
+    if not source:
+        source = list(transceivers.values())[0]
+        del transceivers[source.uid]
+
+    if not destination:
+        destination = list(transceivers.values())[0]
+
+    logger.info(f'source = {args.source!r}')
+    logger.info(f'destination = {args.destination!r}')
+
+    params = {}
+    params['request_id'] = 0
+    params['trx_type'] = ''
+    params['trx_mode'] = ''
+    params['source'] = source.uid
+    params['destination'] = destination.uid
+    params['bidir'] = False
+    params['nodes_list'] = [destination.uid]
+    params['loose_list'] = ['strict']
+    params['format'] = ''
+    params['path_bandwidth'] = 0
+    trx_params = trx_mode_params(equipment)
+    if args.power:
+        trx_params['power'] = db2lin(float(args.power))*1e-3
+    params.update(trx_params)
+    req = Path_request(**params)
+    path, infos = main(network, equipment, source, destination, sim_params, req)
+    save_network(args.filename, network)
+
+    if args.show_channels:
+        print('\nThe total SNR per channel at the end of the line is:')
+        print('{:>5}{:>26}{:>26}{:>28}{:>28}{:>28}' \
+            .format('Ch. #', 'Channel frequency (THz)', 'Channel power (dBm)', 'OSNR ASE (signal bw, dB)', 'SNR NLI (signal bw, dB)', 'SNR total (signal bw, dB)'))
+        for final_carrier, ch_osnr, ch_snr_nl, ch_snr in zip(infos[path[-1]][1].carriers, path[-1].osnr_ase, path[-1].osnr_nli, path[-1].snr):
+            ch_freq = final_carrier.frequency * 1e-12
+            ch_power = lin2db(final_carrier.power.signal*1e3)
+            print('{:5}{:26.2f}{:26.2f}{:28.2f}{:28.2f}{:28.2f}' \
+                .format(final_carrier.channel_number, round(ch_freq, 2), round(ch_power, 2), round(ch_osnr, 2), round(ch_snr_nl, 2), round(ch_snr, 2)))
+
+    if not args.source:
+        print(f'\n(No source node specified: picked {source.uid})')
+    elif not valid_source:
+        print(f'\n(Invalid source node {args.source!r} replaced with {source.uid})')
+
+    if not args.destination:
+        print(f'\n(No destination node specified: picked {destination.uid})')
+    elif not valid_destination:
+        print(f'\n(Invalid destination node {args.destination!r} replaced with {destination.uid})')
+
+    if args.plot:
+        plot_results(network, path, source, destination, infos)

examples/write_path_jsontocsv.py

@@ -1,11 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# SPDX-License-Identifier: BSD-3-Clause
-# Reads JSON path result file and writes results to a CSV file
-# Copyright (C) 2025 Telecom Infra Project and GNPy contributors
-# see AUTHORS.rst for a list of contributors
-
 """
 write_path_jsontocsv.py
 ========================
@@ -19,14 +14,14 @@ See: draft-ietf-teas-yang-path-computation-01.txt
 from argparse import ArgumentParser
 from pathlib import Path
 from json import loads
-from gnpy.tools.json_io import load_equipment
-from gnpy.topology.request import jsontocsv
+from gnpy.core.equipment  import load_equipment
+from gnpy.core.request  import jsontocsv
 
 
-parser = ArgumentParser(description='Converting JSON path results into a CSV')
-parser.add_argument('filename', type=Path)
-parser.add_argument('output_filename', type=Path)
-parser.add_argument('eqpt_filename', nargs='?', type=Path, default=Path(__file__).parent / 'eqpt_config.json')
+parser = ArgumentParser(description = 'A function that writes json path results in an excel sheet.')
+parser.add_argument('filename', nargs='?', type = Path)
+parser.add_argument('output_filename', nargs='?', type = Path)
+parser.add_argument('eqpt_filename', nargs='?', type = Path, default=Path(__file__).parent / 'eqpt_config.json')
 
 if __name__ == '__main__':
     args = parser.parse_args()
@@ -37,4 +32,5 @@ if __name__ == '__main__':
             json_data = loads(f.read())
             equipment = load_equipment(args.eqpt_filename)
             print(f'Writing in {args.output_filename}')
-            jsontocsv(json_data, equipment, file)
+            jsontocsv(json_data,equipment,file)
+

gnpy/__init__.py

@@ -1,8 +0,0 @@
-"""
-GNPy is an open-source, community-developed library for building route planning and optimization tools in real-world mesh optical networks. It is based on the Gaussian Noise Model.
-
-Signal propagation is implemented in :py:mod:`.core`.
-Path finding and spectrum assignment is in :py:mod:`.topology`.
-Various tools and auxiliary code, including the JSON I/O handling, is in
-:py:mod:`.tools`.
-"""

gnpy/core/__init__.py

@@ -1,9 +1,30 @@
-"""
-Simulation of signal propagation in the DWDM network
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
 
-Optical signals, as defined via :class:`.info.SpectralInformation`, enter
-:py:mod:`.elements` which compute how these signals are affected as they travel
-through the :py:mod:`.network`.
-The simulation is controlled via :py:mod:`.parameters` and implemented mainly
-via :py:mod:`.science_utils`.
-"""
+########################################################################
+#                _____ ___ ____    ____  ____  _____                   #
+#               |_   _|_ _|  _ \  |  _ \/ ___|| ____|                  #
+#                 | |  | || |_) | | |_) \___ \|  _|                    #
+#                 | |  | ||  __/  |  __/ ___) | |___                   #
+#                 |_| |___|_|     |_|   |____/|_____|                  #
+#                                                                      #
+#                == Physical Simulation Environment ==                 #
+#                                                                      #
+########################################################################
+
+
+'''
+gnpy route planning and optimization library
+============================================
+
+gnpy is a route planning and optimization library, written in Python, for
+operators of large-scale mesh optical networks.
+
+:copyright: © 2018, Telecom Infra Project
+:license: BSD 3-Clause, see LICENSE for more details.
+'''
+
+from . import elements
+from .execute import *
+from .network import *
+from .utils import *

gnpy/core/ansi_escapes.py

@@ -1,20 +1,13 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# SPDX-License-Identifier: BSD-3-Clause
-# gnpy.core.ansi_escapes: A random subset of ANSI terminal escape codes for colored messages
-# Copyright (C) 2025 Telecom Infra Project and GNPy contributors
-# see AUTHORS.rst for a list of contributors
-
-"""
+'''
 gnpy.core.ansi_escapes
 ======================
 
 A random subset of ANSI terminal escape codes for colored messages
-"""
+'''
 
 red = '\x1b[1;31;40m'
-blue = '\x1b[1;34;40m'
 cyan = '\x1b[1;36;40m'
-yellow = '\x1b[1;33;40m'
 reset = '\x1b[0m'

gnpy/core/convert.py

@@ -0,0 +1,627 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+gnpy.core.convert
+=================
+
+This module contains utilities for converting between XLS and JSON.
+
+The input XLS file must contain sheets named "Nodes" and "Links".
+It may optionally contain a sheet named "Eqpt".
+
+In the "Nodes" sheet, only the "City" column is mandatory. The column "Type"
+can be determined automatically given the topology (e.g., if degree 2, ILA;
+otherwise, ROADM.) Incorrectly specified types (e.g., ILA for node of
+degree ≠ 2) will be automatically corrected.
+
+In the "Links" sheet, only the first three columns ("Node A", "Node Z" and
+"east Distance (km)") are mandatory.  Missing "west" information is copied from
+the "east" information so that it is possible to input undirected data.
+"""
+
+from sys import exit
+try:
+    from xlrd import open_workbook
+except ModuleNotFoundError:
+    exit('Required: `pip install xlrd`')
+from argparse import ArgumentParser
+from collections import namedtuple, Counter, defaultdict
+from itertools import chain
+from json import dumps
+from pathlib import Path
+from difflib import get_close_matches
+from gnpy.core.utils import silent_remove
+import time
+
+all_rows = lambda sh, start=0: (sh.row(x) for x in range(start, sh.nrows))
+
+class Node(object):
+    def __init__(self, **kwargs):
+        super(Node, self).__init__()
+        self.update_attr(kwargs)
+
+    def update_attr(self, kwargs):
+        clean_kwargs = {k:v for k,v in kwargs.items() if v !=''}
+        for k,v in self.default_values.items():
+            v = clean_kwargs.get(k,v)
+            setattr(self, k, v)
+
+    default_values = \
+    {
+        'city':         '',
+        'state':        '',
+        'country':      '',
+        'region':       '',
+        'latitude':     0,
+        'longitude':    0,
+        'node_type':    'ILA',
+        'booster_restriction' : '',
+        'preamp_restriction'  : ''
+    }
+
+class Link(object):
+    """attribtes from west parse_ept_headers dict
+    +node_a, node_z, west_fiber_con_in, east_fiber_con_in
+    """
+    def __init__(self, **kwargs):
+        super(Link, self).__init__()
+        self.update_attr(kwargs)
+        self.distance_units = 'km'
+
+    def update_attr(self, kwargs):
+        clean_kwargs = {k:v for k,v in kwargs.items() if v !=''}
+        for k,v in self.default_values.items():
+            v = clean_kwargs.get(k,v)
+            setattr(self, k, v)
+            k = 'west' + k.split('east')[-1]
+            v = clean_kwargs.get(k,v)
+            setattr(self, k, v)
+
+    def __eq__(self, link):
+        return (self.from_city == link.from_city and self.to_city == link.to_city) \
+                or (self.from_city == link.to_city and self.to_city == link.from_city)
+
+    default_values = \
+    {
+            'from_city':            '',
+            'to_city':              '',
+            'east_distance':        80,
+            'east_fiber':           'SSMF',
+            'east_lineic':          0.2,
+            'east_con_in':          None,
+            'east_con_out':         None,
+            'east_pmd':             0.1,
+            'east_cable':           ''
+    }
+
+
+class Eqpt(object):
+    def __init__(self, **kwargs):
+        super(Eqpt, self).__init__()
+        self.update_attr(kwargs)
+
+    def update_attr(self, kwargs):
+        clean_kwargs = {k:v for k,v in kwargs.items() if v !=''}
+        for k,v in self.default_values.items():
+            v_east = clean_kwargs.get(k,v)
+            setattr(self, k, v_east)
+            k = 'west' + k.split('east')[-1]
+            v_west = clean_kwargs.get(k,v)
+            setattr(self, k, v_west)
+
+    default_values = \
+    {
+            'from_city':        '',
+            'to_city':          '',
+            'east_amp_type':    '',
+            'east_att_in':      0,
+            'east_amp_gain':    None,
+            'east_amp_dp':      None,
+            'east_tilt':        0,
+            'east_att_out':     None
+    }
+
+
+def read_header(my_sheet, line, slice_):
+    """ return the list of headers !:= ''
+    header_i = [(header, header_column_index), ...]
+    in a {line, slice1_x, slice_y} range
+    """
+    Param_header = namedtuple('Param_header', 'header colindex')
+    try:
+        header = [x.value.strip() for x in my_sheet.row_slice(line, slice_[0], slice_[1])]
+        header_i = [Param_header(header,i+slice_[0]) for i, header in enumerate(header) if header != '']
+    except Exception:
+        header_i = []
+    if header_i != [] and header_i[-1].colindex != slice_[1]:
+        header_i.append(Param_header('',slice_[1]))
+    return header_i
+
+def read_slice(my_sheet, line, slice_, header):
+    """return the slice range of a given header
+    in a defined range {line, slice_x, slice_y}"""
+    header_i = read_header(my_sheet, line, slice_)
+    slice_range = (-1,-1)
+    if header_i != []:
+        try:
+            slice_range = next((h.colindex,header_i[i+1].colindex) \
+                for i,h in enumerate(header_i) if header in h.header)
+        except Exception:
+            pass
+    return slice_range
+
+
+def parse_headers(my_sheet, input_headers_dict, headers, start_line, slice_in):
+    """return a dict of header_slice
+    key = column index
+    value = header name"""
+
+
+    for h0 in input_headers_dict:
+        slice_out = read_slice(my_sheet, start_line, slice_in, h0)
+        iteration = 1
+        while slice_out == (-1,-1) and iteration < 10:
+            #try next lines
+            #print(h0, iteration)
+            slice_out = read_slice(my_sheet, start_line+iteration, slice_in, h0)
+            iteration += 1
+        if slice_out == (-1, -1):
+            if h0 in ('east', 'Node A', 'Node Z', 'City') :
+                print(f'\x1b[1;31;40m'+f'CRITICAL: missing _{h0}_ header: EXECUTION ENDS'+ '\x1b[0m')
+                exit()
+            else:
+                print(f'missing header {h0}')
+        elif not isinstance(input_headers_dict[h0], dict):
+            headers[slice_out[0]] = input_headers_dict[h0]
+        else:
+            headers = parse_headers(my_sheet, input_headers_dict[h0], headers, start_line+1, slice_out)
+    if headers == {}:
+        print(f'\x1b[1;31;40m'+f'CRITICAL ERROR: could not find any header to read _ ABORT'+ '\x1b[0m')
+        exit()
+    return headers
+
+def parse_row(row, headers):
+    #print([label for label in ept.values()])
+    #print([i for i in ept.keys()])
+    #print(row[i for i in ept.keys()])
+    return {f: r.value for f, r in \
+            zip([label for label in headers.values()], [row[i] for i in headers])}
+            #if r.ctype != XL_CELL_EMPTY}
+
+def parse_sheet(my_sheet, input_headers_dict, header_line, start_line, column):
+    headers = parse_headers(my_sheet, input_headers_dict, {}, header_line, (0,column))
+    for row in all_rows(my_sheet, start=start_line):
+        yield parse_row(row[0: column], headers)
+
+def sanity_check(nodes, links, nodes_by_city, links_by_city, eqpts_by_city):
+
+    duplicate_links = []
+    for l1 in links:
+        for l2 in links:
+            if l1 is not l2 and l1 == l2 and l2 not in duplicate_links:
+                print(f'\nWARNING\n \
+                    link {l1.from_city}-{l1.to_city} is duplicate \
+                    \nthe 1st duplicate link will be removed but you should check Links sheet input')
+                duplicate_links.append(l1)
+    #if duplicate_links != []:
+        #time.sleep(3)
+    for l in duplicate_links:
+        links.remove(l)
+
+    try :
+        test_nodes = [n for n in nodes_by_city if not n in links_by_city]
+        test_links = [n for n in links_by_city if not n in nodes_by_city]
+        test_eqpts = [n for n in eqpts_by_city if not n in nodes_by_city]
+        assert (test_nodes == [] or test_nodes == [''])\
+                and (test_links == [] or test_links ==[''])\
+                and (test_eqpts == [] or test_eqpts ==[''])
+    except AssertionError:
+        print(f'CRITICAL error: \nNames in Nodes and Links sheets do no match, check:\
+            \n{test_nodes} in Nodes sheet\
+            \n{test_links} in Links sheet\
+            \n{test_eqpts} in Eqpt sheet')
+        exit(1)
+
+    for city,link in links_by_city.items():
+        if nodes_by_city[city].node_type.lower()=='ila' and len(link) != 2:
+            #wrong input: ILA sites can only be Degree 2
+            # => correct to make it a ROADM and remove entry in links_by_city
+            #TODO : put in log rather than print
+            print(f'invalid node type ({nodes_by_city[city].node_type})\
+ specified in {city}, replaced by ROADM')
+            nodes_by_city[city].node_type = 'ROADM'
+            for n in nodes:
+                if n.city==city:
+                    n.node_type='ROADM'
+    return nodes, links
+
+def convert_file(input_filename, names_matching=False, filter_region=[]):
+    nodes, links, eqpts = parse_excel(input_filename)
+    if filter_region:
+        nodes = [n for n in nodes if n.region.lower() in filter_region]
+        cities = {n.city for n in nodes}
+        links = [lnk for lnk in links if lnk.from_city in cities and
+                                         lnk.to_city in cities]
+        cities = {lnk.from_city for lnk in links} | {lnk.to_city for lnk in links}
+        nodes = [n for n in nodes if n.city in cities]
+
+    global nodes_by_city
+    nodes_by_city = {n.city: n for n in nodes}
+    #create matching dictionary for node name mismatch analysis
+
+    cities = {''.join(c.strip() for c in n.city.split('C+L')).lower(): n.city for n in nodes}
+    cities_to_match = [k for k in cities]
+    city_match_dic = defaultdict(list)
+    for city in cities:
+        if city in cities_to_match:
+            cities_to_match.remove(city)
+        matches = get_close_matches(city, cities_to_match, 4, 0.85)
+        for m in matches:
+            city_match_dic[cities[city]].append(cities[m])
+    #check lower case/upper case
+    for city in nodes_by_city:
+        for match_city in nodes_by_city:
+            if match_city.lower() == city.lower() and match_city != city:
+                city_match_dic[city].append(match_city)
+
+    if names_matching:
+        print('\ncity match dictionary:',city_match_dic)
+    with  open('name_match_dictionary.json', 'w', encoding='utf-8') as city_match_dic_file:
+        city_match_dic_file.write(dumps(city_match_dic, indent=2, ensure_ascii=False))
+
+    global links_by_city
+    links_by_city = defaultdict(list)
+    for link in links:
+        links_by_city[link.from_city].append(link)
+        links_by_city[link.to_city].append(link)
+
+    global eqpts_by_city
+    eqpts_by_city = defaultdict(list)
+    for eqpt in eqpts:
+        eqpts_by_city[eqpt.from_city].append(eqpt)
+
+    nodes, links = sanity_check(nodes, links, nodes_by_city, links_by_city, eqpts_by_city)
+
+    data = {
+        'elements':
+            [{'uid': f'trx {x.city}',
+              'metadata': {'location': {'city':      x.city,
+                                        'region':    x.region,
+                                        'latitude':  x.latitude,
+                                        'longitude': x.longitude}},
+              'type': 'Transceiver'}
+             for x in nodes_by_city.values() if x.node_type.lower() == 'roadm'] +
+            [{'uid': f'roadm {x.city}',
+              'metadata': {'location': {'city':      x.city,
+                                        'region':    x.region,
+                                        'latitude':  x.latitude,
+                                        'longitude': x.longitude}},
+              'type': 'Roadm'}
+             for x in nodes_by_city.values() if x.node_type.lower() == 'roadm' \
+                 and x.booster_restriction == '' and x.preamp_restriction == ''] +
+            [{'uid': f'roadm {x.city}',
+              'params' : {
+                'restrictions': {
+                  'preamp_variety_list': silent_remove(x.preamp_restriction.split(' | '),''),
+                  'booster_variety_list': silent_remove(x.booster_restriction.split(' | '),'')
+                  }
+              },
+              'metadata': {'location': {'city':      x.city,
+                                        'region':    x.region,
+                                        'latitude':  x.latitude,
+                                        'longitude': x.longitude}},
+              'type': 'Roadm'}
+             for x in nodes_by_city.values() if x.node_type.lower() == 'roadm' and \
+                 (x.booster_restriction != '' or x.preamp_restriction != '')] +
+            [{'uid': f'west fused spans in {x.city}',
+              'metadata': {'location': {'city':      x.city,
+                                        'region':    x.region,
+                                        'latitude':  x.latitude,
+                                        'longitude': x.longitude}},
+              'type': 'Fused'}
+             for x in nodes_by_city.values() if x.node_type.lower() == 'fused'] +
+            [{'uid': f'east fused spans in {x.city}',
+              'metadata': {'location': {'city':      x.city,
+                                        'region':    x.region,
+                                        'latitude':  x.latitude,
+                                        'longitude': x.longitude}},
+              'type': 'Fused'}
+             for x in nodes_by_city.values() if x.node_type.lower() == 'fused'] +
+            [{'uid': f'fiber ({x.from_city} \u2192 {x.to_city})-{x.east_cable}',
+              'metadata': {'location': midpoint(nodes_by_city[x.from_city],
+                                                nodes_by_city[x.to_city])},
+              'type': 'Fiber',
+              'type_variety': x.east_fiber,
+              'params': {'length':   round(x.east_distance, 3),
+                         'length_units':    x.distance_units,
+                         'loss_coef': x.east_lineic,
+                         'con_in':x.east_con_in,
+                         'con_out':x.east_con_out}
+            }
+              for x in links] +
+            [{'uid': f'fiber ({x.to_city} \u2192 {x.from_city})-{x.west_cable}',
+              'metadata': {'location': midpoint(nodes_by_city[x.from_city],
+                                                nodes_by_city[x.to_city])},
+              'type': 'Fiber',
+              'type_variety': x.west_fiber,
+              '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] +
+            [{'uid': f'east edfa in {e.from_city} to {e.to_city}',
+              'metadata': {'location': {'city':      nodes_by_city[e.from_city].city,
+                                        'region':    nodes_by_city[e.from_city].region,
+                                        'latitude':  nodes_by_city[e.from_city].latitude,
+                                        'longitude': nodes_by_city[e.from_city].longitude}},
+              'type': 'Edfa',
+              'type_variety': e.east_amp_type,
+              'operational': {'gain_target': e.east_amp_gain,
+                              'delta_p':     e.east_amp_dp,
+                              'tilt_target': e.east_tilt,
+                              'out_voa'    : e.east_att_out}
+             }
+             for e in eqpts if (e.east_amp_type.lower() != '' and \
+                                e.east_amp_type.lower() != 'fused')] +
+            [{'uid': f'west edfa in {e.from_city} to {e.to_city}',
+              'metadata': {'location': {'city':      nodes_by_city[e.from_city].city,
+                                        'region':    nodes_by_city[e.from_city].region,
+                                        'latitude':  nodes_by_city[e.from_city].latitude,
+                                        'longitude': nodes_by_city[e.from_city].longitude}},
+              'type': 'Edfa',
+              'type_variety': e.west_amp_type,
+              'operational': {'gain_target': e.west_amp_gain,
+                              'delta_p':     e.west_amp_dp,
+                              'tilt_target': e.west_tilt,
+                              'out_voa'    : e.west_att_out}
+             }
+             for e in eqpts if (e.west_amp_type.lower() != '' and \
+                                e.west_amp_type.lower() != 'fused')] +
+            # fused edfa variety is a hack to indicate that there should not be
+            # booster amplifier out the roadm.
+            # If user specifies ILA in Nodes sheet and fused in Eqpt sheet, then assumes that
+            # this is a fused nodes.
+            [{'uid': f'east edfa in {e.from_city} to {e.to_city}',
+              'metadata': {'location': {'city':      nodes_by_city[e.from_city].city,
+                                        'region':    nodes_by_city[e.from_city].region,
+                                        'latitude':  nodes_by_city[e.from_city].latitude,
+                                        'longitude': nodes_by_city[e.from_city].longitude}},
+              'type': 'Fused',
+              'params': {'loss': 0}
+             }
+             for e in eqpts if e.east_amp_type.lower() == 'fused'] +
+            [{'uid': f'west edfa in {e.from_city} to {e.to_city}',
+              'metadata': {'location': {'city':      nodes_by_city[e.from_city].city,
+                                        'region':    nodes_by_city[e.from_city].region,
+                                        'latitude':  nodes_by_city[e.from_city].latitude,
+                                        'longitude': nodes_by_city[e.from_city].longitude}},
+              'type': 'Fused',
+              'params': {'loss': 0}
+             }
+             for e in eqpts if e.west_amp_type.lower() == 'fused'],
+        'connections':
+            list(chain.from_iterable([eqpt_connection_by_city(n.city)
+            for n in nodes]))
+            +
+            list(chain.from_iterable(zip(
+            [{'from_node': f'trx {x.city}',
+              'to_node':   f'roadm {x.city}'}
+             for x in nodes_by_city.values() if x.node_type.lower()=='roadm'],
+            [{'from_node': f'roadm {x.city}',
+              'to_node':   f'trx {x.city}'}
+             for x in nodes_by_city.values() if x.node_type.lower()=='roadm'])))
+    }
+
+    suffix_filename = str(input_filename.suffixes[0])
+    full_input_filename = str(input_filename)
+    split_filename = [full_input_filename[0:len(full_input_filename)-len(suffix_filename)] , suffix_filename[1:]]
+    output_json_file_name = split_filename[0]+'.json'
+    with  open(output_json_file_name, 'w', encoding='utf-8') as edfa_json_file:
+        edfa_json_file.write(dumps(data, indent=2, ensure_ascii=False))
+    return output_json_file_name
+
+def parse_excel(input_filename):
+    link_headers = \
+    {  'Node A': 'from_city',
+       'Node Z': 'to_city',
+       'east':{
+            'Distance (km)':        'east_distance',
+            'Fiber type':           'east_fiber',
+            'lineic att':           'east_lineic',
+            'Con_in':               'east_con_in',
+            'Con_out':              'east_con_out',
+            'PMD':                  'east_pmd',
+            'Cable id':             'east_cable'
+        },
+        'west':{
+            'Distance (km)':        'west_distance',
+            'Fiber type':           'west_fiber',
+            'lineic att':           'west_lineic',
+            'Con_in':               'west_con_in',
+            'Con_out':              'west_con_out',
+            'PMD':                  'west_pmd',
+            'Cable id':             'west_cable'
+        }
+    }
+    node_headers = \
+    {   'City':         'city',
+        'State':        'state',
+        'Country':      'country',
+        'Region':       'region',
+        'Latitude':     'latitude',
+        'Longitude':    'longitude',
+        'Type':         'node_type',
+        'Booster_restriction': 'booster_restriction',
+        'Preamp_restriction': 'preamp_restriction'
+    }
+    eqpt_headers = \
+    {  'Node A': 'from_city',
+       'Node Z': 'to_city',
+       'east':{
+            'amp type':         'east_amp_type',
+            'att_in':           'east_att_in',
+            'amp gain':         'east_amp_gain',
+            'delta p':          'east_amp_dp',
+            'tilt':             'east_tilt',
+            'att_out':          'east_att_out'
+       },
+       'west':{
+            'amp type':         'west_amp_type',
+            'att_in':           'west_att_in',
+            'amp gain':         'west_amp_gain',
+            'delta p':          'west_amp_dp',
+            'tilt':             'west_tilt',
+            'att_out':          'west_att_out'
+       }
+    }
+
+    with open_workbook(input_filename) as wb:
+        nodes_sheet = wb.sheet_by_name('Nodes')
+        links_sheet = wb.sheet_by_name('Links')
+        try:
+            eqpt_sheet = wb.sheet_by_name('Eqpt')
+        except Exception:
+            #eqpt_sheet is optional
+            eqpt_sheet = None
+
+        nodes = []
+        for node in parse_sheet(nodes_sheet, node_headers, NODES_LINE, NODES_LINE+1, NODES_COLUMN):
+            nodes.append(Node(**node))
+        expected_node_types = {'ROADM', 'ILA', 'FUSED'}
+        for n in nodes:
+            if n.node_type not in expected_node_types:
+                n.node_type = 'ILA'
+
+        links = []
+        for link in parse_sheet(links_sheet, link_headers, LINKS_LINE, LINKS_LINE+2, LINKS_COLUMN):
+            links.append(Link(**link))
+        #print('\n', [l.__dict__ for l in links])
+
+        eqpts = []
+        if eqpt_sheet != None:
+            for eqpt in parse_sheet(eqpt_sheet, eqpt_headers, EQPTS_LINE, EQPTS_LINE+2, EQPTS_COLUMN):
+                eqpts.append(Eqpt(**eqpt))
+
+    # sanity check
+    all_cities = Counter(n.city for n in nodes)
+    if len(all_cities) != len(nodes):
+        raise ValueError(f'Duplicate city: {all_cities}')
+    if any(ln.from_city not in all_cities or
+           ln.to_city   not in all_cities for ln in links):
+        raise ValueError(f'Bad link.')
+
+    return nodes, links, eqpts
+
+
+def eqpt_connection_by_city(city_name):
+    other_cities = fiber_dest_from_source(city_name)
+    subdata = []
+    if nodes_by_city[city_name].node_type.lower() in {'ila', 'fused'}:
+        # Then len(other_cities) == 2
+        direction = ['west', 'east']
+        for i in range(2):
+            from_ = fiber_link(other_cities[i], city_name)
+            in_ = eqpt_in_city_to_city(city_name, other_cities[0],direction[i])
+            to_ = fiber_link(city_name, other_cities[1-i])
+            subdata += connect_eqpt(from_, in_, to_)
+    elif nodes_by_city[city_name].node_type.lower() == 'roadm':
+        for other_city in other_cities:
+            from_ = f'roadm {city_name}'
+            in_ = eqpt_in_city_to_city(city_name, other_city)
+            to_ = fiber_link(city_name, other_city)
+            subdata += connect_eqpt(from_, in_, to_)
+
+            from_ = fiber_link(other_city, city_name)
+            in_ = eqpt_in_city_to_city(city_name, other_city, "west")
+            to_ = f'roadm {city_name}'
+            subdata += connect_eqpt(from_, in_, to_)
+    return subdata
+
+
+def connect_eqpt(from_, in_, to_):
+    connections = []
+    if in_ !='':
+        connections = [{'from_node': from_, 'to_node': in_},
+                      {'from_node': in_, 'to_node': to_}]
+    else:
+        connections = [{'from_node': from_, 'to_node': to_}]
+    return connections
+
+
+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]:
+            if nodes_by_city[in_city].node_type.lower() == 'roadm':
+                if e.to_city == to_city and getattr(e, amp_direction) != '':
+                    return_eqpt = f'{direction} edfa in {e.from_city} to {e.to_city}'
+            elif nodes_by_city[in_city].node_type.lower() == 'ila':
+                if e.to_city != to_city:
+                    direction = rev_direction
+                    amp_direction = amp_rev_direction
+                if getattr(e, amp_direction) != '':
+                    return_eqpt = f'{direction} edfa in {e.from_city} to {e.to_city}'
+    if nodes_by_city[in_city].node_type.lower() == 'fused':
+        return_eqpt = f'{direction} fused spans in {in_city}'
+    return return_eqpt
+
+
+def fiber_dest_from_source(city_name):
+    destinations = []
+    links_from_city = links_by_city[city_name]
+    for l in links_from_city:
+        if l.from_city == city_name:
+            destinations.append(l.to_city)
+        else:
+            destinations.append(l.from_city)
+    return destinations
+
+
+def fiber_link(from_city, to_city):
+    source_dest = (from_city, to_city)
+    link = links_by_city[from_city]
+    l = next(l for l in link if l.from_city in source_dest and l.to_city in source_dest)
+    if l.from_city == from_city:
+        fiber = f'fiber ({l.from_city} \u2192 {l.to_city})-{l.east_cable}'
+    else:
+        fiber = f'fiber ({l.to_city} \u2192 {l.from_city})-{l.west_cable}'
+    return fiber
+
+
+def midpoint(city_a, city_b):
+    lats  = city_a.latitude, city_b.latitude
+    longs = city_a.longitude, city_b.longitude
+    try:
+        result = {
+        'latitude':  sum(lats)  / 2,
+        'longitude': sum(longs) / 2
+                }
+    except :
+        result = {
+        'latitude':  0,
+        'longitude': 0
+                }
+    return result
+
+#output_json_file_name = 'coronet_conus_example.json'
+#TODO get column size automatically from tupple size
+
+NODES_COLUMN = 10
+NODES_LINE = 4
+LINKS_COLUMN = 16
+LINKS_LINE = 3
+EQPTS_LINE = 3
+EQPTS_COLUMN = 14
+parser = ArgumentParser()
+parser.add_argument('workbook', nargs='?', type=Path , default='meshTopologyExampleV2.xls')
+parser.add_argument('-f', '--filter-region', action='append', default=[])
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    convert_file(args.workbook, args.filter_region)

gnpy/core/equipment.py

@@ -1,137 +1,401 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# SPDX-License-Identifier: BSD-3-Clause
-# gnpy.core.equipment: functionality for specifying equipment
-# Copyright (C) 2025 Telecom Infra Project and GNPy contributors
-# see AUTHORS.rst for a list of contributors
-
-"""
+'''
 gnpy.core.equipment
 ===================
 
 This module contains functionality for specifying equipment.
-"""
-from collections import defaultdict
-from functools import reduce
-from typing import List
+'''
 
-from gnpy.core.exceptions import EquipmentConfigError, ConfigurationError
+from numpy import clip, polyval
+from operator import itemgetter
+from math import isclose
+from pathlib import Path
+from json import load
+from gnpy.core.utils import lin2db, db2lin, load_json
+from collections import namedtuple
+from gnpy.core.elements import Edfa
+from gnpy.core.exceptions import EquipmentConfigError
+import time
 
+Model_vg = namedtuple('Model_vg', 'nf1 nf2 delta_p')
+Model_fg = namedtuple('Model_fg', 'nf0')
+Model_openroadm = namedtuple('Model_openroadm', 'nf_coef')
+Model_hybrid = namedtuple('Model_hybrid', 'nf_ram gain_ram edfa_variety')
+Model_dual_stage = namedtuple('Model_dual_stage', 'preamp_variety booster_variety')
+
+class common:
+    def update_attr(self, default_values, kwargs, name):
+        clean_kwargs = {k:v for k, v in kwargs.items() if v != ''}
+        for k, v in default_values.items():
+            setattr(self, k, clean_kwargs.get(k, v))
+            if k not in clean_kwargs and name != 'Amp':
+                print(f'\x1b[1;31;40m'+
+                      f'\n WARNING missing {k} attribute in eqpt_config.json[{name}]'+
+                      f'\n default value is {k} = {v}'+
+                      f'\x1b[0m')
+                time.sleep(1)
+
+class SI(common):
+    default_values =\
+    {
+        "f_min":            191.35e12,
+        "f_max":            196.1e12,
+        "baud_rate":        32e9,
+        "spacing":          50e9,
+        "power_dbm":        0,
+        "power_range_db":   [0, 0, 0.5],
+        "roll_off":         0.15,
+        "tx_osnr":          45,
+        "sys_margins":      0
+    }
+
+    def __init__(self, **kwargs):
+        self.update_attr(self.default_values, kwargs, 'SI')
+
+class Span(common):
+    default_values = \
+    {
+        'power_mode':                       True,
+        'delta_power_range_db':             None,
+        'max_fiber_lineic_loss_for_raman':  0.25,
+        'target_extended_gain':             2.5,
+        'max_length':                       150,
+        'length_units':                     'km',
+        'max_loss':                         None,
+        'padding':                          10,
+        'EOL':                              0,
+        'con_in':                           0,
+        'con_out':                          0
+    }
+
+    def __init__(self, **kwargs):
+        self.update_attr(self.default_values, kwargs, 'Span')
+
+class Roadm(common):
+    default_values = \
+    {
+        'target_pch_out_db':   -17,
+        'add_drop_osnr':       100,
+        'restrictions': {
+            'preamp_variety_list':[],
+            'booster_variety_list':[]
+            }
+    }
+
+    def __init__(self, **kwargs):
+        self.update_attr(self.default_values, kwargs, 'Roadm')
+
+class Transceiver(common):
+    default_values = \
+    {
+        'type_variety': None,
+        'frequency':    None,
+        'mode':         {}
+    }
+
+    def __init__(self, **kwargs):
+        self.update_attr(self.default_values, kwargs, 'Transceiver')
+
+class Fiber(common):
+    default_values = \
+    {
+        'type_variety':  '',
+        'dispersion':    None,
+        'gamma':         0
+    }
+
+    def __init__(self, **kwargs):
+        self.update_attr(self.default_values, kwargs, 'Fiber')
+
+class RamanFiber(common):
+    default_values = \
+    {
+        'type_variety':  '',
+        'dispersion':    None,
+        'gamma':         0,
+        'raman_efficiency': None
+    }
+
+    def __init__(self, **kwargs):
+        self.update_attr(self.default_values, kwargs, 'RamanFiber')
+        for param in ('cr', 'frequency_offset'):
+            if param not in self.raman_efficiency:
+                raise EquipmentConfigError(f'RamanFiber.raman_efficiency: missing "{param}" parameter')
+        if self.raman_efficiency['frequency_offset'] != sorted(self.raman_efficiency['frequency_offset']):
+            raise EquipmentConfigError(f'RamanFiber.raman_efficiency.frequency_offset is not sorted')
+
+class Amp(common):
+    default_values = \
+    {
+        'f_min':                191.35e12,
+        'f_max':                196.1e12,
+        'type_variety':         '',
+        'type_def':             '',
+        'gain_flatmax':         None,
+        'gain_min':             None,
+        'p_max':                None,
+        'nf_model':             None,
+        'dual_stage_model':     None,
+        'nf_fit_coeff':         None,
+        'nf_ripple':            None,
+        'dgt':                  None,
+        'gain_ripple':          None,
+        'out_voa_auto':         False,
+        'allowed_for_design':   False,
+        'raman':                False
+    }
+
+    def __init__(self, **kwargs):
+        self.update_attr(self.default_values, kwargs, 'Amp')
+
+    @classmethod
+    def from_json(cls, filename, **kwargs):
+        config = Path(filename).parent / 'default_edfa_config.json'
+
+        type_variety = kwargs['type_variety']
+        type_def = kwargs.get('type_def', 'variable_gain') # default compatibility with older json eqpt files
+        nf_def = None
+        dual_stage_def = None
+
+        if type_def == 'fixed_gain':
+            try:
+                nf0 = kwargs.pop('nf0')
+            except KeyError: #nf0 is expected for a fixed gain amp
+                raise EquipmentConfigError(f'missing nf0 value input for amplifier: {type_variety} in equipment config')
+            for k in ('nf_min', 'nf_max'):
+                try:
+                    del kwargs[k]
+                except KeyError:
+                    pass
+            nf_def = Model_fg(nf0)
+        elif type_def == 'advanced_model':
+            config = Path(filename).parent / kwargs.pop('advanced_config_from_json')
+        elif type_def == 'variable_gain':
+            gain_min, gain_max = kwargs['gain_min'], kwargs['gain_flatmax']
+            try: #nf_min and nf_max are expected for a variable gain amp
+                nf_min = kwargs.pop('nf_min')
+                nf_max = kwargs.pop('nf_max')
+            except KeyError:
+                raise EquipmentConfigError(f'missing nf_min or nf_max value input for amplifier: {type_variety} in equipment config')
+            try: #remove all remaining nf inputs
+                del kwargs['nf0']
+            except KeyError: pass #nf0 is not needed for variable gain amp
+            nf1, nf2, delta_p = nf_model(type_variety, gain_min, gain_max, nf_min, nf_max)
+            nf_def = Model_vg(nf1, nf2, delta_p)
+        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)
+        elif type_def == 'dual_stage':
+            try: #nf_ram and gain_ram are expected for a hybrid amp
+                preamp_variety = kwargs.pop('preamp_variety')
+                booster_variety = kwargs.pop('booster_variety')
+            except KeyError:
+                raise EquipmentConfigError(f'missing preamp/booster variety input for amplifier: {type_variety} in equipment config')
+            dual_stage_def = Model_dual_stage(preamp_variety, booster_variety)
+
+        with open(config, encoding='utf-8') as f:
+            json_data = load(f)
+
+        return cls(**{**kwargs, **json_data,
+            'nf_model': nf_def, 'dual_stage_model': dual_stage_def})
+
+
+def nf_model(type_variety, gain_min, gain_max, nf_min, nf_max):
+    if nf_min < -10:
+        raise EquipmentConfigError(f'Invalid nf_min value {nf_min!r} for amplifier {type_variety}')
+    if nf_max < -10:
+        raise EquipmentConfigError(f'Invalid nf_max value {nf_max!r} for amplifier {type_variety}')
+
+    # NF estimation model based on nf_min and nf_max
+    # delta_p:  max power dB difference between first and second stage coils
+    # dB g1a:   first stage gain - internal VOA attenuation
+    # nf1, nf2: first and second stage coils
+    #           calculated by solving nf_{min,max} = nf1 + nf2 / g1a{min,max}
+    delta_p = 5
+    g1a_min = gain_min - (gain_max - gain_min) - delta_p
+    g1a_max = gain_max - delta_p
+    nf2 = lin2db((db2lin(nf_min) - db2lin(nf_max)) /
+                 (1/db2lin(g1a_max) - 1/db2lin(g1a_min)))
+    nf1 = lin2db(db2lin(nf_min) - db2lin(nf2)/db2lin(g1a_max))
+
+    if nf1 < 4:
+        raise EquipmentConfigError(f'First coil value too low {nf1} for amplifier {type_variety}')
+
+    # Check 1 dB < delta_p < 6 dB to ensure nf_min and nf_max values make sense.
+    # There shouldn't be high nf differences between the two coils:
+    #    nf2 should be nf1 + 0.3 < nf2 < nf1 + 2
+    # If not, recompute and check delta_p
+    if not nf1 + 0.3 < nf2 < nf1 + 2:
+        nf2 = clip(nf2, nf1 + 0.3, nf1 + 2)
+        g1a_max = lin2db(db2lin(nf2) / (db2lin(nf_min) - db2lin(nf1)))
+        delta_p = gain_max - g1a_max
+        g1a_min = gain_min - (gain_max-gain_min) - delta_p
+        if not 1 < delta_p < 11:
+            raise EquipmentConfigError(f'Computed \N{greek capital letter delta}P invalid \
+                \n 1st coil vs 2nd coil calculated DeltaP {delta_p:.2f} for \
+                \n amplifier {type_variety} is not valid: revise inputs \
+                \n calculated 1st coil NF = {nf1:.2f}, 2nd coil NF = {nf2:.2f}')
+    # Check calculated values for nf1 and nf2
+    calc_nf_min = lin2db(db2lin(nf1) + db2lin(nf2)/db2lin(g1a_max))
+    if not isclose(nf_min, calc_nf_min, abs_tol=0.01):
+        raise EquipmentConfigError(f'nf_min does not match calc_nf_min, {nf_min} vs {calc_nf_min} for amp {type_variety}')
+    calc_nf_max = lin2db(db2lin(nf1) + db2lin(nf2)/db2lin(g1a_min))
+    if not isclose(nf_max, calc_nf_max, abs_tol=0.01):
+        raise EquipmentConfigError(f'nf_max does not match calc_nf_max, {nf_max} vs {calc_nf_max} for amp {type_variety}')
+
+    return nf1, nf2, delta_p
+
+def edfa_nf(gain_target, variety_type, equipment):
+    amp_params = equipment['Edfa'][variety_type]
+    amp = Edfa(
+            uid = f'calc_NF',
+            params = amp_params.__dict__,
+            operational = {
+                'gain_target': gain_target,
+                'tilt_target': 0
+                        }
+            )
+    amp.pin_db = 0
+    amp.nch = 88
+    return amp._calc_nf(True)
 
 def trx_mode_params(equipment, trx_type_variety='', trx_mode='', error_message=False):
-    """return the trx and SI parameters from eqpt_config for a given type_variety and mode (ie format)
-
-    if the type or mode do no match an existing transceiver in the library, then the function
-    raises an error if error_message is True else returns a default mode based on equipment['SI']['default']
-    If trx_mode is None (but type is valid), it returns an undetermined mode whatever the error message:
-    this is a special case for automatic mode selection.
-    """
+    """return the trx and SI parameters from eqpt_config for a given type_variety and mode (ie format)"""
     trx_params = {}
     default_si_data = equipment['SI']['default']
-    # default transponder characteristics
-    # mainly used with transmission_main_example.py
-    default_trx_params = {
-        'f_min': default_si_data.f_min,
-        'f_max': default_si_data.f_max,
-        'baud_rate': default_si_data.baud_rate,
-        'spacing': default_si_data.spacing,
-        'OSNR': None,
-        'penalties': {},
-        'bit_rate': None,
-        'cost': None,
-        'roll_off': default_si_data.roll_off,
-        'tx_osnr': default_si_data.tx_osnr,
-        'min_spacing': None,
-        'equalization_offset_db': 0
-    }
-    # Undetermined transponder characteristics
-    # mainly used with path_request_run.py for the automatic mode computation case
-    undetermined_trx_params = {
-        "format": "undetermined",
-        "baud_rate": None,
-        "OSNR": None,
-        "penalties": None,
-        "bit_rate": None,
-        "roll_off": None,
-        "tx_osnr": None,
-        "min_spacing": None,
-        "cost": None,
-        "equalization_offset_db": 0
-    }
 
-    trxs = equipment['Transceiver']
-    if trx_type_variety in trxs:
-        modes = {mode['format']: mode for mode in trxs[trx_type_variety].mode}
-        trx_frequencies = {'f_min': trxs[trx_type_variety].frequency['min'],
-                           'f_max': trxs[trx_type_variety].frequency['max']}
-        if trx_mode in modes:
-            # if called from transmission_main.py, trx_mode is ''
-            trx_params = {**modes[trx_mode], **trx_frequencies}
-            if trx_params['baud_rate'] > trx_params['min_spacing']:
-                # sanity check: baudrate must be smaller than min spacing
-                raise EquipmentConfigError(f'Inconsistency in equipment library:\n Transponder "{trx_type_variety}" '
-                                           + f'mode "{trx_params["format"]}" has baud rate '
-                                           + f'{trx_params["baud_rate"] * 1e-9:.2f} GHz greater than min_spacing '
-                                           + f'{trx_params["min_spacing"] * 1e-9:.2f}.')
-            trx_params['equalization_offset_db'] = trx_params.get('equalization_offset_db', 0)
-            return trx_params
-        if trx_mode is None:
-            # if called from path_requests_run.py, trx_mode is filled with None when not specified by user
-            trx_params = {**undetermined_trx_params, **trx_frequencies}
-            return trx_params
-    if trx_type_variety in trxs and error_message:
-        raise EquipmentConfigError(f'Could not find transponder "{trx_type_variety}" with mode "{trx_mode}" '
-                                   + 'in equipment library')
-    if error_message:
-        raise EquipmentConfigError(f'Could not find transponder "{trx_type_variety}" in equipment library')
+    try:
+        trxs = equipment['Transceiver']
+        #if called from path_requests_run.py, trx_mode is filled with None when not specified by user
+        #if called from transmission_main.py, trx_mode is ''
+        if trx_mode is not None:
+            mode_params = next(mode for trx in trxs \
+                        if trx == trx_type_variety \
+                        for mode in trxs[trx].mode \
+                        if mode['format'] == trx_mode)
+            trx_params = {**mode_params}
+            # sanity check: spacing baudrate must be smaller than min spacing
+            if trx_params['baud_rate'] > trx_params['min_spacing'] :
+                raise EquipmentConfigError(f'Inconsistency in equipment library:\n Transpoder "{trx_type_variety}" mode "{trx_params["format"]}" '+\
+                    f'has baud rate: {trx_params["baud_rate"]*1e-9} GHz greater than min_spacing {trx_params["min_spacing"]*1e-9}.')
+        else:
+            mode_params = {"format": "undetermined",
+                           "baud_rate": None,
+                           "OSNR": None,
+                           "bit_rate": None,
+                           "roll_off": None,
+                           "tx_osnr":None,
+                           "min_spacing":None,
+                           "cost":None}
+            trx_params = {**mode_params}
+        trx_params['f_min'] = equipment['Transceiver'][trx_type_variety].frequency['min']
+        trx_params['f_max'] = equipment['Transceiver'][trx_type_variety].frequency['max']
+
+        # TODO: novel automatic feature maybe unwanted if spacing is specified
+        # trx_params['spacing'] = automatic_spacing(trx_params['baud_rate'])
+        # temp = trx_params['spacing']
+        # print(f'spacing {temp}')
+    except StopIteration :
+        if error_message:
+            raise EquipmentConfigError(f'Computation stoped: could not find tsp : {trx_type_variety} with mode: {trx_mode} in eqpt library')
+        else:
+            # default transponder charcteristics
+            # mainly used with transmission_main_example.py
+            trx_params['f_min'] = default_si_data.f_min
+            trx_params['f_max'] = default_si_data.f_max
+            trx_params['baud_rate'] = default_si_data.baud_rate
+            trx_params['spacing'] = default_si_data.spacing
+            trx_params['OSNR'] = None
+            trx_params['bit_rate'] = None
+            trx_params['cost'] = None
+            trx_params['roll_off'] = default_si_data.roll_off
+            trx_params['tx_osnr'] = default_si_data.tx_osnr
+            trx_params['min_spacing'] = None
+            nch = automatic_nch(trx_params['f_min'], trx_params['f_max'], trx_params['spacing'])
+            trx_params['nb_channel'] = nch
+            print(f'There are {nch} channels propagating')
+
+    trx_params['power'] =  db2lin(default_si_data.power_dbm)*1e-3
 
-    trx_params = {**default_trx_params}
     return trx_params
 
+def automatic_spacing(baud_rate):
+    """return the min possible channel spacing for a given baud rate"""
+    # TODO : this should parametrized in a cfg file
+    # list of possible tuples [(max_baud_rate, spacing_for_this_baud_rate)]
+    spacing_list = [(33e9, 37.5e9), (38e9, 50e9), (50e9, 62.5e9), (67e9, 75e9), (92e9, 100e9)]
+    return min((s[1] for s in spacing_list if s[0] > baud_rate), default=baud_rate*1.2)
 
-def find_type_variety(amps: List[str], equipment: dict) -> List[str]:
-    """Returns the multiband type_variety associated with a list of single band type_varieties
-    Args:
-    amps (List[str]): A list of single band type_varieties.
-    equipment (dict): A dictionary containing equipment information.
+def automatic_nch(f_min, f_max, spacing):
+    return int((f_max - f_min)//spacing)
 
-    Returns:
-    str: an amplifier type variety
+def automatic_fmax(f_min, spacing, nch):
+    return f_min + spacing * nch
+
+def load_equipment(filename):
+    json_data = load_json(filename)
+    return equipment_from_json(json_data, filename)
+
+def update_trx_osnr(equipment):
+    """add sys_margins to all Transceivers OSNR values"""
+    for trx in equipment['Transceiver'].values():
+        for m in trx.mode:
+            m['OSNR'] = m['OSNR'] + equipment['SI']['default'].sys_margins
+    return equipment
+
+def update_dual_stage(equipment):
+    edfa_dict = equipment['Edfa']
+    for edfa in edfa_dict.values():
+        if edfa.type_def == 'dual_stage':
+            edfa_preamp = edfa_dict[edfa.dual_stage_model.preamp_variety]
+            edfa_booster = edfa_dict[edfa.dual_stage_model.booster_variety]
+            for key, value in edfa_preamp.__dict__.items():
+                attr_k = 'preamp_' + key
+                setattr(edfa, attr_k, value)
+            for key, value in edfa_booster.__dict__.items():
+                attr_k = 'booster_' + key
+                setattr(edfa, attr_k, value)
+            edfa.p_max = edfa_booster.p_max
+            edfa.gain_flatmax = edfa_booster.gain_flatmax + edfa_preamp.gain_flatmax
+            if edfa.gain_min < edfa_preamp.gain_min:
+                raise EquipmentConfigError(f'Dual stage {edfa.type_variety} min gain is lower than its preamp min gain')
+    return equipment
+
+def roadm_restrictions_sanity_check(equipment):
+    """ verifies that booster and preamp restrictions specified in roadm equipment are listed
+    in the edfa.
     """
-    listes = find_type_varieties(amps, equipment)
+    restrictions = equipment['Roadm']['default'].restrictions['booster_variety_list'] + \
+        equipment['Roadm']['default'].restrictions['preamp_variety_list']
+    for amp_name in restrictions:
+        if amp_name not in equipment['Edfa']:
+            raise EquipmentConfigError(f'ROADM restriction {amp_name} does not refer to a defined EDFA name')
 
-    _found_type = list(reduce(lambda x, y: set(x) & set(y), listes))
-    # Given a list of single band amplifiers, find the multiband amplifier whose multi_band group
-    # matches. For example, if amps list contains ["a1_LBAND", "a2_CBAND"], with a1.multi_band = [a1_LBAND, a1_CBAND]
-    # and a2.multi_band = [a1_LBAND, a2_CBAND], then:
-    # possible_type_varieties = {"a1_LBAND": ["a1", "a2"], "a2_CBAND": ["a2"]}
-    # listes = [["a1", "a2"],  ["a2"]]
-    # and _found_type = [a2]
-    if not _found_type:
-        msg = f'{amps} amps do not belong to the same amp type {listes}'
-        raise ConfigurationError(msg)
-    return _found_type
-
-
-def find_type_varieties(amps: List[str], equipment: dict) -> List[List[str]]:
-    """Returns the multiband list of type_varieties associated with a list of single band type_varieties
-    Args:
-    amps (List[str]): A list of single band type_varieties.
-    equipment (dict): A dictionary containing equipment information.
-
-    Returns:
-    List[List[str]]: A list of lists containing the multiband type_varieties
-    associated with each single band type_variety.
+def equipment_from_json(json_data, filename):
+    """build global dictionnary eqpt_library that stores all eqpt characteristics:
+    edfa type type_variety, fiber type_variety
+    from the eqpt_config.json (filename parameter)
+    also read advanced_config_from_json file parameters for edfa if they are available:
+    typically nf_ripple, dfg gain ripple, dgt and nf polynomial nf_fit_coeff
+    if advanced_config_from_json file parameter is not present: use nf_model:
+    requires nf_min and nf_max values boundaries of the edfa gain range
     """
-    possible_type_varieties = defaultdict(list)
-    for amp_name, amp in equipment['Edfa'].items():
-        if amp.multi_band is not None:
-            for elem in amp.multi_band:
-                # possible_type_varieties stores the list of multiband amp names that list this elem as
-                # a possible amplifier of the multiband group. For example, if "std_medium_gain_multiband"
-                # and "std_medium_gain_multiband_new" contain "std_medium_gain_C" in their "multi_band" list, then:
-                # possible_type_varieties["std_medium_gain_C"] =
-                # ["std_medium_gain_multiband", "std_medium_gain_multiband_new"]
-                possible_type_varieties[elem].append(amp_name)
-    return [possible_type_varieties[a] for a in amps]
+    equipment = {}
+    for key, entries in json_data.items():
+        equipment[key] = {}
+        typ = globals()[key]
+        for entry in entries:
+            subkey = entry.get('type_variety', 'default')
+            if key == 'Edfa':
+                equipment[key][subkey] = Amp.from_json(filename, **entry)
+            else:
+                equipment[key][subkey] = typ(**entry)
+    equipment = update_trx_osnr(equipment)
+    equipment = update_dual_stage(equipment)
+    roadm_restrictions_sanity_check(equipment)
+    return equipment

gnpy/core/exceptions.py

@@ -1,42 +1,29 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# SPDX-License-Identifier: BSD-3-Clause
-# gnpy.core.exceptions: Exceptions thrown by other gnpy modules
-# Copyright (C) 2025 Telecom Infra Project and GNPy contributors
-# see AUTHORS.rst for a list of contributors
-
-"""
+'''
 gnpy.core.exceptions
 ====================
 
 Exceptions thrown by other gnpy modules
-"""
+'''
 
 
 class ConfigurationError(Exception):
-    """User-provided configuration contains an error"""
-
+    '''User-provided configuration contains an error'''
 
 class EquipmentConfigError(ConfigurationError):
-    """Incomplete or wrong configuration within the equipment library"""
-
+    '''Incomplete or wrong configuration within the equipment library'''
 
 class NetworkTopologyError(ConfigurationError):
-    """Topology of user-provided network is wrong"""
-
+    '''Topology of user-provided network is wrong'''
 
 class ServiceError(Exception):
-    """Service of user-provided request is wrong"""
-
+    '''Service of user-provided request is wrong'''
 
 class DisjunctionError(ServiceError):
-    """Disjunction of user-provided request can not be satisfied"""
-
+    '''Disjunction of user-provided request can not be satisfied'''
 
 class SpectrumError(Exception):
-    """Spectrum errors of the program"""
+    '''Spectrum errors of the program'''
 
-
-class ParametersError(ConfigurationError):
-    """Incomplete or wrong configurations within parameters json"""

gnpy/core/execute.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+'''
+gnpy.core.execute
+=================
+
+This module contains functions for executing the propogation of
+spectral information on a `gnpy` network.
+'''

gnpy/core/info.py

@@ -1,433 +1,72 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# SPDX-License-Identifier: BSD-3-Clause
-# gnpy.core.info: classes for modelling Spectral Information
-# Copyright (C) 2025 Telecom Infra Project and GNPy contributors
-# see AUTHORS.rst for a list of contributors
-
-"""
+'''
 gnpy.core.info
 ==============
 
 This module contains classes for modelling :class:`SpectralInformation`.
-"""
+'''
+
 
-from __future__ import annotations
 from collections import namedtuple
-from collections.abc import Iterable
-from typing import Union, List, Optional
-from dataclasses import dataclass
-from numpy import argsort, mean, array, append, ones, ceil, any, zeros, outer, full, ndarray, asarray
-
-from gnpy.core.utils import automatic_nch, db2lin, watt2dbm
-from gnpy.core.exceptions import SpectrumError
-
-DEFAULT_SLOT_WIDTH_STEP = 12.5e9  # Hz
-"""Channels with unspecified slot width will have their slot width evaluated as the baud rate rounded up to the minimum
-multiple of the DEFAULT_SLOT_WIDTH_STEP (the baud rate is extended including the roll off in this evaluation)"""
-
+from numpy import array
+from gnpy.core.utils import lin2db, db2lin
+from json import loads
+from gnpy.core.utils import load_json
+from gnpy.core.equipment import automatic_nch, automatic_spacing
 
 class Power(namedtuple('Power', 'signal nli ase')):
     """carriers power in W"""
 
 
-class Channel(
-    namedtuple('Channel',
-               'channel_number frequency baud_rate slot_width roll_off power chromatic_dispersion pmd pdl latency')):
-    """Class containing the parameters of a WDM signal.
-
-    :param channel_number: channel number in the WDM grid
-    :param frequency: central frequency of the signal (Hz)
-    :param baud_rate: the symbol rate of the signal (Baud)
-    :param slot_width: the slot width (Hz)
-    :param roll_off: the roll off of the signal. It is a pure number between 0 and 1
-    :param power (gnpy.core.info.Power): power of signal, ASE noise and NLI (W)
-    :param chromatic_dispersion: chromatic dispersion (s/m)
-    :param pmd: polarization mode dispersion (s)
-    :param pdl: polarization dependent loss (dB)
-    :param latency: propagation latency (s)
-    """
+class Channel(namedtuple('Channel', 'channel_number frequency baud_rate roll_off power')):
+    pass
 
 
-class SpectralInformation(object):
-    """Class containing the parameters of the entire WDM comb.
-
-    delta_pdb_per_channel: (per frequency) per channel delta power in dbm for the actual mix of channels"""
-
-    def __init__(self, frequency: array, baud_rate: array, slot_width: array, signal: array, nli: array, ase: array,
-                 roll_off: array, chromatic_dispersion: array, pmd: array, pdl: array, latency: array,
-                 delta_pdb_per_channel: array, tx_osnr: array, tx_power: array, label: array):
-        indices = argsort(frequency)
-        self._frequency = frequency[indices]
-        self._df = outer(ones(frequency.shape), frequency) - outer(frequency, ones(frequency.shape))
-        self._number_of_channels = len(self._frequency)
-        self._channel_number = [*range(1, self._number_of_channels + 1)]
-        self._slot_width = slot_width[indices]
-        self._baud_rate = baud_rate[indices]
-        overlap = self._frequency[:-1] + self._slot_width[:-1] / 2 > self._frequency[1:] - self._slot_width[1:] / 2
-        if any(overlap):
-            overlap = [pair for pair in zip(overlap * self._channel_number[:-1], overlap * self._channel_number[1:])
-                       if pair != (0, 0)]
-            raise SpectrumError(f'Spectrum required slot widths larger than the frequency spectral distances '
-                                f'between channels: {overlap}.')
-        exceed = self._baud_rate > self._slot_width
-        if any(exceed):
-            raise SpectrumError(f'Spectrum baud rate, including the roll off, larger than the slot width for channels: '
-                                f'{[ch for ch in exceed * self._channel_number if ch]}.')
-        self._signal = signal[indices]
-        self._nli = nli[indices]
-        self._ase = ase[indices]
-        self._roll_off = roll_off[indices]
-        self._chromatic_dispersion = chromatic_dispersion[indices]
-        self._pmd = pmd[indices]
-        self._pdl = pdl[indices]
-        self._latency = latency[indices]
-        self._delta_pdb_per_channel = delta_pdb_per_channel[indices]
-        self._tx_osnr = tx_osnr[indices]
-        self._tx_power = tx_power[indices]
-        self._label = label[indices]
-
-    @property
-    def frequency(self):
-        return self._frequency
-
-    @property
-    def df(self):
-        """Matrix of relative frequency distances between all channels. Positive elements in the upper right side."""
-        return self._df
-
-    @property
-    def slot_width(self):
-        return self._slot_width
-
-    @property
-    def baud_rate(self):
-        return self._baud_rate
-
-    @property
-    def number_of_channels(self):
-        return self._number_of_channels
-
-    @property
-    def powers(self):
-        powers = zip(self.signal, self.nli, self.ase)
-        return [Power(*p) for p in powers]
-
-    @property
-    def signal(self):
-        return self._signal
-
-    @signal.setter
-    def signal(self, signal):
-        self._signal = signal
-
-    @property
-    def nli(self):
-        return self._nli
-
-    @nli.setter
-    def nli(self, nli):
-        self._nli = nli
-
-    @property
-    def ase(self):
-        return self._ase
-
-    @ase.setter
-    def ase(self, ase):
-        self._ase = ase
-
-    @property
-    def roll_off(self):
-        return self._roll_off
-
-    @property
-    def chromatic_dispersion(self):
-        return self._chromatic_dispersion
-
-    @chromatic_dispersion.setter
-    def chromatic_dispersion(self, chromatic_dispersion):
-        self._chromatic_dispersion = chromatic_dispersion
-
-    @property
-    def pmd(self):
-        return self._pmd
-
-    @property
-    def label(self):
-        return self._label
-
-    @pmd.setter
-    def pmd(self, pmd):
-        self._pmd = pmd
-
-    @property
-    def pdl(self):
-        return self._pdl
-
-    @pdl.setter
-    def pdl(self, pdl):
-        self._pdl = pdl
-
-    @property
-    def latency(self):
-        return self._latency
-
-    @latency.setter
-    def latency(self, latency):
-        self._latency = latency
-
-    @property
-    def delta_pdb_per_channel(self):
-        return self._delta_pdb_per_channel
-
-    @delta_pdb_per_channel.setter
-    def delta_pdb_per_channel(self, delta_pdb_per_channel):
-        self._delta_pdb_per_channel = delta_pdb_per_channel
-
-    @property
-    def tx_osnr(self):
-        return self._tx_osnr
-
-    @tx_osnr.setter
-    def tx_osnr(self, tx_osnr):
-        self._tx_osnr = tx_osnr
-
-    @property
-    def tx_power(self):
-        return self._tx_power
-
-    @tx_power.setter
-    def tx_power(self, tx_power):
-        self._tx_power = tx_power
-
-    @property
-    def channel_number(self):
-        return self._channel_number
-
-    @property
-    def carriers(self):
-        entries = zip(self.channel_number, self.frequency, self.baud_rate, self.slot_width,
-                      self.roll_off, self.powers, self.chromatic_dispersion, self.pmd, self.pdl, self.latency)
-        return [Channel(*entry) for entry in entries]
-
-    def apply_attenuation_lin(self, attenuation_lin):
-        self.signal *= attenuation_lin
-        self.nli *= attenuation_lin
-        self.ase *= attenuation_lin
-
-    def apply_attenuation_db(self, attenuation_db):
-        attenuation_lin = 1 / db2lin(attenuation_db)
-        self.apply_attenuation_lin(attenuation_lin)
-
-    def apply_gain_lin(self, gain_lin):
-        self.signal *= gain_lin
-        self.nli *= gain_lin
-        self.ase *= gain_lin
-
-    def apply_gain_db(self, gain_db):
-        gain_lin = db2lin(gain_db)
-        self.apply_gain_lin(gain_lin)
-
-    def __add__(self, other: SpectralInformation):
-        try:
-            return SpectralInformation(frequency=append(self.frequency, other.frequency),
-                                       slot_width=append(self.slot_width, other.slot_width),
-                                       signal=append(self.signal, other.signal), nli=append(self.nli, other.nli),
-                                       ase=append(self.ase, other.ase),
-                                       baud_rate=append(self.baud_rate, other.baud_rate),
-                                       roll_off=append(self.roll_off, other.roll_off),
-                                       chromatic_dispersion=append(self.chromatic_dispersion,
-                                                                   other.chromatic_dispersion),
-                                       pmd=append(self.pmd, other.pmd),
-                                       pdl=append(self.pdl, other.pdl),
-                                       latency=append(self.latency, other.latency),
-                                       delta_pdb_per_channel=append(self.delta_pdb_per_channel,
-                                                                    other.delta_pdb_per_channel),
-                                       tx_osnr=append(self.tx_osnr, other.tx_osnr),
-                                       tx_power=append(self.tx_power, other.tx_power),
-                                       label=append(self.label, other.label))
-        except SpectrumError:
-            raise SpectrumError('Spectra cannot be summed: channels overlapping.')
-
-    def _replace(self, carriers):
-        self.chromatic_dispersion = array([c.chromatic_dispersion for c in carriers])
-        self.pmd = array([c.pmd for c in carriers])
-        self.pdl = array([c.pdl for c in carriers])
-        self.latency = array([c.latency for c in carriers])
-        self.signal = array([c.power.signal for c in carriers])
-        self.nli = array([c.power.nli for c in carriers])
-        self.ase = array([c.power.ase for c in carriers])
-        return self
+class Pref(namedtuple('Pref', 'p_span0, p_spani, neq_ch ')):
+    """noiseless reference power in dBm: 
+    p_span0: inital target carrier power
+    p_spani: carrier power after element i
+    neq_ch: equivalent channel count in dB"""
 
 
-def create_arbitrary_spectral_information(frequency: Union[ndarray, Iterable, float],
-                                          signal: Union[float, ndarray, Iterable],
-                                          baud_rate: Union[float, ndarray, Iterable],
-                                          tx_osnr: Union[float, ndarray, Iterable],
-                                          tx_power: Union[float, ndarray, Iterable] = None,
-                                          delta_pdb_per_channel: Union[float, ndarray, Iterable] = 0.,
-                                          slot_width: Union[float, ndarray, Iterable] = None,
-                                          roll_off: Union[float, ndarray, Iterable] = 0.,
-                                          chromatic_dispersion: Union[float, ndarray, Iterable] = 0.,
-                                          pmd: Union[float, ndarray, Iterable] = 0.,
-                                          pdl: Union[float, ndarray, Iterable] = 0.,
-                                          latency: Union[float, ndarray, Iterable] = 0.,
-                                          label: Union[str, ndarray, Iterable] = None):
-    """This is just a wrapper around the SpectralInformation.__init__() that simplifies the creation of
-    a non-uniform spectral information with NLI and ASE powers set to zero."""
-    frequency = asarray(frequency)
-    number_of_channels = frequency.size
-    try:
-        signal = full(number_of_channels, signal)
-        baud_rate = full(number_of_channels, baud_rate)
-        roll_off = full(number_of_channels, roll_off)
-        slot_width = full(number_of_channels, slot_width) if slot_width is not None else \
-            ceil((1 + roll_off) * baud_rate / DEFAULT_SLOT_WIDTH_STEP) * DEFAULT_SLOT_WIDTH_STEP
-        chromatic_dispersion = full(number_of_channels, chromatic_dispersion)
-        pmd = full(number_of_channels, pmd)
-        pdl = full(number_of_channels, pdl)
-        latency = full(number_of_channels, latency)
-        nli = zeros(number_of_channels)
-        ase = zeros(number_of_channels)
-        delta_pdb_per_channel = full(number_of_channels, delta_pdb_per_channel)
-        tx_osnr = full(number_of_channels, tx_osnr)
-        tx_power = full(number_of_channels, tx_power)
-        label = full(number_of_channels, label)
-        return SpectralInformation(frequency=frequency, slot_width=slot_width,
-                                   signal=signal, nli=nli, ase=ase,
-                                   baud_rate=baud_rate, roll_off=roll_off,
-                                   chromatic_dispersion=chromatic_dispersion,
-                                   pmd=pmd, pdl=pdl, latency=latency,
-                                   delta_pdb_per_channel=delta_pdb_per_channel,
-                                   tx_osnr=tx_osnr, tx_power=tx_power, label=label)
-    except ValueError as e:
-        if 'could not broadcast' in str(e):
-            raise SpectrumError('Dimension mismatch in input fields.')
-        else:
-            raise
+class SpectralInformation(namedtuple('SpectralInformation', 'pref carriers')):
+
+    def __new__(cls, pref, carriers):
+        return super().__new__(cls, pref, carriers)
 
 
-def create_input_spectral_information(f_min, f_max, roll_off, baud_rate, spacing, tx_osnr, tx_power,
-                                      delta_pdb=0):
-    """Creates a fixed slot width spectral information with flat power.
-    all arguments are scalar values"""
-    number_of_channels = automatic_nch(f_min, f_max, spacing)
-    frequency = [(f_min + spacing * i) for i in range(1, number_of_channels + 1)]
-    delta_pdb_per_channel = delta_pdb * ones(number_of_channels)
-    label = [f'{baud_rate * 1e-9 :.2f}G' for i in range(number_of_channels)]
-    return create_arbitrary_spectral_information(frequency, slot_width=spacing, signal=tx_power, baud_rate=baud_rate,
-                                                 roll_off=roll_off, delta_pdb_per_channel=delta_pdb_per_channel,
-                                                 tx_osnr=tx_osnr, tx_power=tx_power, label=label)
+def create_input_spectral_information(f_min, f_max, roll_off, baud_rate, power, spacing):
+    # pref in dB : convert power lin into power in dB
+    pref = lin2db(power * 1e3)
+    nb_channel = automatic_nch(f_min, f_max, spacing)
+    si = SpectralInformation(
+        pref=Pref(pref, pref, lin2db(nb_channel)),
+        carriers=[
+            Channel(f, (f_min+spacing*f),
+            baud_rate, roll_off, Power(power, 0, 0)) for f in range(1,nb_channel+1)
+            ])
+    return si
 
+if __name__ == '__main__':
+    pref = lin2db(power * 1e3)
+    si = SpectralInformation(
+        Pref(pref, pref),
+        Channel(1, 193.95e12, 32e9, 0.15,  # 193.95 THz, 32 Gbaud
+            Power(1e-3, 1e-6, 1e-6)),             # 1 mW, 1uW, 1uW
+        Channel(1, 195.95e12, 32e9, 0.15,  # 195.95 THz, 32 Gbaud
+            Power(1.2e-3, 1e-6, 1e-6)),           # 1.2 mW, 1uW, 1uW
+    )
 
-def is_in_band(frequency: float, band: dict) -> bool:
-    """band has {"f_min": value, "f_max": value} format
-    """
-    if frequency >= band['f_min'] and frequency <= band['f_max']:
-        return True
-    return False
+    si = SpectralInformation()
+    spacing = 0.05 # THz
 
+    si = si._replace(carriers=tuple(Channel(f+1, 191.3+spacing*(f+1), 32e9, 0.15, Power(1e-3, f, 1)) for f in range(96)))
 
-def demuxed_spectral_information(input_si: SpectralInformation, band: dict) -> Optional[SpectralInformation]:
-    """extract a si based on band
-    """
-    filtered_indices = [i for i, f in enumerate(input_si.frequency)
-                        if is_in_band(f - input_si.slot_width[i] / 2, band)
-                        and is_in_band(f + input_si.slot_width[i] / 2, band)]
-    if filtered_indices:
-        frequency = input_si.frequency[filtered_indices]
-        baud_rate = input_si.baud_rate[filtered_indices]
-        slot_width = input_si.slot_width[filtered_indices]
-        signal = input_si.signal[filtered_indices]
-        nli = input_si.nli[filtered_indices]
-        ase = input_si.ase[filtered_indices]
-        roll_off = input_si.roll_off[filtered_indices]
-        chromatic_dispersion = input_si.chromatic_dispersion[filtered_indices]
-        pmd = input_si.pmd[filtered_indices]
-        pdl = input_si.pdl[filtered_indices]
-        latency = input_si.latency[filtered_indices]
-        delta_pdb_per_channel = input_si.delta_pdb_per_channel[filtered_indices]
-        tx_osnr = input_si.tx_osnr[filtered_indices]
-        tx_power = input_si.tx_power[filtered_indices]
-        label = input_si.label[filtered_indices]
-
-        return SpectralInformation(frequency=frequency, baud_rate=baud_rate, slot_width=slot_width, signal=signal,
-                                   nli=nli, ase=ase, roll_off=roll_off, chromatic_dispersion=chromatic_dispersion,
-                                   pmd=pmd, pdl=pdl, latency=latency, delta_pdb_per_channel=delta_pdb_per_channel,
-                                   tx_osnr=tx_osnr, tx_power=tx_power, label=label)
-    return None
-
-
-def muxed_spectral_information(input_si_list: List[SpectralInformation]) -> SpectralInformation:
-    """return the assembled spectrum
-    """
-    if input_si_list and len(input_si_list) > 1:
-        si = input_si_list[0] + muxed_spectral_information(input_si_list[1:])
-        return si
-    elif input_si_list and len(input_si_list) == 1:
-        return input_si_list[0]
-    else:
-        raise ValueError('liste vide')
-
-
-def carriers_to_spectral_information(initial_spectrum: dict[float, Carrier],
-                                     power: float) -> SpectralInformation:
-    """Initial spectrum is a dict with key = carrier frequency, and value a Carrier object.
-    :param initial_spectrum: indexed by frequency in Hz, with power offset (delta_pdb), baudrate, slot width,
-    tx_osnr, tx_power and roll off.
-    :param power: power of the request
-    """
-    frequency = list(initial_spectrum.keys())
-    signal = [c.tx_power for c in initial_spectrum.values()]
-    roll_off = [c.roll_off for c in initial_spectrum.values()]
-    baud_rate = [c.baud_rate for c in initial_spectrum.values()]
-    delta_pdb_per_channel = [c.delta_pdb for c in initial_spectrum.values()]
-    slot_width = [c.slot_width for c in initial_spectrum.values()]
-    tx_osnr = [c.tx_osnr for c in initial_spectrum.values()]
-    tx_power = [c.tx_power for c in initial_spectrum.values()]
-    label = [c.label for c in initial_spectrum.values()]
-    return create_arbitrary_spectral_information(frequency=frequency, signal=signal, baud_rate=baud_rate,
-                                                 slot_width=slot_width, roll_off=roll_off,
-                                                 delta_pdb_per_channel=delta_pdb_per_channel, tx_osnr=tx_osnr,
-                                                 tx_power=tx_power, label=label)
-
-
-@dataclass
-class Carrier:
-    """One channel in the initial mixed-type spectrum definition, each type being defined by
-    its delta_pdb (power offset with respect to reference power), baud rate, slot_width, roll_off
-    tx_power, and tx_osnr. delta_pdb offset is applied to target power out of Roadm.
-    Label is used to group carriers which belong to the same partition when printing results.
-    """
-    delta_pdb: float
-    baud_rate: float
-    slot_width: float
-    roll_off: float
-    tx_osnr: float
-    tx_power: float
-    label: str
-
-
-@dataclass
-class ReferenceCarrier:
-    """Reference channel type is used to determine target power out of ROADM for the reference channel when
-    constant power spectral density (PSD) equalization is set. Reference channel is the type that has been defined
-    in SI block and used for the initial design of the network.
-    Computing the power out of ROADM for the reference channel is required to correctly compute the loss
-    experienced by reference channel in Roadm element.
-
-    Baud rate is required to find the target power in constant PSD: power = PSD_target * baud_rate.
-    For example, if target PSD is 3.125e4mW/GHz and reference carrier type a 32 GBaud channel then
-    output power should be -20 dBm and for a 64 GBaud channel power target would need 3 dB more: -17 dBm.
-
-    Slot width is required to find the target power in constant PSW (constant power per slot width equalization):
-    power = PSW_target * slot_width.
-    For example, if target PSW is 2e4mW/GHz and reference carrier type a 32 GBaud channel in a 50GHz slot width then
-    output power should be -20 dBm and for a 64 GBaud channel  in a 75 GHz slot width, power target would be -18.24 dBm.
-
-    Other attributes (like roll-off) may be added there for future equalization purpose.
-    """
-    baud_rate: float
-    slot_width: float
+    print(f'si = {si}')
+    print(f'si = {si.carriers[0].power.nli}')
+    print(f'si = {si.carriers[20].power.nli}')
+    si2 = si._replace(carriers=tuple(c._replace(power = c.power._replace(nli = c.power.nli * 1e5))
+                              for c in si.carriers))
+    print(f'si2 = {si2}')

gnpy/core/node.py

@@ -0,0 +1,56 @@
+#! /bin/usr/python3
+# -*- coding: utf-8 -*-
+
+'''
+gnpy.core.node
+==============
+
+This module contains the base class for a network element.
+
+Strictly, a network element is any callable which accepts an immutable
+:class:`.info.SpectralInformation` object and returns an :class:`.info.SpectralInformation` object
+(a copy).
+
+Network elements MUST implement two attributes .uid and .name representing a
+unique identifier and a printable name.
+
+This base class provides a more convenient way to define a network element
+via subclassing.
+'''
+
+from uuid import uuid4
+from collections import namedtuple
+
+class Location(namedtuple('Location', 'latitude longitude city region')):
+    def __new__(cls, latitude=0, longitude=0, city=None, region=None):
+        return super().__new__(cls, latitude, longitude, city, region)
+
+class Node:
+    def __init__(self, uid, name=None, params=None, metadata=None, operational=None):
+        if name is None:
+            name = uid
+        self.uid, self.name = uid, name
+        if metadata is None:
+            metadata = {'location': {}}
+        if metadata and not isinstance(metadata.get('location'), Location):
+            metadata['location'] = Location(**metadata.pop('location', {}))
+        self.params, self.metadata, self.operational = params, metadata, operational
+
+    @property
+    def coords(self):
+        return self.lng, self.lat
+
+    @property
+    def location(self):
+        return self.metadata['location']
+    loc = location
+
+    @property
+    def longitude(self):
+        return self.location.longitude
+    lng = longitude
+
+    @property
+    def latitude(self):
+        return self.location.latitude
+    lat = latitude

gnpy/core/parameters.py

@@ -1,731 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-# SPDX-License-Identifier: BSD-3-Clause
-# gnpy.core.parameters: parameters to configure standard network elements
-# Copyright (C) 2025 Telecom Infra Project and GNPy contributors
-# see AUTHORS.rst for a list of contributors
-
-"""
-gnpy.core.parameters
-====================
-
-This module contains all parameters to configure standard network elements.
-"""
-from collections import namedtuple
-from copy import deepcopy
-from dataclasses import dataclass
-from scipy.constants import c, pi
-from numpy import asarray, array, exp, sqrt, log, outer, ones, squeeze, append, flip, linspace, full
-
-from gnpy.core.utils import convert_length
-from gnpy.core.exceptions import ParametersError
-
-
-class Parameters:
-    def asdict(self):
-        class_dict = self.__class__.__dict__
-        instance_dict = self.__dict__
-        new_dict = {}
-        for key in class_dict:
-            if isinstance(class_dict[key], property):
-                new_dict[key] = instance_dict['_' + key]
-        return new_dict
-
-
-class PumpParams(Parameters):
-    def __init__(self, power, frequency, propagation_direction):
-        self.power = power
-        self.frequency = frequency
-        self.propagation_direction = propagation_direction.lower()
-
-
-class RamanParams(Parameters):
-    def __init__(self, flag=False, method='perturbative', order=2, result_spatial_resolution=10e3,
-                 solver_spatial_resolution=10e3):
-        """Simulation parameters used within the Raman Solver
-
-        :params flag: boolean for enabling/disable the evaluation of the Raman power profile in frequency and position
-        :params method: Raman solver method
-        :params order: solution order for perturbative method
-        :params result_spatial_resolution: spatial resolution of the evaluated Raman power profile
-        :params solver_spatial_resolution: spatial step for the iterative solution of the first order ode
-        """
-        self.flag = flag
-        self.method = method
-        self.order = order
-        self.result_spatial_resolution = result_spatial_resolution  # [m]
-        self.solver_spatial_resolution = solver_spatial_resolution  # [m]
-
-    def to_json(self):
-        return {"flag": self.flag,
-                "method": self.method,
-                "order": self.order,
-                "result_spatial_resolution": self.result_spatial_resolution,
-                "solver_spatial_resolution": self.solver_spatial_resolution}
-
-
-class NLIParams(Parameters):
-    def __init__(self, method='gn_model_analytic', dispersion_tolerance=4, phase_shift_tolerance=0.1,
-                 computed_channels=None, computed_number_of_channels=None):
-        """Simulation parameters used within the Nli Solver
-
-        :params method: formula for NLI calculation
-        :params dispersion_tolerance: tuning parameter for ggn model solution
-        :params phase_shift_tolerance: tuning parameter for ggn model solution
-        :params computed_channels: the NLI is evaluated for these channels and extrapolated for the others
-        :params computed_number_of_channels: the NLI is evaluated for this number of channels equally distributed
-        in the spectrum and extrapolated for the others
-        """
-        self.method = method.lower()
-        self.dispersion_tolerance = dispersion_tolerance
-        self.phase_shift_tolerance = phase_shift_tolerance
-        self.computed_channels = computed_channels
-        self.computed_number_of_channels = computed_number_of_channels
-
-    def to_json(self):
-        return {"method": self.method,
-                "dispersion_tolerance": self.dispersion_tolerance,
-                "phase_shift_tolerance": self.phase_shift_tolerance,
-                "computed_channels": self.computed_channels,
-                "computed_number_of_channels": self.computed_number_of_channels}
-
-
-class SimParams(Parameters):
-    _shared_dict = {'nli_params': NLIParams(), 'raman_params': RamanParams()}
-
-    @classmethod
-    def set_params(cls, sim_params):
-        cls._shared_dict['nli_params'] = NLIParams(**sim_params.get('nli_params', {}))
-        cls._shared_dict['raman_params'] = RamanParams(**sim_params.get('raman_params', {}))
-
-    @property
-    def nli_params(self):
-        return self._shared_dict['nli_params']
-
-    @property
-    def raman_params(self):
-        return self._shared_dict['raman_params']
-
-
-class RoadmParams(Parameters):
-    def __init__(self, **kwargs):
-        self.target_pch_out_db = kwargs.get('target_pch_out_db')
-        self.target_psd_out_mWperGHz = kwargs.get('target_psd_out_mWperGHz')
-        self.target_out_mWperSlotWidth = kwargs.get('target_out_mWperSlotWidth')
-        equalisation_type = ['target_pch_out_db', 'target_psd_out_mWperGHz', 'target_out_mWperSlotWidth']
-        temp = [kwargs.get(k) is not None for k in equalisation_type]
-        if sum(temp) > 1:
-            raise ParametersError('ROADM config contains more than one equalisation type.'
-                                  + 'Please choose only one', kwargs)
-        self.per_degree_pch_out_db = kwargs.get('per_degree_pch_out_db', {})
-        self.per_degree_pch_psd = kwargs.get('per_degree_psd_out_mWperGHz', {})
-        self.per_degree_pch_psw = kwargs.get('per_degree_psd_out_mWperSlotWidth', {})
-        try:
-            self.add_drop_osnr = kwargs['add_drop_osnr']
-            self.pmd = kwargs['pmd']
-            self.pdl = kwargs['pdl']
-            self.restrictions = kwargs['restrictions']
-            self.roadm_path_impairments = self.get_roadm_path_impairments(kwargs['roadm-path-impairments'])
-        except KeyError as e:
-            raise ParametersError(f'ROADM configurations must include {e}. Configuration: {kwargs}')
-        self.per_degree_impairments = kwargs.get('per_degree_impairments', [])
-        self.design_bands = kwargs.get('design_bands', [])
-        self.per_degree_design_bands = kwargs.get('per_degree_design_bands', {})
-
-    def get_roadm_path_impairments(self, path_impairments_list):
-        """Get the ROADM list of profiles for impairments definition
-
-        transform the ietf model into gnpy internal model: add a path-type in the attributes
-        """
-        if not path_impairments_list:
-            return {}
-        authorized_path_types = {
-            'roadm-express-path': 'express',
-            'roadm-add-path': 'add',
-            'roadm-drop-path': 'drop',
-        }
-        roadm_path_impairments = {}
-        for path_impairment in path_impairments_list:
-            index = path_impairment['roadm-path-impairments-id']
-            path_type = next(key for key in path_impairment if key in authorized_path_types.keys())
-            impairment_dict = {'path-type': authorized_path_types[path_type], 'impairment': path_impairment[path_type]}
-            roadm_path_impairments[index] = RoadmImpairment(impairment_dict)
-        return roadm_path_impairments
-
-
-class RoadmPath:
-    def __init__(self, from_degree, to_degree, path_type, impairment_id=None, impairment=None):
-        """Records roadm internal paths, types and impairment
-
-        path_type must be in "express", "add", "drop"
-        impairment_id must be one of the id detailed in equipement
-        """
-        self.from_degree = from_degree
-        self.to_degree = to_degree
-        self.path_type = path_type
-        self.impairment_id = impairment_id
-        self.impairment = impairment
-
-
-class RoadmImpairment:
-    """Generic definition of impairments for express, add and drop"""
-    default_values = {
-        'roadm-pmd': None,
-        'roadm-cd': None,
-        'roadm-pdl': None,
-        'roadm-inband-crosstalk': None,
-        'roadm-maxloss': 0,
-        'roadm-osnr': None,
-        'roadm-pmax': None,
-        'roadm-noise-figure': None,
-        'minloss': None,
-        'typloss': None,
-        'pmin': None,
-        'ptyp': None
-    }
-
-    def __init__(self, params):
-        self.path_type = params.get('path-type')
-        self.impairments = params['impairment']
-
-
-class FusedParams(Parameters):
-    def __init__(self, **kwargs):
-        self.loss = kwargs['loss'] if 'loss' in kwargs else 1
-
-
-DEFAULT_RAMAN_COEFFICIENT = {
-    # SSMF Raman coefficient profile in terms of mode intensity (g0 * A_ff_overlap)
-    'gamma_raman': array(
-        [0.0, 8.524419934705497e-16, 2.643567866245371e-15, 4.410548410941305e-15, 6.153422961291078e-15,
-         7.484924703044943e-15, 8.452060808349209e-15, 9.101549322698156e-15, 9.57837595158966e-15,
-         1.0008642675474562e-14, 1.0865773569905647e-14, 1.1300776305865833e-14, 1.2143238647099625e-14,
-         1.3231065750676068e-14, 1.4624900971525384e-14, 1.6013330554840492e-14, 1.7458119359310242e-14,
-         1.9320241330434762e-14, 2.1720395392873534e-14, 2.4137337406734775e-14, 2.628163218460466e-14,
-         2.8041019963285974e-14, 2.9723155447089933e-14, 3.129353531005888e-14, 3.251796163324624e-14,
-         3.3198839487612773e-14, 3.329527690685666e-14, 3.313155691238456e-14, 3.289013852154548e-14,
-         3.2458917188506916e-14, 3.060684277937575e-14, 3.2660349473783173e-14, 2.957419109657689e-14,
-         2.518894321396672e-14, 1.734560485857344e-14, 9.902860761605233e-15, 7.219176385099358e-15,
-         6.079565990401311e-15, 5.828373065963427e-15, 7.20580801091692e-15, 7.561924351387493e-15,
-         7.621152352332206e-15, 6.8859886780643254e-15, 5.629181047471162e-15, 3.679727598966185e-15,
-         2.7555869742500355e-15, 2.4810133942597675e-15, 2.2160080532403624e-15, 2.1440626024765557e-15,
-         2.33873070799544e-15, 2.557317929858713e-15, 3.039839048226572e-15, 4.8337165515610065e-15,
-         5.4647431818257436e-15, 5.229187813711269e-15, 4.510768525811313e-15, 3.3213473130607794e-15,
-         2.2602577027996455e-15, 1.969576495866441e-15, 1.5179853954188527e-15, 1.2953988551200156e-15,
-         1.1304672156251838e-15, 9.10004390675213e-16, 8.432919922183503e-16, 7.849224069008326e-16,
-         7.827568196032024e-16, 9.000514440646232e-16, 1.3025926460013665e-15, 1.5444108938497558e-15,
-         1.8795594063060786e-15, 1.7796130169921014e-15, 1.5938159865046653e-15, 1.1585522355108287e-15,
-         8.507044444633358e-16, 7.625404663756823e-16, 8.14510750925789e-16, 9.047944693473188e-16,
-         9.636431901702084e-16, 9.298633899602105e-16, 8.349739503637023e-16, 7.482901278066085e-16,
-         6.240794767134268e-16, 5.00652535687506e-16, 3.553373263685851e-16, 2.0344217706119682e-16,
-         1.4267522642294203e-16, 8.980016576743517e-17, 2.9829068181832594e-17, 1.4861959129014824e-17,
-         7.404482113326137e-18]
-    ),  # m/W
-    # SSMF Raman coefficient profile
-    'g0': array(
-        [0.00000000e+00, 1.12351610e-05, 3.47838074e-05, 5.79356636e-05, 8.06921680e-05, 9.79845709e-05, 1.10454361e-04,
-         1.18735302e-04, 1.24736889e-04, 1.30110053e-04, 1.41001273e-04, 1.46383247e-04, 1.57011792e-04, 1.70765865e-04,
-         1.88408911e-04, 2.05914127e-04, 2.24074028e-04, 2.47508283e-04, 2.77729174e-04, 3.08044243e-04, 3.34764439e-04,
-         3.56481704e-04, 3.77127256e-04, 3.96269124e-04, 4.10955175e-04, 4.18718761e-04, 4.19511263e-04, 4.17025384e-04,
-         4.13565369e-04, 4.07726048e-04, 3.83671291e-04, 4.08564283e-04, 3.69571936e-04, 3.14442090e-04, 2.16074535e-04,
-         1.23097823e-04, 8.95457457e-05, 7.52470400e-05, 7.19806145e-05, 8.87961158e-05, 9.30812065e-05, 9.37058268e-05,
-         8.45719619e-05, 6.90585286e-05, 4.50407159e-05, 3.36521245e-05, 3.02292475e-05, 2.69376939e-05, 2.60020897e-05,
-         2.82958958e-05, 3.08667558e-05, 3.66024657e-05, 5.80610307e-05, 6.54797937e-05, 6.25022715e-05, 5.37806442e-05,
-         3.94996621e-05, 2.68120644e-05, 2.33038554e-05, 1.79140757e-05, 1.52472424e-05, 1.32707565e-05, 1.06541760e-05,
-         9.84649374e-06, 9.13999627e-06, 9.08971012e-06, 1.04227525e-05, 1.50419271e-05, 1.77838232e-05, 2.15810815e-05,
-         2.03744008e-05, 1.81939341e-05, 1.31862121e-05, 9.65352116e-06, 8.62698322e-06, 9.18688016e-06, 1.01737784e-05,
-         1.08017817e-05, 1.03903588e-05, 9.30040333e-06, 8.30809173e-06, 6.90650401e-06, 5.52238029e-06, 3.90648708e-06,
-         2.22908227e-06, 1.55796177e-06, 9.77218716e-07, 3.23477236e-07, 1.60602454e-07, 7.97306386e-08]
-    ),  # [1 / (W m)]
-
-    # Note the non-uniform spacing of this range; this is required for properly capturing the Raman peak shape.
-    'frequency_offset': array([
-        0., 0.5, 1., 1.5, 2., 2.5, 3., 3.5, 4., 4.5, 5., 5.5, 6., 6.5, 7., 7.5, 8., 8.5, 9., 9.5, 10., 10.5, 11., 11.5,
-        12., 12.5, 12.75, 13., 13.25, 13.5, 14., 14.5, 14.75, 15., 15.5, 16., 16.5, 17., 17.5, 18., 18.25, 18.5, 18.75,
-        19., 19.5, 20., 20.5, 21., 21.5, 22., 22.5, 23., 23.5, 24., 24.5, 25., 25.5, 26., 26.5, 27., 27.5, 28., 28.5,
-        29., 29.5, 30., 30.5, 31., 31.5, 32., 32.5, 33., 33.5, 34., 34.5, 35., 35.5, 36., 36.5, 37., 37.5, 38., 38.5,
-        39., 39.5, 40., 40.5, 41., 41.5, 42.]) * 1e12,  # [Hz]
-
-    # Raman profile reference frequency
-    'reference_frequency': 206.184634112792e12,  # [Hz] (1454 nm)
-
-    # Raman profile reference effective area
-    'reference_effective_area': 75.74659443542413e-12  # [m^2] (@1454 nm)
-}
-
-
-class RamanGainCoefficient(namedtuple('RamanGainCoefficient', 'normalized_gamma_raman frequency_offset')):
-    """ Raman Gain Coefficient Parameters
-
-        Based on:
-            Andrea D’Amico, Bruno Correia, Elliot London, Emanuele Virgillito, Giacomo Borraccini, Antonio Napoli,
-            and Vittorio Curri, "Scalable and Disaggregated GGN Approximation Applied to a C+L+S Optical Network,"
-            J. Lightwave Technol. 40, 3499-3511 (2022)
-            Section III.D
-    """
-
-
-class FiberParams(Parameters):
-    def __init__(self, **kwargs):
-        try:
-            self._length = convert_length(kwargs['length'], kwargs['length_units'])
-            # fixed attenuator for padding
-            self._att_in = kwargs.get('att_in', 0)
-            # if not defined in the network json connector loss in/out
-            # the None value will be updated in network.py[build_network]
-            # with default values from eqpt_config.json[Spans]
-            self._con_in = kwargs.get('con_in')
-            self._con_out = kwargs.get('con_out')
-
-            # Reference frequency (unique for all parameters: beta2, beta3, gamma, effective_area)
-            if 'ref_wavelength' in kwargs:
-                self._ref_wavelength = kwargs['ref_wavelength']
-                self._ref_frequency = c / self._ref_wavelength
-            elif 'ref_frequency' in kwargs:
-                self._ref_frequency = kwargs['ref_frequency']
-                self._ref_wavelength = c / self._ref_frequency
-            else:
-                self._ref_wavelength = 1550e-9  # conventional central C band wavelength [m]
-                self._ref_frequency = c / self._ref_wavelength
-
-            # Chromatic Dispersion
-            if 'dispersion_per_frequency' in kwargs:
-                # Frequency-dependent dispersion
-                self._dispersion = asarray(kwargs['dispersion_per_frequency']['value'])  # s/m/m
-                self._f_dispersion_ref = asarray(kwargs['dispersion_per_frequency']['frequency'])  # Hz
-                self._dispersion_slope = None
-            elif 'dispersion' in kwargs:
-                # Single value dispersion
-                self._dispersion = asarray(kwargs['dispersion'])  # s/m/m
-                self._dispersion_slope = kwargs.get('dispersion_slope')  # s/m/m/m
-                self._f_dispersion_ref = asarray(self._ref_frequency)  # Hz
-            else:
-                # Default single value dispersion
-                self._dispersion = asarray(1.67e-05)  # s/m/m
-                self._dispersion_slope = None
-                self._f_dispersion_ref = asarray(self.ref_frequency)  # Hz
-
-            # Effective Area and Nonlinear Coefficient
-            self._effective_area = kwargs.get('effective_area')  # m^2
-            self._n1 = 1.468
-            self._core_radius = 4.2e-6  # m
-            self._n2 = 2.6e-20  # m^2/W
-            if self._effective_area is not None:
-                default_gamma = 2 * pi * self._n2 / (self._ref_wavelength * self._effective_area)
-                self._gamma = kwargs.get('gamma', default_gamma)  # 1/W/m
-            elif 'gamma' in kwargs:
-                self._gamma = kwargs['gamma']  # 1/W/m
-                self._effective_area = 2 * pi * self._n2 / (self._ref_wavelength * self._gamma)  # m^2
-            else:
-                self._effective_area = 83e-12  # m^2
-                self._gamma = 2 * pi * self._n2 / (self._ref_wavelength * self._effective_area)  # 1/W/m
-            self._contrast = 0.5 * (c / (2 * pi * self._ref_frequency * self._core_radius * self._n1) * exp(
-                pi * self._core_radius ** 2 / self._effective_area)) ** 2
-
-            # Raman Gain Coefficient
-            raman_coefficient = kwargs.get('raman_coefficient')
-            if raman_coefficient is None:
-                self._raman_reference_frequency = DEFAULT_RAMAN_COEFFICIENT['reference_frequency']
-                frequency_offset = asarray(DEFAULT_RAMAN_COEFFICIENT['frequency_offset'])
-                gamma_raman = asarray(DEFAULT_RAMAN_COEFFICIENT['gamma_raman'])
-                stokes_wave = self._raman_reference_frequency - frequency_offset
-                normalized_gamma_raman = gamma_raman / self._raman_reference_frequency  # 1 / m / W / Hz
-                self._g0 = gamma_raman / self.effective_area_overlap(stokes_wave, self._raman_reference_frequency)
-            else:
-                self._raman_reference_frequency = raman_coefficient['reference_frequency']
-                frequency_offset = asarray(raman_coefficient['frequency_offset'])
-                stokes_wave = self._raman_reference_frequency - frequency_offset
-                self._g0 = asarray(raman_coefficient['g0'])
-                gamma_raman = self._g0 * self.effective_area_overlap(stokes_wave, self._raman_reference_frequency)
-                normalized_gamma_raman = gamma_raman / self._raman_reference_frequency  # 1 / m / W / Hz
-
-            # Raman gain coefficient array of the frequency offset constructed such that positive frequency values
-            # represent a positive power transfer from higher frequency and vice versa
-            frequency_offset = append(-flip(frequency_offset[1:]), frequency_offset)
-            normalized_gamma_raman = append(- flip(normalized_gamma_raman[1:]), normalized_gamma_raman)
-            self._raman_coefficient = RamanGainCoefficient(normalized_gamma_raman, frequency_offset)
-
-            # Polarization Mode Dispersion
-            self._pmd_coef = kwargs['pmd_coef']  # s/sqrt(m)
-            self._pmd_coef_defined = kwargs.get('pmd_coef_defined', kwargs['pmd_coef'] is True)
-
-            # Loss Coefficient
-            if isinstance(kwargs['loss_coef'], dict):
-                self._loss_coef = asarray(kwargs['loss_coef']['value']) * 1e-3  # lineic loss dB/m
-                self._f_loss_ref = asarray(kwargs['loss_coef']['frequency'])  # Hz
-            else:
-                self._loss_coef = asarray(kwargs['loss_coef']) * 1e-3  # lineic loss dB/m
-                self._f_loss_ref = asarray(self._ref_frequency)  # Hz
-            # Lumped Losses
-            self._lumped_losses = kwargs['lumped_losses'] if 'lumped_losses' in kwargs else array([])
-            self._latency = self._length / (c / self._n1)  # s
-        except KeyError as e:
-            raise ParametersError(f'Fiber configurations json must include {e}. Configuration: {kwargs}')
-
-    @property
-    def length(self):
-        return self._length
-
-    @length.setter
-    def length(self, length):
-        """length must be in m"""
-        self._length = length
-
-    @property
-    def att_in(self):
-        return self._att_in
-
-    @att_in.setter
-    def att_in(self, att_in):
-        self._att_in = att_in
-
-    @property
-    def con_in(self):
-        return self._con_in
-
-    @con_in.setter
-    def con_in(self, con_in):
-        self._con_in = con_in
-
-    @property
-    def con_out(self):
-        return self._con_out
-
-    @property
-    def lumped_losses(self):
-        return self._lumped_losses
-
-    @con_out.setter
-    def con_out(self, con_out):
-        self._con_out = con_out
-
-    @property
-    def dispersion(self):
-        return self._dispersion
-
-    @property
-    def f_dispersion_ref(self):
-        return self._f_dispersion_ref
-
-    @property
-    def dispersion_slope(self):
-        return self._dispersion_slope
-
-    @property
-    def gamma(self):
-        return self._gamma
-
-    def effective_area_scaling(self, frequency):
-        V = 2 * pi * frequency / c * self._core_radius * self._n1 * sqrt(2 * self._contrast)
-        w = self._core_radius / sqrt(log(V))
-        return asarray(pi * w ** 2)
-
-    def effective_area_overlap(self, frequency_stokes_wave, frequency_pump):
-        effective_area_stokes_wave = self.effective_area_scaling(frequency_stokes_wave)
-        effective_area_pump = self.effective_area_scaling(frequency_pump)
-        return squeeze(outer(effective_area_stokes_wave, ones(effective_area_pump.size)) + outer(
-            ones(effective_area_stokes_wave.size), effective_area_pump)) / 2
-
-    def gamma_scaling(self, frequency):
-        return asarray(2 * pi * self._n2 * frequency / (c * self.effective_area_scaling(frequency)))
-
-    @property
-    def pmd_coef(self):
-        return self._pmd_coef
-
-    @property
-    def pmd_coef_defined(self):
-        return self._pmd_coef_defined
-
-    @property
-    def ref_wavelength(self):
-        return self._ref_wavelength
-
-    @property
-    def ref_frequency(self):
-        return self._ref_frequency
-
-    @property
-    def loss_coef(self):
-        return self._loss_coef
-
-    @property
-    def f_loss_ref(self):
-        return self._f_loss_ref
-
-    @property
-    def raman_coefficient(self):
-        return self._raman_coefficient
-
-    @property
-    def latency(self):
-        return self._latency
-
-    def asdict(self):
-        dictionary = super().asdict()
-        dictionary['loss_coef'] = self.loss_coef * 1e3
-        dictionary['length_units'] = 'm'
-        if len(self.lumped_losses) == 0:
-            dictionary.pop('lumped_losses')
-        if not self.raman_coefficient:
-            dictionary.pop('raman_coefficient')
-        else:
-            raman_frequency_offset = \
-                self.raman_coefficient.frequency_offset[self.raman_coefficient.frequency_offset >= 0]
-            dictionary['raman_coefficient'] = {'g0': self._g0.tolist(),
-                                               'frequency_offset': raman_frequency_offset.tolist(),
-                                               'reference_frequency': self._raman_reference_frequency}
-        return dictionary
-
-
-class EdfaParams:
-    default_values = {
-        'f_min': None,
-        'f_max': None,
-        'multi_band': None,
-        'bands': None,
-        'type_variety': '',
-        'type_def': '',
-        'gain_flatmax': None,
-        'gain_min': None,
-        'p_max': None,
-        'nf_model': None,
-        'dual_stage_model': None,
-        'preamp_variety': None,
-        'booster_variety': None,
-        'nf_min': None,
-        'nf_max': None,
-        'nf_coef': None,
-        'nf0': None,
-        'nf_fit_coeff': None,
-        'nf_ripple': 0,
-        'dgt': None,
-        'gain_ripple': 0,
-        'tilt_ripple': 0,
-        'f_ripple_ref': None,
-        'out_voa_auto': False,
-        'allowed_for_design': False,
-        'raman': False,
-        'pmd': 0,
-        'pdl': 0,
-        'advance_configurations_from_json': None
-    }
-
-    def __init__(self, **params):
-        try:
-            self.type_variety = params['type_variety']
-            self.type_def = params['type_def']
-
-            # Bandwidth
-            self.f_min = params['f_min']
-            self.f_max = params['f_max']
-            self.bandwidth = self.f_max - self.f_min if self.f_max and self.f_min else None
-            self.f_cent = (self.f_max + self.f_min) / 2 if self.f_max and self.f_min else None
-            self.f_ripple_ref = params['f_ripple_ref']
-            self.bands = [{'f_min': params['f_min'],
-                           'f_max': params['f_max']}]
-
-            # Gain
-            self.gain_flatmax = params['gain_flatmax']
-            self.gain_min = params['gain_min']
-
-            gain_ripple = params['gain_ripple']
-            if gain_ripple == 0:
-                self.gain_ripple = asarray([0, 0])
-                self.f_ripple_ref = asarray([self.f_min, self.f_max])
-            else:
-                self.gain_ripple = asarray(gain_ripple)
-                if self.f_ripple_ref is not None:
-                    if (self.f_ripple_ref[0] != self.f_min) or (self.f_ripple_ref[-1] != self.f_max):
-                        raise ParametersError("The reference ripple frequency maximum and minimum have to coincide "
-                                              "with the EDFA frequency maximum and minimum.")
-                    elif self.gain_ripple.size != self.f_ripple_ref.size:
-                        raise ParametersError("The reference ripple frequency and the gain ripple must have the same "
-                                              "size.")
-                else:
-                    self.f_ripple_ref = linspace(self.f_min, self.f_max, self.gain_ripple.size)
-
-            tilt_ripple = params['tilt_ripple']
-
-            if tilt_ripple == 0:
-                self.tilt_ripple = full(self.gain_ripple.size, 0)
-            else:
-                self.tilt_ripple = asarray(tilt_ripple)
-                if self.tilt_ripple.size != self.gain_ripple.size:
-                    raise ParametersError("The tilt ripple and the gain ripple must have the same size.")
-
-            # Power
-            self.p_max = params['p_max']
-
-            # Noise Figure
-            self.nf_model = params['nf_model']
-            self.nf_min = params['nf_min']
-            self.nf_max = params['nf_max']
-            self.nf_coef = params['nf_coef']
-            self.nf0 = params['nf0']
-            self.nf_fit_coeff = params['nf_fit_coeff']
-
-            nf_ripple = params['nf_ripple']
-            if nf_ripple == 0:
-                self.nf_ripple = full(self.gain_ripple.size, 0)
-            else:
-                self.nf_ripple = asarray(nf_ripple)
-                if self.nf_ripple.size != self.gain_ripple.size:
-                    raise ParametersError(
-                        "The noise figure ripple and the gain ripple must have the same size. %s, %s",
-                        self.nf_ripple.size, self.gain_ripple.size)
-
-            # VOA
-            self.out_voa_auto = params['out_voa_auto']
-
-            # Dual Stage
-            self.dual_stage_model = params['dual_stage_model']
-            if self.dual_stage_model is not None:
-                # Preamp
-                self.preamp_variety = params['preamp_variety']
-                self.preamp_type_def = params['preamp_type_def']
-                self.preamp_nf_model = params['preamp_nf_model']
-                self.preamp_nf_fit_coeff = params['preamp_nf_fit_coeff']
-                self.preamp_gain_min = params['preamp_gain_min']
-                self.preamp_gain_flatmax = params['preamp_gain_flatmax']
-
-                # Booster
-                self.booster_variety = params['booster_variety']
-                self.booster_type_def = params['booster_type_def']
-                self.booster_nf_model = params['booster_nf_model']
-                self.booster_nf_fit_coeff = params['booster_nf_fit_coeff']
-                self.booster_gain_min = params['booster_gain_min']
-                self.booster_gain_flatmax = params['booster_gain_flatmax']
-
-            # Others
-            self.pmd = params['pmd']
-            self.pdl = params['pdl']
-            self.raman = params['raman']
-            self.dgt = params['dgt']
-            self.advance_configurations_from_json = params['advance_configurations_from_json']
-
-            # Design
-            self.allowed_for_design = params['allowed_for_design']
-
-        except KeyError as e:
-            raise ParametersError(f'Edfa configurations json must include {e}. Configuration: {params}')
-
-    def update_params(self, kwargs):
-        for k, v in kwargs.items():
-            setattr(self, k, v)
-
-
-class EdfaOperational:
-    default_values = {
-        'gain_target': None,
-        'delta_p': None,
-        'out_voa': None,
-        'in_voa': 0,
-        'tilt_target': None
-    }
-
-    def __init__(self, **operational):
-        self.update_attr(operational)
-
-    def update_attr(self, kwargs):
-        clean_kwargs = {k: v for k, v in kwargs.items() if v != ''}
-        for k, v in self.default_values.items():
-            setattr(self, k, clean_kwargs.get(k, v))
-
-    def __repr__(self):
-        return (f'{type(self).__name__}('
-                f'gain_target={self.gain_target!r}, '
-                f'tilt_target={self.tilt_target!r})')
-
-
-DEFAULT_EDFA_CONFIG = {
-    "nf_ripple": [
-        0.0
-    ],
-    "gain_ripple": [
-        0.0
-    ],
-    "f_min": 191.275e12,
-    "f_max": 196.125e12,
-    "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
-    ]
-}
-
-
-class MultiBandParams:
-    default_values = {
-        'bands': [],
-        'type_variety': '',
-        'type_def': None,
-        'allowed_for_design': False
-    }
-
-    def __init__(self, **params):
-        try:
-            self.update_attr(params)
-        except KeyError as e:
-            raise ParametersError(f'Multiband configurations json must include {e}. Configuration: {params}')
-
-    def update_attr(self, kwargs):
-        clean_kwargs = {k: v for k, v in kwargs.items() if v != ''}
-        for k, v in self.default_values.items():
-            # use deepcopy to avoid sharing same object amongst all instance when v is a list or a dict!
-            if isinstance(v, (list, dict)):
-                setattr(self, k, clean_kwargs.get(k, deepcopy(v)))
-            else:
-                setattr(self, k, clean_kwargs.get(k, v))
-
-
-class TransceiverParams:
-    def __init__(self, **params):
-        self.design_bands = params.get('design_bands', [])
-        self.per_degree_design_bands = params.get('per_degree_design_bands', {})
-
-
-@dataclass
-class FrequencyBand:
-    """Frequency band
-    """
-    f_min: float
-    f_max: float
-
-
-DEFAULT_BANDS_DEFINITION = {
-    "LBAND": FrequencyBand(f_min=187e12, f_max=189e12),
-    "CBAND": FrequencyBand(f_min=191.3e12, f_max=196.0e12)
-}
-# use this definition to index amplifiers'element of a multiband amplifier.
-# this is not the design band
-
-
-def find_band_name(band: FrequencyBand) -> str:
-    """return the default band name (CBAND, LBAND, ...) that corresponds to the band frequency range
-    Use the band center frequency: if center frequency is inside the band then returns CBAND.
-    This is to flexibly encompass all kind of bands definitions.
-    returns the first matching band name.
-    """
-    for band_name, frequency_range in DEFAULT_BANDS_DEFINITION.items():
-        center_frequency = (band.f_min + band.f_max) / 2
-        if center_frequency >= frequency_range.f_min and center_frequency <= frequency_range.f_max:
-            return band_name
-    return 'unknown_band'

gnpy/core/service_sheet.py

@@ -0,0 +1,268 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+gnpy.core.service_sheet
+========================
+
+XLS parser that can be called to create a JSON request file in accordance with
+Yang model for requesting path computation.
+
+See: draft-ietf-teas-yang-path-computation-01.txt
+"""
+
+from sys import exit
+try:
+    from xlrd import open_workbook, XL_CELL_EMPTY
+except ModuleNotFoundError:
+    exit('Required: `pip install xlrd`')
+from collections import namedtuple
+from logging import getLogger, basicConfig, CRITICAL, DEBUG, INFO
+from json import dumps
+from pathlib import Path
+from gnpy.core.equipment import load_equipment
+from gnpy.core.utils import db2lin, lin2db
+from gnpy.core.exceptions import ServiceError
+
+SERVICES_COLUMN = 12
+#EQPT_LIBRARY_FILENAME = Path(__file__).parent / 'eqpt_config.json'
+
+all_rows = lambda sheet, start=0: (sheet.row(x) for x in range(start, sheet.nrows))
+logger = getLogger(__name__)
+
+# Type for input data
+class Request(namedtuple('Request', 'request_id source destination trx_type mode \
+    spacing power nb_channel disjoint_from nodes_list is_loose path_bandwidth')):
+    def __new__(cls, request_id, source, destination, trx_type,  mode=None , spacing= None , power = None, nb_channel = None , disjoint_from ='' ,  nodes_list = None, is_loose = '', path_bandwidth = None):
+        return super().__new__(cls, request_id, source, destination, trx_type, mode, spacing, power, nb_channel, disjoint_from,  nodes_list, is_loose, path_bandwidth)
+
+# Type for output data:  // from dutc
+class Element:
+    def __eq__(self, other):
+        return type(self) == type(other) and self.uid == other.uid
+    def __hash__(self):
+        return hash((type(self), self.uid))
+
+class Request_element(Element):
+    def __init__(self, Request, eqpt_filename, bidir):
+        # request_id is str
+        # excel has automatic number formatting that adds .0 on integer values
+        # the next lines recover the pure int value, assuming this .0 is unwanted
+        self.request_id = correct_xlrd_int_to_str_reading(Request.request_id)
+        self.source = f'trx {Request.source}'
+        self.destination = f'trx {Request.destination}'
+        # TODO: the automatic naming generated by excel parser requires that source and dest name 
+        # be a string starting with 'trx' : this is manually added here.
+        self.srctpid = f'trx {Request.source}'
+        self.dsttpid = f'trx {Request.destination}'
+        self.bidir = bidir
+        # test that trx_type belongs to eqpt_config.json
+        # if not replace it with a default
+        equipment = load_equipment(eqpt_filename)
+        try :
+            if equipment['Transceiver'][Request.trx_type]:
+                self.trx_type = correct_xlrd_int_to_str_reading(Request.trx_type)
+            if Request.mode is not None :
+                Requestmode = correct_xlrd_int_to_str_reading(Request.mode)
+                if [mode for mode in equipment['Transceiver'][Request.trx_type].mode if mode['format'] == Requestmode]:
+                    self.mode = Requestmode
+                else : 
+                    msg = f'Request Id: {self.request_id} - could not find tsp : \'{Request.trx_type}\' with mode: \'{Requestmode}\' in eqpt library \nComputation stopped.'
+                    #print(msg)
+                    logger.critical(msg)
+                    exit(1)
+            else:
+                Requestmode = None
+                self.mode = Request.mode
+        except KeyError:
+            msg = f'Request Id: {self.request_id} - could not find tsp : \'{Request.trx_type}\' with mode: \'{Request.mode}\' in eqpt library \nComputation stopped.'
+            #print(msg)
+            logger.critical(msg)
+            raise ServiceError(msg)
+        # excel input are in GHz and dBm
+        if Request.spacing is not None:
+            self.spacing = Request.spacing * 1e9
+        else:
+            msg = f'Request {self.request_id} missing spacing: spacing is mandatory.\ncomputation stopped'
+            logger.critical(msg)
+            raise ServiceError(msg)
+        if Request.power is not None:
+            self.power =  db2lin(Request.power) * 1e-3
+        else:
+            self.power = None
+        if Request.nb_channel is not None :
+            self.nb_channel = int(Request.nb_channel)
+        else:
+            self.nb_channel = None
+        
+        value = correct_xlrd_int_to_str_reading(Request.disjoint_from)
+        self.disjoint_from = [n for n in value.split(' | ') if value]
+        self.nodes_list = []
+        if Request.nodes_list :
+            self.nodes_list = Request.nodes_list.split(' | ')
+
+        # cleaning the list of nodes to remove source and destination
+        # (because the remaining of the program assumes that the nodes list are nodes 
+        # on the path and should not include source and destination)
+        try :
+            self.nodes_list.remove(self.source)
+            msg = f'{self.source} removed from explicit path node-list'
+            logger.info(msg)
+        except ValueError:
+            msg = f'{self.source} already removed from explicit path node-list'
+            logger.info(msg)
+
+        try :
+            self.nodes_list.remove(self.destination)
+            msg = f'{self.destination} removed from explicit path node-list'
+            logger.info(msg)
+        except ValueError:
+            msg = f'{self.destination} already removed from explicit path node-list'
+            logger.info(msg)
+
+        # the excel parser applies the same hop-type to all nodes in the route nodes_list.
+        # user can change this per node in the generated json
+        self.loose = 'LOOSE'
+        if Request.is_loose == 'no' :
+            self.loose = 'STRICT'
+        self.path_bandwidth = None
+        if Request.path_bandwidth is not None:
+            self.path_bandwidth = Request.path_bandwidth * 1e9
+        else:
+            self.path_bandwidth = 0
+
+    uid = property(lambda self: repr(self))
+    @property
+    def pathrequest(self):
+        # Default assumption for bidir is False
+        req_dictionnary = {
+                    'request-id':self.request_id,
+                    'source':    self.source,
+                    'destination':  self.destination,
+                    'src-tp-id': self.srctpid,
+                    'dst-tp-id': self.dsttpid,
+                    'bidirectional': self.bidir,
+                    'path-constraints':{
+                        'te-bandwidth': {
+                            'technology': 'flexi-grid',
+                            'trx_type'  : self.trx_type,
+                            'trx_mode'  : self.mode,
+                            'effective-freq-slot':[{'N': 'null', 'M': 'null'}],
+                            'spacing'   : self.spacing,
+                            'max-nb-of-channel'  : self.nb_channel,
+                            'output-power'       : self.power
+                        }
+                    }
+                }
+
+        if self.nodes_list:
+            req_dictionnary['explicit-route-objects'] = {}
+            temp = {'route-object-include-exclude' : [
+                        {'explicit-route-usage': 'route-include-ero',
+                        'index': self.nodes_list.index(node),
+                        'num-unnum-hop': {
+                            'node-id': f'{node}',
+                            'link-tp-id': 'link-tp-id is not used',
+                            'hop-type': f'{self.loose}',
+                            }
+                        }
+                        for node in self.nodes_list]
+                   }
+            req_dictionnary['explicit-route-objects'] = temp
+        if self.path_bandwidth is not None:
+            req_dictionnary['path-constraints']['te-bandwidth']['path_bandwidth'] = self.path_bandwidth
+            
+        return req_dictionnary
+    @property
+    def pathsync(self):
+        if self.disjoint_from :
+            return {'synchronization-id':self.request_id,
+                'svec': {
+                    'relaxable' : 'false',
+                    'disjointness': 'node link',
+                    'request-id-number': [self.request_id]+ [n for n in self.disjoint_from]
+                }
+            }
+        else:
+            return None
+        # TO-DO: avoid multiple entries with same synchronisation vectors
+    @property
+    def json(self):
+        return self.pathrequest , self.pathsync
+
+def convert_service_sheet(input_filename, eqpt_filename, output_filename='', bidir=False, filter_region=None):
+    """ converts a service sheet into a json structure
+    """
+    if filter_region is None:
+        filter_region = []
+    service = parse_excel(input_filename)
+    req = [Request_element(n, eqpt_filename, bidir) for n in service]
+    # dumps the output into a json file with name
+    # split_filename = [input_filename[0:len(input_filename)-len(suffix_filename)] , suffix_filename[1:]]
+    if output_filename=='':
+        output_filename = f'{str(input_filename)[0:len(str(input_filename))-len(str(input_filename.suffixes[0]))]}_services.json'
+    # for debug
+    # print(json_filename)
+    # if there is no sync vector , do not write any synchronization
+    synchro = [n.json[1] for n in req if n.json[1] is not None]
+    if synchro:
+        data = {
+            'path-request': [n.json[0] for n in req],
+            'synchronization': synchro
+        }
+    else:
+        data = {
+            'path-request': [n.json[0] for n in req]
+            }
+    with open(output_filename, 'w', encoding='utf-8') as f:
+        f.write(dumps(data, indent=2, ensure_ascii=False))
+    return data
+
+def correct_xlrd_int_to_str_reading(v) :
+    if not isinstance(v,str):
+        value = str(int(v))
+        if value.endswith('.0'):
+            value = value[:-2]
+    else:
+        value = v
+    return value
+
+# to be used from dutc
+def parse_row(row, fieldnames):
+    return {f: r.value for f, r in zip(fieldnames, row[0:SERVICES_COLUMN])
+            if r.ctype != XL_CELL_EMPTY}
+#
+
+def parse_excel(input_filename):
+    with open_workbook(input_filename) as wb:
+        service_sheet = wb.sheet_by_name('Service')
+        services = list(parse_service_sheet(service_sheet))
+    return services
+
+def parse_service_sheet(service_sheet):
+    """ reads each column according to authorized fieldnames. order is not important.
+    """
+    logger.info(f'Validating headers on {service_sheet.name!r}')
+    # add a test on field to enable the '' field case that arises when columns on the
+    # right hand side are used as comments or drawing in the excel sheet
+    header = [x.value.strip() for x in service_sheet.row(4)[0:SERVICES_COLUMN]
+                if len(x.value.strip()) > 0]
+
+    # create a service_fieldname independant from the excel column order
+    # to be compatible with any version of the sheet
+    # the following dictionnary records the excel field names and the corresponding parameter's name
+
+    authorized_fieldnames = {
+        'route id':'request_id', 'Source':'source', 'Destination':'destination', \
+        'TRX type':'trx_type', 'Mode' : 'mode', 'System: spacing':'spacing', \
+        'System: input power (dBm)':'power', 'System: nb of channels':'nb_channel',\
+        'routing: disjoint from': 'disjoint_from', 'routing: path':'nodes_list',\
+        'routing: is loose?':'is_loose', 'path bandwidth':'path_bandwidth'}
+    try:
+        service_fieldnames = [authorized_fieldnames[e] for e in header]
+    except KeyError:
+        msg = f'Malformed header on Service sheet: {header} field not in {authorized_fieldnames}'
+        logger.critical(msg)
+        raise ValueError(msg)
+    for row in all_rows(service_sheet, start=5):
+        yield Request(**parse_row(row[0:SERVICES_COLUMN], service_fieldnames))

gnpy/core/spectrum_assignment.py

@@ -0,0 +1,403 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+gnpy.core.spectrum_assignment
+=============================
+
+This module contains the Oms and Bitmap classes and the different method to
+select and assign spectrum. Spectrum_selection function identifies the free
+slots and select_candidate selects the candidate spectrum according to
+strategy: for example first fit
+oms records its elements, and elements are updated with an oms to have
+element/oms correspondace
+"""
+
+from collections import namedtuple
+from logging import getLogger
+from math import ceil
+from gnpy.core.elements import Roadm, Transceiver
+from gnpy.core.exceptions import SpectrumError
+
+LOGGER = getLogger(__name__)
+
+class Bitmap:
+    """ records the spectrum occupation
+    """
+    def __init__(self, f_min, f_max, grid, guardband=0.15e12, bitmap=None):
+        # n is the min index including guardband. Guardband is require to be sure
+        # that a channel can be assigned  with center frequency fmin (means that its
+        # slot occupation goes below freq_index_min
+        n_min = frequency_to_n(f_min-guardband, grid)
+        n_max = frequency_to_n(f_max+guardband, grid) - 1
+        self.n_min = n_min
+        self.n_max = n_max
+        self.freq_index_min = frequency_to_n(f_min)
+        self.freq_index_max = frequency_to_n(f_max)
+        self.freq_index = list(range(n_min, n_max+1))
+        if bitmap is None:
+            self.bitmap = [1] * (n_max-n_min+1)
+        else:
+            if len(bitmap) == len(self.freq_index):
+                self.bitmap = bitmap
+            else:
+                msg = f'bitmap is not consistant with f_min{f_min} - n :' +\
+                      f'{n_min} and f_max{f_max}- n :{n_max}'
+                LOGGER.critical(msg)
+                raise SpectrumError(msg)
+
+    def getn(self, i):
+        """ converts the n (itu grid) into a local index
+        """
+        return self.freq_index[i]
+    def geti(self, nvalue):
+        """ converts the local index into n (itu grid)
+        """
+        return self.freq_index.index(nvalue)
+    def insert_left(self, newbitmap):
+        """ insert bitmap on the left to align oms bitmaps if their start frequencies are different
+        """
+        self.bitmap = newbitmap + self.bitmap
+        temp = list(range(self.n_min-len(newbitmap), self.n_min))
+        self.freq_index = temp + self.freq_index
+        self.n_min = self.freq_index[0]
+    def insert_right(self, newbitmap):
+        """ insert bitmap on the right to align oms bitmaps if their stop frequencies are different
+        """
+        self.bitmap = self.bitmap + newbitmap
+        self.freq_index = self.freq_index + list(range(self.n_max, self.n_max+len(newbitmap)))
+        self.n_max = self.freq_index[-1]
+
+#    +'grid available_slots f_min f_max services_list')
+OMSParams = namedtuple('OMSParams', 'oms_id el_id_list el_list')
+
+class OMS:
+    """ OMS class is the logical container that represent a link betwoeen two adjacent ROADMs and
+        records the crossed elements and the occupied spectrum
+    """
+    def __init__(self, *args, **params):
+        params = OMSParams(**params)
+        self.oms_id = params.oms_id
+        self.el_id_list = params.el_id_list
+        self.el_list = params.el_list
+        self.spectrum_bitmap = []
+        self.nb_channels = 0
+        self.service_list = []
+    # TODO
+    def __str__(self):
+        return '\n\t'.join([f'{type(self).__name__} {self.oms_id}',
+                               f'{self.el_id_list[0]} - {self.el_id_list[-1]}'])
+    def __repr__(self):
+        return '\n\t'.join([f'{type(self).__name__} {self.oms_id}',
+                               f'{self.el_id_list[0]} - {self.el_id_list[-1]}', '\n'])
+
+    def add_element(self, elem):
+        """ records oms elements
+        """
+        self.el_id_list.append(elem.uid)
+        self.el_list.append(elem)
+
+    def update_spectrum(self, f_min, f_max, guardband=0.15e12, existing_spectrum=None,
+                        grid=0.00625e12):
+        """ frequencies expressed in Hz
+        """
+        if existing_spectrum is None:
+            # add some 150 GHz margin to eable a center channel on f_min
+            # use ITU-T G694.1
+            # Flexible DWDM grid definition
+            # For the flexible DWDM grid, the allowed frequency slots have a nominal
+            # central frequency (in THz) defined by:
+            # 193.1 + n × 0.00625 where n is a positive or negative integer including 0
+            # and 0.00625 is the nominal central frequency granularity in THz
+            # and a slot width defined by:
+            # 12.5 × m where m is a positive integer and 12.5 is the slot width granularity in
+            # GHz.
+            # Any combination of frequency slots is allowed as long as no two frequency
+            # slots overlap.
+
+            # TODO : add explaination on that / parametrize ....
+            self.spectrum_bitmap = Bitmap(f_min, f_max, grid, guardband)
+            # print(len(self.spectrum_bitmap.bitmap))
+
+    def assign_spectrum(self, nvalue, mvalue):
+        """ change oms spectrum to mark spectrum assigned
+        """
+        # print("assign_spectrum")
+        # print(f'n , m :{n},{m}')
+        if (nvalue is None or mvalue is None or isinstance(nvalue, float)
+                or isinstance(mvalue, float) or mvalue == 0):
+            msg = f'could not assign None values'
+            LOGGER.critical(msg)
+            raise SpectrumError(msg)
+        startn, stopn = mvalue_to_slots(nvalue, mvalue)
+        # print(f'startn stop n {startn} , {stopn}')
+        # assumes that guardbands are sufficient to ensure that assigning a center channel
+        # at fmin or fmax is OK is startn > self.spectrum_bitmap.n_min
+        if (nvalue <= self.spectrum_bitmap.freq_index_max and
+                nvalue >= self.spectrum_bitmap.freq_index_min and
+                stopn <= self.spectrum_bitmap.n_max and
+                startn > self.spectrum_bitmap.n_min):
+            # verification that both length are identical
+            self.spectrum_bitmap.bitmap[self.spectrum_bitmap.geti(startn):self.spectrum_bitmap.geti(stopn)+1] = [0] * (stopn-startn+1)
+            return True
+        else:
+            msg = f'Could not assign n {nvalue}, m {mvalue} values:' +\
+                  f' one or several slots are not available'
+            LOGGER.info(msg)
+            return False
+
+    def add_service(self, service_id, nb_wl):
+        """ record service and mark spectrum as occupied
+        """
+        self.service_list.append(service_id)
+        self.nb_channels += nb_wl
+
+def frequency_to_n(freq, grid=0.00625e12):
+    """ converts frequency into the n value (ITU grid)
+    """
+    return (int)((freq-193.1e12)/grid)
+
+def nvalue_to_frequency(nvalue, grid=0.00625e12):
+    """ converts n value into a frequency
+    """
+    return 193.1e12 + nvalue * grid
+
+def mvalue_to_slots(nvalue, mvalue):
+    """ convert center n an m into start and stop n
+    """
+    startn = nvalue - mvalue
+    stopn = nvalue + mvalue -1
+    return startn, stopn
+
+def slots_to_m(startn, stopn):
+    """ converts the start and stop n values to the center n and m value
+    """
+    nvalue = (int)((startn+stopn+1)/2)
+    mvalue = (int)((stopn-startn+1)/2)
+    return nvalue, mvalue
+
+def m_to_freq(nvalue, mvalue, grid=0.00625e12):
+    """ converts m into frequency range
+    """
+    startn, stopn = mvalue_to_slots(nvalue, mvalue)
+    fstart = nvalue_to_frequency(startn, grid)
+    fstop = nvalue_to_frequency(stopn+1, grid)
+    return fstart, fstop
+
+def align_grids(oms_list):
+    """ used to apply same grid to all oms : same starting n, stop n and slot size
+        out of grid slots are set to 0
+    """
+    n_min = min([o.spectrum_bitmap.n_min for o in oms_list])
+    n_max = max([o.spectrum_bitmap.n_max for o in oms_list])
+    for this_o in oms_list:
+        if (this_o.spectrum_bitmap.n_min - n_min) > 0:
+            this_o.spectrum_bitmap.insert_left([0] * (this_o.spectrum_bitmap.n_min - n_min))
+        if (n_max - this_o.spectrum_bitmap.n_max) > 0:
+            this_o.spectrum_bitmap.insert_right([0] * (n_max - this_o.spectrum_bitmap.n_max))
+    return oms_list
+
+def build_oms_list(network, equipment):
+    """ initialization of OMS list in the network
+        an oms is build reading all intermediate nodes between two adjacent ROADMs
+        each element within the list is being added an oms and oms_id to record the
+        oms it belongs to.
+        the function supports different spectrum width and supposes that the whole network
+        works with the min range among OMSs
+    """
+    oms_id = 0
+    oms_list = []
+    for node in [n for n in network.nodes() if isinstance(n, Roadm)]:
+        for edge in network.edges([node]):
+            if not isinstance(edge[1], Transceiver):
+                nd_in = edge[0] # nd_in is a Roadm
+                try:
+                    nd_in.oms_list.append(oms_id)
+                except AttributeError:
+                    nd_in.oms_list = []
+                    nd_in.oms_list.append(oms_id)
+                nd_out = edge[1]
+
+                params = {}
+                params['oms_id'] = oms_id
+                params['el_id_list'] = []
+                params['el_list'] = []
+                oms = OMS(**params)
+                oms.add_element(nd_in)
+                while not isinstance(nd_out, Roadm):
+                    oms.add_element(nd_out)
+                    # add an oms_id in the element
+                    nd_out.oms_id = oms_id
+                    nd_out.oms = oms
+                    n_temp = nd_out
+                    nd_out = next(n[1] for n in network.edges([n_temp]) if n[1].uid != nd_in.uid)
+                    nd_in = n_temp
+
+                oms.add_element(nd_out)
+                # nd_out is a Roadm
+                try:
+                    nd_out.oms_list.append(oms_id)
+                except AttributeError:
+                    nd_out.oms_list = []
+                    nd_out.oms_list.append(oms_id)
+
+                # print(f'coucou2 {oms.oms_id} {oms.el_id_list[0]} {oms.el_id_list[-1]}')
+                # for e in oms.el_id_list:
+                #     print(f' {e}')
+
+                # TODO do not forget to correct next line !
+                # to test different grids
+                # TODO move this to test
+                if oms_id < 3:
+                    oms.update_spectrum(equipment['SI']['default'].f_min,
+                                        equipment['SI']['default'].f_max, grid=0.00625e12)
+                else:
+                    oms.update_spectrum(equipment['SI']['default'].f_min,
+                                        equipment['SI']['default'].f_max, grid=0.00625e12)
+                # oms.assign_spectrum(13,7) gives back (193137500000000.0, 193225000000000.0)
+                # as in the example in the standard
+                # oms.assign_spectrum(13,7)
+
+                oms_list.append(oms)
+                oms_id += 1
+    oms_list = align_grids(oms_list)
+    reversed_oms(oms_list)
+    return oms_list
+
+def reversed_oms(oms_list):
+    """ identifies reversed OMS
+        only applicable for non parallel OMS
+    """
+    for oms in oms_list:
+        has_reversed = False
+        for this_o in oms_list:
+            if (oms.el_id_list[0] == this_o.el_id_list[-1] and
+                    oms.el_id_list[-1] == this_o.el_id_list[0]):
+                oms.reversed_oms = this_o
+                has_reversed = True
+                break
+        if not has_reversed:
+            oms.reversed_oms = None
+
+
+def bitmap_sum(band1, band2):
+    """ a functions that marks occupied bitmap by 0 if the slot is occupied in band1 or in band2
+    """
+    res = []
+    for i, elem in enumerate(band1):
+        if band2[i] * elem == 0:
+            res.append(0)
+        else:
+            res.append(1)
+    return res
+
+def spectrum_selection(pth, oms_list, requested_m, requested_n=None):
+    """ collects spectrum availability and call the select_candidate function
+    # step 1 collects pth spectrum availability
+    # step 2 if n is not None try to assign the spectrum
+    #            if the spectrum is not available then sends back an "error"
+    #        if n is None selects candidate spectrum
+    #            select spectrum that fits the policy ( first fit, random, ABP...)
+    # step3 returns the selection
+    """
+
+    # use indexes instead of ITU-T n values
+    path_oms = []
+    for elem in pth:
+        if not isinstance(elem, Roadm) and not isinstance(elem, Transceiver):
+            # only edfa, fused and fibers have oms_id attribute
+            path_oms.append(elem.oms_id)
+    # remove duplicate oms_id, order is not important
+    path_oms = list(set(path_oms))
+    # assuming all oms have same freq index
+    if not path_oms:
+        candidate = (None, None, None)
+        return candidate, path_oms
+    freq_index = oms_list[path_oms[0]].spectrum_bitmap.freq_index
+    freq_index_min = oms_list[path_oms[0]].spectrum_bitmap.freq_index_min
+    freq_index_max = oms_list[path_oms[0]].spectrum_bitmap.freq_index_max
+
+    freq_availability = oms_list[path_oms[0]].spectrum_bitmap.bitmap
+    for oms in path_oms[1:]:
+        freq_availability = bitmap_sum(oms_list[oms].spectrum_bitmap.bitmap, freq_availability)
+    if requested_n is None:
+        # avoid slots reserved on the edge 0.15e-12 on both sides -> 24
+        candidates = [(freq_index[i]+requested_m, freq_index[i], freq_index[i]+2*requested_m-1)
+                      for i in range(len(freq_availability))
+                      if freq_availability[i:i+2*requested_m] == [1] * (2*requested_m)
+                      and freq_index[i] >= freq_index_min
+                      and freq_index[i+2*requested_m-1] <= freq_index_max]
+
+        candidate = select_candidate(candidates, policy='first_fit')
+    else:
+        i = oms_list[path_oms[0]].spectrum_bitmap.geti(requested_n)
+        # print(f'N {requested_n} i {i}')
+        # print(freq_availability[i-m:i+m] )
+        # print(freq_index[i-m:i+m])
+        if (freq_availability[i-requested_m:i+requested_m] == [1] * (2*requested_m) and
+                freq_index[i-requested_m] >= freq_index_min
+                      and freq_index[i+requested_m-1] <= freq_index_max):
+            # candidate is the triplet center_n, startn and stopn
+            candidate = (requested_n, requested_n-requested_m, requested_n+requested_m-1)
+        else:
+            candidate = (None, None, None)
+        # print("coucou11")
+        # print(candidate)
+    # print(freq_availability[321:321+2*m])
+    # a = [i+321 for i in range(2*m)]
+    # print(a)
+    # print(candidate)
+    return candidate, path_oms
+
+def select_candidate(candidates, policy):
+    """ selects a candidate among all available spectrum
+    """
+    if policy == 'first_fit':
+        if candidates:
+            return candidates[0]
+        else:
+            return (None, None, None)
+
+def pth_assign_spectrum(pths, rqs, oms_list, rpths):
+    """ basic first fit assignment
+        if reversed path are provided, means that occupation is bidir
+    """
+    for i, pth in enumerate(pths):
+        # computes the number of channels required
+        try:
+            if rqs[i].blocking_reason:
+                rqs[i].blocked = True
+                rqs[i].N = 0
+                rqs[i].M = 0
+        except AttributeError:
+            nb_wl = ceil(rqs[i].path_bandwidth / rqs[i].bit_rate)
+            # computes the total nb of slots according to requested spacing
+            # todo : express superchannels
+            # assumes that all channels must be grouped
+            # todo : enables non contiguous reservation in case of blocking
+            requested_m = ceil(rqs[i].spacing / 0.0125e12) * nb_wl
+            # concatenate all path and reversed path elements to derive slots availability
+            (center_n, startn, stopn), path_oms = spectrum_selection(pth + rpths[i], oms_list, requested_m,
+                                                                     requested_n=None)
+            # checks that requested_m is fitting startm and stopm
+            # if not None, center_n and start, stop frequencies are applicable to all oms of pth
+            # checks that spectrum is not None else indicate blocking reason
+            if center_n is not None:
+                # checks that requested_m is fitting startm and stopm
+                if 2 * requested_m > (stopn - startn + 1):
+                    msg = f'candidate: {(center_n, startn, stopn)} is not consistant ' +\
+                          f'with {requested_m}'
+                    LOGGER.critical(msg)
+                    raise ValueError(msg)
+
+                for oms_elem in path_oms:
+                    oms_list[oms_elem].assign_spectrum(center_n, requested_m)
+                    oms_list[oms_elem].add_service(rqs[i].request_id, nb_wl)
+                rqs[i].blocked = False
+                rqs[i].N = center_n
+                rqs[i].M = requested_m
+            else:
+                rqs[i].blocked = True
+                rqs[i].N = 0
+                rqs[i].M = 0
+                rqs[i].blocking_reason = 'NO_SPECTRUM'

gnpy/core/units.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+UNITS = {'m': 1,
+         'km': 1E3}

gnpy/core/utils.py

@@ -1,33 +1,38 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# SPDX-License-Identifier: BSD-3-Clause
-# gnpy.core.utils: utility functions that are used with gnpy
-# Copyright (C) 2025 Telecom Infra Project and GNPy contributors
-# see AUTHORS.rst for a list of contributors
-
-"""
+'''
 gnpy.core.utils
 ===============
 
 This module contains utility functions that are used with gnpy.
-"""
+'''
+
+
+import json
 
 from csv import writer
-from numpy import pi, cos, sqrt, log10, linspace, zeros, shape, where, logical_and, mean, array
+import numpy as np
+from numpy import pi, cos, sqrt, log10
 from scipy import constants
-from copy import deepcopy
-from typing import List, Union, Dict
 
-from gnpy.core.exceptions import ConfigurationError
 
+def load_json(filename):
+    with open(filename, 'r', encoding='utf-8') as f:
+        data = json.load(f)
+    return data
+
+
+def save_json(obj, filename):
+    with open(filename, 'w', encoding='utf-8') as f:
+        json.dump(obj, f, indent=2, ensure_ascii=False)
 
 def write_csv(obj, filename):
     """
-    Convert dictionary items to a CSV file the dictionary format:
-    ::
+    convert dictionary items to a csv file
+    the dictionary format :
 
-        {'result category 1':
+    {'result category 1':
                         [
                         # 1st line of results
                         {'header 1' : value_xxx,
@@ -36,176 +41,83 @@ def write_csv(obj, filename):
                         {'header 1' : value_www,
                          'header 2' : value_zzz}
                         ],
-        'result_category 2':
+    'result_category 2':
                         [
                         {},{}
                         ]
-        }
+    }
 
-    The generated csv file will be:
-    ::
-
-        result_category 1
-        header 1    header 2
-        value_xxx   value_yyy
-        value_www   value_zzz
-        result_category 2
-        ...
+    the generated csv file will be:
+    result_category 1
+    header 1    header 2
+    value_xxx   value_yyy
+    value_www   value_zzz
+    result_category 2
+    ...
     """
     with open(filename, 'w', encoding='utf-8') as f:
         w = writer(f)
         for data_key, data_list in obj.items():
-            # main header
+            #main header
             w.writerow([data_key])
-            # sub headers:
+            #sub headers:
             headers = [_ for _ in data_list[0].keys()]
             w.writerow(headers)
             for data_dict in data_list:
                 w.writerow([_ for _ in data_dict.values()])
 
+def c():
+    """
+    Returns the speed of light in meters per second
+    """
+    return constants.c
 
-def arrange_frequencies(length, start, stop):
-    """Create an array of frequencies
 
-    :param length: number of elements
-    :param start: Start frequency in THz
-    :param stop: Stop frequency in THz
-    :type length: integer
-    :type start: float
-    :type stop: float
-    :return: an array of frequencies determined by the spacing parameter
+def itufs(spacing, startf=191.35, stopf=196.10):
+    """Creates an array of frequencies whose default range is
+    191.35-196.10 THz
+
+    :param spacing: Frequency spacing in THz
+    :param starf: Start frequency in THz
+    :param stopf: Stop frequency in THz
+    :type spacing: float
+    :type startf: float
+    :type stopf: float
+    :return an array of frequnecies determined by the spacing parameter
     :rtype: numpy.ndarray
     """
-    return linspace(start, stop, length)
+    return np.arange(startf, stopf + spacing / 2, spacing)
+
+def itufl(length, startf=191.35, stopf=196.10):
+    """Creates an array of frequencies whose default range is
+    191.35-196.10 THz
+
+    :param length: number of elements
+    :param starf: Start frequency in THz
+    :param stopf: Stop frequency in THz
+    :type length: integer
+    :type startf: float
+    :type stopf: float
+    :return an array of frequnecies determined by the spacing parameter
+    :rtype: numpy.ndarray
+    """
+    return np.linspace(startf, stopf, length)
+
+def h():
+    """
+    Returns plank's constant in J*s
+    """
+    return constants.h
 
 
 def lin2db(value):
-    """Convert linear unit to logarithmic (dB)
-
-    >>> lin2db(0.001)
-    -30.0
-    >>> round(lin2db(1.0), 2)
-    0.0
-    >>> round(lin2db(1.26), 2)
-    1.0
-    >>> round(lin2db(10.0), 2)
-    10.0
-    >>> round(lin2db(100.0), 2)
-    20.0
-    """
     return 10 * log10(value)
 
 
 def db2lin(value):
-    """Convert logarithimic units to linear
-
-    >>> round(db2lin(10.0), 2)
-    10.0
-    >>> round(db2lin(20.0), 2)
-    100.0
-    >>> round(db2lin(1.0), 2)
-    1.26
-    >>> round(db2lin(0.0), 2)
-    1.0
-    >>> round(db2lin(-10.0), 2)
-    0.1
-    """
     return 10**(value / 10)
 
-
-def watt2dbm(value):
-    """Convert Watt units to dBm
-
-    >>> round(watt2dbm(0.001), 1)
-    0.0
-    >>> round(watt2dbm(0.02), 1)
-    13.0
-    """
-    return lin2db(value * 1e3)
-
-
-def dbm2watt(value):
-    """Convert dBm units to Watt
-
-    >>> round(dbm2watt(0), 4)
-    0.001
-    >>> round(dbm2watt(-3), 4)
-    0.0005
-    >>> round(dbm2watt(13), 4)
-    0.02
-    """
-    return db2lin(value) * 1e-3
-
-
-def psd2powerdbm(psd_mwperghz, baudrate_baud):
-    """computes power in dBm based on baudrate in bauds and psd in mW/GHz
-
-    >>> round(psd2powerdbm(0.031176, 64e9),3)
-    3.0
-    >>> round(psd2powerdbm(0.062352, 32e9),3)
-    3.0
-    >>> round(psd2powerdbm(0.015625, 64e9),3)
-    0.0
-    """
-    return lin2db(baudrate_baud * psd_mwperghz * 1e-9)
-
-
-def power_dbm_to_psd_mw_ghz(power_dbm, baudrate_baud):
-    """computes power spectral density in  mW/GHz based on baudrate in bauds and power in dBm
-
-    >>> power_dbm_to_psd_mw_ghz(0, 64e9)
-    0.015625
-    >>> round(power_dbm_to_psd_mw_ghz(3, 64e9), 6)
-    0.031176
-    >>> round(power_dbm_to_psd_mw_ghz(3, 32e9), 6)
-    0.062352
-    """
-    return db2lin(power_dbm) / (baudrate_baud * 1e-9)
-
-
-def psd_mw_per_ghz(power_watt, baudrate_baud):
-    """computes power spectral density in  mW/GHz based on baudrate in bauds and power in W
-
-    >>> psd_mw_per_ghz(2e-3, 32e9)
-    0.0625
-    >>> psd_mw_per_ghz(1e-3, 64e9)
-    0.015625
-    >>> psd_mw_per_ghz(0.5e-3, 32e9)
-    0.015625
-    """
-    return power_watt * 1e3 / (baudrate_baud * 1e-9)
-
-
 def round2float(number, step):
-    """Round a floating point number so that its "resolution" is not bigger than 'step'
-
-    The finest step is fixed at 0.01; smaller values are silently changed to 0.01.
-
-    >>> round2float(123.456, 1000)
-    0.0
-    >>> round2float(123.456, 100)
-    100.0
-    >>> round2float(123.456, 10)
-    120.0
-    >>> round2float(123.456, 1)
-    123.0
-    >>> round2float(123.456, 0.1)
-    123.5
-    >>> round2float(123.456, 0.01)
-    123.46
-    >>> round2float(123.456, 0.001)
-    123.46
-    >>> round2float(123.249, 0.5)
-    123.0
-    >>> round2float(123.250, 0.5)
-    123.0
-    >>> round2float(123.251, 0.5)
-    123.5
-    >>> round2float(123.300, 0.2)
-    123.2
-    >>> round2float(123.301, 0.2)
-    123.4
-    """
     step = round(step, 1)
     if step >= 0.01:
         number = round(number / step, 0)
@@ -214,44 +126,21 @@ def round2float(number, step):
         number = round(number, 2)
     return number
 
-
 wavelength2freq = constants.lambda2nu
 freq2wavelength = constants.nu2lambda
 
+def freq2wavelength(value):
+    """ Converts frequency units to wavelength units.
+    """
+    return c() / value
 
 def snr_sum(snr, bw, snr_added, bw_added=12.5e9):
-    snr_added = snr_added - lin2db(bw / bw_added)
-    snr = -lin2db(db2lin(-snr) + db2lin(-snr_added))
+    snr_added = snr_added - lin2db(bw/bw_added)
+    snr = -lin2db(db2lin(-snr)+db2lin(-snr_added))
     return snr
 
-
-def per_label_average(values, labels):
-    """computes the average per defined spectrum band, using labels
-
-    >>> labels = ['A', 'A', 'A', 'A', 'A', 'B', 'B', 'B', 'B', 'B', 'B', 'B', 'B', 'C', 'D', 'D', 'D', 'D']
-    >>> values = [28.51, 28.23, 28.15, 28.17, 28.36, 28.53, 28.64, 28.68, 28.7, 28.71, 28.72, 28.73, 28.74, 28.91, 27.96, 27.85, 27.87, 28.02]
-    >>> per_label_average(values, labels)
-    {'A': 28.28, 'B': 28.68, 'C': 28.91, 'D': 27.92}
-    """
-
-    label_set = sorted(set(labels))
-    summary = {}
-    for label in label_set:
-        vals = [val for val, lab in zip(values, labels) if lab == label]
-        summary[label] = round(mean(vals), 2)
-    return summary
-
-
-def pretty_summary_print(summary):
-    """Build a prettty string that shows the summary dict values per label with 2 digits"""
-    if len(summary) == 1:
-        return f'{list(summary.values())[0]:.2f}'
-    text = ', '.join([f'{label}: {value:.2f}' for label, value in summary.items()])
-    return text
-
-
 def deltawl2deltaf(delta_wl, wavelength):
-    """deltawl2deltaf(delta_wl, wavelength):
+    """ deltawl2deltaf(delta_wl, wavelength):
     delta_wl is BW in wavelength units
     wavelength is the center wl
     units for delta_wl and wavelength must be same
@@ -269,9 +158,9 @@ def deltawl2deltaf(delta_wl, wavelength):
 
 
 def deltaf2deltawl(delta_f, frequency):
-    """convert delta frequency to delta wavelength
-
-    Units for delta_wl and wavelength must be same.
+    """ deltawl2deltaf(delta_f, frequency):
+        converts delta frequency to delta wavelength
+        units for delta_wl and wavelength must be same
 
     :param delta_f: delta frequency in same units as frequency
     :param frequency: frequency BW is relevant for
@@ -286,7 +175,8 @@ def deltaf2deltawl(delta_f, frequency):
 
 
 def rrc(ffs, baud_rate, alpha):
-    """compute the root-raised cosine filter function
+    """ rrc(ffs, baud_rate, alpha): computes the root-raised cosine filter
+    function.
 
     :param ffs: A numpy array of frequencies
     :param baud_rate: The Baud Rate of the System
@@ -301,18 +191,17 @@ def rrc(ffs, baud_rate, alpha):
     Ts = 1 / baud_rate
     l_lim = (1 - alpha) / (2 * Ts)
     r_lim = (1 + alpha) / (2 * Ts)
-    hf = zeros(shape(ffs))
-    slope_inds = where(
-        logical_and(abs(ffs) > l_lim, abs(ffs) < r_lim))
+    hf = np.zeros(np.shape(ffs))
+    slope_inds = np.where(
+        np.logical_and(np.abs(ffs) > l_lim, np.abs(ffs) < r_lim))
     hf[slope_inds] = 0.5 * (1 + cos((pi * Ts / alpha) *
-                                    (abs(ffs[slope_inds]) - l_lim)))
-    p_inds = where(logical_and(abs(ffs) > 0, abs(ffs) < l_lim))
+                                    (np.abs(ffs[slope_inds]) - l_lim)))
+    p_inds = np.where(np.logical_and(np.abs(ffs) > 0, np.abs(ffs) < l_lim))
     hf[p_inds] = 1
     return sqrt(hf)
 
-
 def merge_amplifier_restrictions(dict1, dict2):
-    """Update contents of dicts recursively
+    """Updates contents of dicts recursively
 
     >>> d1 = {'params': {'restrictions': {'preamp_variety_list': [], 'booster_variety_list': []}}}
     >>> d2 = {'params': {'target_pch_out_db': -20}}
@@ -333,36 +222,6 @@ def merge_amplifier_restrictions(dict1, dict2):
             copy_dict1[key] = dict2[key]
     return copy_dict1
 
-
-def use_pmd_coef(dict1: dict, dict2: dict):
-    """If Fiber dict1 is missing the pmd_coef value then use the one of dict2.
-    In addition records in "pmd_coef_defined" key the pmd_coef if is was defined in dict1.
-
-    :param dict1: A dictionnary that contains "pmd_coef" key.
-    :type dict1: dict
-    :param dict2: Another dictionnary that contains "pmd_coef" key.
-    :type dict2: dict
-
-    >>> dict1 = {'a': 1, 'pmd_coef': 1.5e-15}
-    >>> dict2 = {'a': 2, 'pmd_coef': 2e-15}
-    >>> use_pmd_coef(dict1, dict2)
-    >>> dict1
-    {'a': 1, 'pmd_coef': 1.5e-15, 'pmd_coef_defined': True}
-
-    >>> dict1 = {'a': 1}
-    >>> use_pmd_coef(dict1, dict2)
-    >>> dict1
-    {'a': 1, 'pmd_coef_defined': False, 'pmd_coef': 2e-15}
-    """
-    if 'pmd_coef' in dict1 and not dict1['pmd_coef'] \
-            or ('pmd_coef' not in dict1 and 'pmd_coef' in dict2):
-        dict1['pmd_coef_defined'] = False
-        dict1['pmd_coef'] = dict2['pmd_coef']
-    elif 'pmd_coef' in dict1 and dict1['pmd_coef']:
-        dict1['pmd_coef_defined'] = True
-    # all other case do not need any change
-
-
 def silent_remove(this_list, elem):
     """Remove matching elements from a list without raising ValueError
 
@@ -380,446 +239,3 @@ def silent_remove(this_list, elem):
     except ValueError:
         pass
     return this_list
-
-
-def automatic_nch(f_min, f_max, spacing):
-    """How many channels are available in the spectrum
-
-    :param f_min Lowest frequenecy [Hz]
-    :param f_max Highest frequency [Hz]
-    :param spacing Channel width [Hz]
-    :return Number of uniform channels
-
-    >>> automatic_nch(191.325e12, 196.125e12, 50e9)
-    96
-    >>> automatic_nch(193.475e12, 193.525e12, 50e9)
-    1
-    """
-    return int((f_max - f_min) // spacing)
-
-
-def automatic_fmax(f_min, spacing, nch):
-    """Find the high-frequenecy boundary of a spectrum
-
-    :param f_min Start of the spectrum (lowest frequency edge) [Hz]
-    :param spacing Grid/channel spacing [Hz]
-    :param nch Number of channels
-    :return End of the spectrum (highest frequency) [Hz]
-
-    >>> automatic_fmax(191.325e12, 50e9, 96)
-    196125000000000.0
-    """
-    return f_min + spacing * nch
-
-
-def convert_length(value, units):
-    """Convert length into basic SI units
-
-    >>> convert_length(1, 'km')
-    1000.0
-    >>> convert_length(2.0, 'km')
-    2000.0
-    >>> convert_length(123, 'm')
-    123.0
-    >>> convert_length(123.0, 'm')
-    123.0
-    >>> convert_length(42.1, 'km')
-    42100.0
-    >>> convert_length(666, 'yards')
-    Traceback (most recent call last):
-        ...
-    gnpy.core.exceptions.ConfigurationError: Cannot convert length in "yards" into meters
-    """
-    if units == 'm':
-        return value * 1e0
-    elif units == 'km':
-        return value * 1e3
-    else:
-        raise ConfigurationError(f'Cannot convert length in "{units}" into meters')
-
-
-def replace_none(dictionary):
-    """ Replaces None with inf values in a frequency slots dict
-
-    >>> replace_none({'N': 3, 'M': None})
-    {'N': 3, 'M': inf}
-
-    """
-    for key, val in dictionary.items():
-        if val is None:
-            dictionary[key] = float('inf')
-        if val == float('inf'):
-            dictionary[key] = None
-    return dictionary
-
-
-def order_slots(slots):
-    """ Order frequency slots from larger slots to smaller ones up to None
-
-    >>> l = [{'N': 3, 'M': None}, {'N': 2, 'M': 1}, {'N': None, 'M': None},{'N': 7, 'M': 2},{'N': None, 'M': 1} , {'N': None, 'M': 0}]
-    >>> order_slots(l)
-    ([7, 2, None, None, 3, None], [2, 1, 1, 0, None, None], [3, 1, 4, 5, 0, 2])
-    """
-    slots_list = deepcopy(slots)
-    slots_list = [replace_none(e) for e in slots_list]
-    for i, e in enumerate(slots_list):
-        e['i'] = i
-    slots_list = sorted(slots_list, key=lambda x: (-x['M'], x['N']) if x['M'] != float('inf') else (x['M'], x['N']))
-    slots_list = [replace_none(e) for e in slots_list]
-    return [e['N'] for e in slots_list], [e['M'] for e in slots_list], [e['i'] for e in slots_list]
-
-
-def restore_order(elements, order):
-    """ Use order to re-order the element of the list, and ignore None values
-
-    >>> restore_order([7, 2, None, None, 3, None], [3, 1, 4, 5, 0, 2])
-    [3, 2, 7]
-    """
-    return [elements[i[0]] for i in sorted(enumerate(order), key=lambda x:x[1]) if elements[i[0]] is not None]
-
-
-def unique_ordered(elements):
-    """
-    """
-    unique_elements = []
-    for element in elements:
-        if element not in unique_elements:
-            unique_elements.append(element)
-    return unique_elements
-
-
-def convert_empty_to_none(json_data: Union[list, dict]) -> dict:
-    """Convert all instances of "a": [None] into "a": None
-
-    :param json_data: the input data.
-    :type json_data: dict
-    :return: the converted data.
-    :rtype: dict
-
-    >>> json_data = {
-    ...     "uid": "[east edfa in Lannion",
-    ...     "type_variety": "multiband_booster",
-    ...     "metadata": {
-    ...         "location": {
-    ...             "latitude": 0.000000,
-    ...             "longitude": 0.000000,
-    ...             "city": "Zion",
-    ...             "region": ""
-    ...         }
-    ...     },
-    ...     "type": "Multiband_amplifier",
-    ...     "amplifiers": [{
-    ...             "type_variety": "multiband_booster_LOW_C",
-    ...             "operational": {
-    ...                 "gain_target": 12.22,
-    ...                 "delta_p": 4.19,
-    ...                 "out_voa": [None],
-    ...                 "tilt_target": 0.00,
-    ...                 "f_min": 191.3,
-    ...                 "f_max": 196.1
-    ...             }
-    ...         }, {
-    ...             "type_variety": "multiband_booster_LOW_L",
-    ...             "operational": {
-    ...                 "gain_target": 12.05,
-    ...                 "delta_p": 4.19,
-    ...                 "out_voa": [None],
-    ...                 "tilt_target": 0.00,
-    ...                 "f_min": 186.1,
-    ...                 "f_max": 190.9
-    ...             }
-    ...         }
-    ...     ]
-    ... }
-    >>> convert_empty_to_none(json_data)
-    {'uid': '[east edfa in Lannion', 'type_variety': 'multiband_booster', \
-'metadata': {'location': {'latitude': 0.0, 'longitude': 0.0, 'city': 'Zion', 'region': ''}}, \
-'type': 'Multiband_amplifier', 'amplifiers': [{'type_variety': 'multiband_booster_LOW_C', \
-'operational': {'gain_target': 12.22, 'delta_p': 4.19, 'out_voa': None, 'tilt_target': 0.0, \
-'f_min': 191.3, 'f_max': 196.1}}, {'type_variety': 'multiband_booster_LOW_L', \
-'operational': {'gain_target': 12.05, 'delta_p': 4.19, 'out_voa': None, 'tilt_target': 0.0, \
-'f_min': 186.1, 'f_max': 190.9}}]}
-
-    """
-    if isinstance(json_data, dict):
-        for key, value in json_data.items():
-            json_data[key] = convert_empty_to_none(value)
-    elif isinstance(json_data, list):
-        if len(json_data) == 1 and json_data[0] is None:
-            return None
-        for i, elem in enumerate(json_data):
-            json_data[i] = convert_empty_to_none(elem)
-    return json_data
-
-
-def convert_none_to_empty(json_data: Union[list, dict]) -> dict:
-    """Convert all instances of "a": None into "a": [None], to be compliant with RFC7951.
-
-    :param json_data: the input data.
-    :type json_data: dict
-    :return: the converted data.
-    :rtype: dict
-
-    >>> a = {'uid': '[east edfa in Lannion', 'type_variety': 'multiband_booster',
-    ... 'metadata': {'location': {'latitude': 0.0, 'longitude': 0.0, 'city': 'Zion', 'region': ''}},
-    ... 'type': 'Multiband_amplifier', 'amplifiers': [{'type_variety': 'multiband_booster_LOW_C',
-    ... 'operational': {'gain_target': 12.22, 'delta_p': 4.19, 'out_voa': None, 'tilt_target': 0.0,
-    ... 'f_min': 191.3, 'f_max': 196.1}}, {'type_variety': 'multiband_booster_LOW_L',
-    ... 'operational': {'gain_target': 12.05, 'delta_p': 4.19, 'out_voa': None, 'tilt_target': 0.0,
-    ... 'f_min': 186.1, 'f_max': 190.9}}]}
-    >>> convert_none_to_empty(a)
-    {'uid': '[east edfa in Lannion', 'type_variety': 'multiband_booster', \
-'metadata': {'location': {'latitude': 0.0, 'longitude': 0.0, 'city': 'Zion', 'region': ''}}, \
-'type': 'Multiband_amplifier', 'amplifiers': [{'type_variety': 'multiband_booster_LOW_C', \
-'operational': {'gain_target': 12.22, 'delta_p': 4.19, 'out_voa': [None], 'tilt_target': 0.0, \
-'f_min': 191.3, 'f_max': 196.1}}, {'type_variety': 'multiband_booster_LOW_L', \
-'operational': {'gain_target': 12.05, 'delta_p': 4.19, 'out_voa': [None], 'tilt_target': 0.0, \
-'f_min': 186.1, 'f_max': 190.9}}]}
-
-    """
-    if json_data == [None]:
-        # already conformed
-        return json_data
-    if isinstance(json_data, dict):
-        for key, value in json_data.items():
-            json_data[key] = convert_none_to_empty(value)
-    elif isinstance(json_data, list):
-        for i, elem in enumerate(json_data):
-            json_data[i] = convert_none_to_empty(elem)
-    elif json_data is None:
-        return [None]
-    return json_data
-
-
-def calculate_absolute_min_or_zero(x: array) -> array:
-    """Calculates the element-wise absolute minimum between the x and zero.
-
-    Parameters:
-    x (array): The first input array.
-
-    Returns:
-    array: The element-wise absolute minimum between x and zero.
-
-    Example:
-    >>> x = array([-1, 2, -3])
-    >>> calculate_absolute_min_or_zero(x)
-    array([1., 0., 3.])
-    """
-    return (abs(x) - x) / 2
-
-
-def nice_column_str(data: List[List[str]], max_length: int = 30, padding: int = 1) -> str:
-    """data is a list of rows, creates strings with nice alignment per colum and padding with spaces
-    letf justified
-
-    >>> table_data = [['aaa', 'b', 'c'], ['aaaaaaaa', 'bbb', 'c'], ['a', 'bbbbbbbbbb', 'c']]
-    >>> print(nice_column_str(table_data))
-    aaa      b          c 
-    aaaaaaaa bbb        c 
-    a        bbbbbbbbbb c 
-    """
-    # transpose data to determine size of columns
-    transposed_data = list(map(list, zip(*data)))
-    column_width = [max(len(word) for word in column) + padding for column in transposed_data]
-    nice_str = []
-    for row in data:
-        column = ''.join(word[0:max_length].ljust(min(width, max_length)) for width, word in zip(column_width, row))
-        nice_str.append(f'{column}')
-    return '\n'.join(nice_str)
-
-
-def filter_valid_amp_bands(amp_bands: List[List[dict]]) -> List[List[dict]]:
-    """Filter out invalid amplifier bands that lack f_min or f_max.
-
-    :param amp_bands: A list of lists containing amplifier band dictionaries.
-    :type amp_bands: List[List[dict]]
-    :return: A filtered list of amplifier bands that contain valid f_min and f_max.
-    :rtype: List[List[dict]]
-    """
-    return [amp for amp in amp_bands if all(band.get('f_min') is not None and band.get('f_max') is not None
-                                            for band in amp)]
-
-
-def remove_duplicates(amp_bands: List[List[dict]]) -> List[List[dict]]:
-    """Remove duplicate amplifier bands.
-
-    :param amp_bands: A list of lists containing amplifier band dictionaries.
-    :type amp_bands: List[List[dict]]
-    :return: A list of unique amplifier bands.
-    :rtype: List[List[dict]]
-    """
-    unique_amp_bands = []
-    for amp in amp_bands:
-        if amp not in unique_amp_bands:
-            unique_amp_bands.append(amp)
-    return unique_amp_bands
-
-
-def calculate_spacing(first: dict, second: dict, default_spacing: float, default_design_bands: Union[List[Dict], None],
-                      f_min: float, f_max: float) -> float:
-    """Calculate the spacing for the given frequency range.
-
-    :param first: The first amplifier band dictionary.
-    :type first: dict
-    :param second: The second amplifier band dictionary.
-    :type second: dict
-    :param default_spacing: The default spacing to use if no specific spacing can be determined.
-    :type default_spacing: float
-    :param default_design_bands: Optional list of design bands to determine spacing from.
-    :type default_design_bands: Union[List[Dict], None]
-    :param f_min: The minimum frequency of the range.
-    :type f_min: float
-    :param f_max: The maximum frequency of the range.
-    :type f_max: float
-    :return: The calculated spacing for the given frequency range.
-    :rtype: float
-    """
-    if first.get('spacing') is not None and second.get('spacing') is not None:
-        return max(first['spacing'], second['spacing'])
-    elif first.get('spacing') is not None:
-        return first['spacing']
-    elif second.get('spacing') is not None:
-        return second['spacing']
-    elif default_design_bands:
-        temp = get_spacing_from_band(default_design_bands, f_min, f_max)
-        return temp if temp is not None else default_spacing
-    return default_spacing
-
-
-def find_common_range(amp_bands: List[List[dict]], default_band_f_min: Union[float, None],
-                      default_band_f_max: Union[float, None], default_spacing: float,
-                      default_design_bands: Union[List[Dict], None] = None) -> List[dict]:
-    """
-    Find the common frequency range of amplifier bands.
-
-    If there are no amplifiers in the path, then use the default band parameters.
-
-    :param amp_bands: A list of lists containing amplifier band dictionaries, each with 'f_min', 'f_max',
-                      and optionally 'spacing'.
-    :type amp_bands: List[List[dict]]
-    :param default_band_f_min: The minimum frequency of the default band.
-    :type default_band_f_min: Union[float, None]
-    :param default_band_f_max: The maximum frequency of the default band.
-    :type default_band_f_max: Union[float, None]
-    :param default_spacing: The default spacing to use if no specific spacing can be determined.
-    :type default_spacing: float
-    :param default_design_bands: Optional list of design bands to determine spacing from.
-    :type default_design_bands: Union[List[Dict], None]
-    :return: A list of dictionaries representing the common frequency ranges with their respective spacings.
-    :rtype: List[dict]
-
-    >>> amp_bands = [[{'f_min': 191e12, 'f_max' : 195e12, 'spacing': 70e9}, {'f_min': 186e12, 'f_max' : 190e12}], \
-                     [{'f_min': 185e12, 'f_max' : 189e12}, {'f_min': 192e12, 'f_max' : 196e12}], \
-                     [{'f_min': 186e12, 'f_max': 193e12}]]
-    >>> find_common_range(amp_bands, 190e12, 195e12, 50e9)
-    [{'f_min': 186000000000000.0, 'f_max': 189000000000000.0, 'spacing': 50000000000.0}, \
-{'f_min': 192000000000000.0, 'f_max': 193000000000000.0, 'spacing': 70000000000.0}]
-
-    >>> amp_bands = [[{'f_min': 191e12, 'f_max' : 195e12}, {'f_min': 186e12, 'f_max' : 190e12}], \
-                     [{'f_min': 185e12, 'f_max' : 189e12}, {'f_min': 192e12, 'f_max' : 196e12}], \
-                     [{'f_min': 186e12, 'f_max': 192e12}]]
-    >>> find_common_range(amp_bands, 190e12, 195e12, 50e9)
-    [{'f_min': 186000000000000.0, 'f_max': 189000000000000.0, 'spacing': 50000000000.0}]
-    """
-    # Step 1: Filter and sort amplifier bands
-    _amp_bands = [sorted(amp, key=lambda x: x['f_min']) for amp in filter_valid_amp_bands(amp_bands)]
-    unique_amp_bands = remove_duplicates(_amp_bands)
-
-    # Step 2: Handle cases with no valid bands
-    if unique_amp_bands:
-        common_range = unique_amp_bands[0]
-    else:
-        if default_band_f_min is None or default_band_f_max is None:
-            return []
-        return [{'f_min': default_band_f_min, 'f_max': default_band_f_max, 'spacing': None}]
-
-    # Step 3: Calculate common frequency range
-    for bands in unique_amp_bands:
-        new_common_range = []
-        for first in common_range:
-            for second in bands:
-                f_min = max(first['f_min'], second['f_min'])
-                f_max = min(first['f_max'], second['f_max'])
-                if f_min < f_max:
-                    spacing = calculate_spacing(first, second, default_spacing, default_design_bands, f_min, f_max)
-                    new_common_range.append({'f_min': f_min, 'f_max': f_max, 'spacing': spacing})
-
-        common_range = new_common_range
-
-    return sorted(common_range, key=lambda x: x['f_min'])
-
-
-def transform_data(data: str) -> Union[List[int], None]:
-    """Transforms a float into an list of one integer or a string separated by "|" into a list of integers.
-
-    Args:
-        data (float or str): The data to transform.
-
-    Returns:
-        list of int: The transformed data as a list of integers.
-
-    Examples:
-        >>> transform_data(5.0)
-        [5]
-
-        >>> transform_data('1 | 2 | 3')
-        [1, 2, 3]
-    """
-    if isinstance(data, float):
-        return [int(data)]
-    if isinstance(data, str):
-        return [int(x) for x in data.split(' | ')]
-    return None
-
-
-def convert_pmd_lineic(pmd: Union[float, None], length: float, length_unit: str) -> Union[float, None]:
-    """Convert PMD value of the span in ps into pmd_lineic in s/sqrt(km)
-
-    :param pmd: value in ps
-    :type pmd: Union[float, None]
-    :param length: value in length_unit
-    :type length: float
-    :param length_unit: 'km' or 'm'
-    :type length_unit: str
-    :return: lineic PMD s/sqrt(m)
-    :rtype: Union[float, None]
-
-    >>> convert_pmd_lineic(10, 0.001, 'km')
-    1e-11
-    """
-    if pmd:
-        return pmd * 1e-12 / sqrt(convert_length(length, length_unit))
-    return None
-def get_spacing_from_band(design_bands: List[Dict], f_min, f_max):
-    """Retrieve the spacing for a frequency range based on design bands.
-
-    This function checks if the midpoint of the provided frequency range (f_min, f_max)
-    falls within any of the design bands. If it does, the corresponding spacing is returned.
-
-    :param design_bands: A list of design band dictionaries, each containing 'f_min', 'f_max', and 'spacing'.
-    :type design_bands: List[Dict]
-    :param f_min: The minimum frequency of the range.
-    :type f_min: float
-    :param f_max: The maximum frequency of the range.
-    :type f_max: float
-    :return: The spacing corresponding to the design band that contains the midpoint of the range,
-             or None if no such band exists.
-    :rtype: Union[float, None]
-    """
-    midpoint = (f_min + f_max) / 2
-    for band in design_bands:
-        if midpoint >= band['f_min'] and midpoint <= band['f_max']:
-            return band['spacing']
-    return None
-
-
-def reorder_per_degree_design_bands(per_degree_design_bands: dict):
-    """Sort the design bands for each degree by their minimum frequency (f_min).
-
-    This function modifies the input dictionary in place, sorting the design bands for each unique identifier.
-
-    :param per_degree_design_bands: A dictionary where keys are unique identifiers and values are lists of design band dictionaries.
-    :type per_degree_design_bands: Dict[str, List[Dict]]
-    """
-    for uid, design_bands in per_degree_design_bands.items():
-        per_degree_design_bands[uid] = sorted(design_bands, key=lambda x: x['f_min'])

gnpy/example-data/Juniper-BoosterHG.json

@@ -1,160 +0,0 @@
-{
-  "nf_fit_coeff": [
-    0.0008,
-    0.0272,
-    -0.2249,
-    6.4902
-  ],
-  "f_min": 191.4e12,
-  "f_max": 196.1e12,
-  "nf_ripple": [
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0,
-    0.0
-  ],
-  "gain_ripple": [
-    -0.15656302345061,
-    -0.22244242043552,
-    -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": [
-    1.0,
-    1.03941448941778,
-    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/edfa_example_network.json

@@ -1,81 +0,0 @@
-{
-  "network_name": "EDFA Example Network - P2P",
-  "elements": [
-    {
-      "uid": "Site_A",
-      "type": "Transceiver",
-      "metadata": {
-        "location": {
-          "city": "Site A",
-          "region": "",
-          "latitude": 0,
-          "longitude": 0
-        }
-      }
-    },
-    {
-      "uid": "Span1",
-      "type": "Fiber",
-      "type_variety": "SSMF",
-      "params": {
-        "length": 80,
-        "loss_coef": 0.2,
-        "length_units": "km",
-        "att_in": 0,
-        "con_in": 0.5,
-        "con_out": 0.5,
-        "pmd_coef": 3.0e-15
-      },
-      "metadata": {
-        "location": {
-          "region": "",
-          "latitude": 1,
-          "longitude": 0
-        }
-      }
-    },
-    {
-      "uid": "Edfa1",
-      "type": "Edfa",
-      "type_variety": "std_low_gain",
-      "operational": {
-        "gain_target": 17,
-        "tilt_target": 0,
-        "out_voa": 0
-      },
-      "metadata": {
-        "location": {
-          "region": "",
-          "latitude": 2,
-          "longitude": 0
-        }
-      }
-    },
-    {
-      "uid": "Site_B",
-      "type": "Transceiver",
-      "metadata": {
-        "location": {
-          "city": "Site B",
-          "region": "",
-          "latitude": 2,
-          "longitude": 0
-        }
-      }
-    }
-  ],
-  "connections": [
-    {
-      "from_node": "Site_A",
-      "to_node": "Span1"
-    },
-    {
-      "from_node": "Span1",
-      "to_node": "Edfa1"
-    },
-    {
-      "from_node": "Edfa1",
-      "to_node": "Site_B"
-    }
-  ]
-}