Prepare release notes for v2.13

Signed-off-by: EstherLerouzic <esther.lerouzic@orange.com>
Change-Id: Iff07dcd6e98b4e4abd79ec8f97d09df2cf2c0e24

.bandit

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

.codecov.yml

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

.docker-entry.sh

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

.editorconfig

@@ -1,21 +0,0 @@
-# http://editorconfig.org
-
-root = true
-
-[*]
-indent_style = space
-indent_size = 4
-trim_trailing_whitespace = true
-insert_final_newline = true
-charset = utf-8
-end_of_line = lf
-
-[*.bat]
-indent_style = tab
-end_of_line = crlf
-
-[LICENSE]
-insert_final_newline = false
-
-[Makefile]
-indent_style = tab

.github/ISSUE_TEMPLATE.md

@@ -1,15 +0,0 @@
-* gnpy version:
-* Python version:
-* Operating System:
-
-### Description
-
-Describe what you were trying to get done.
-Tell us what happened, what went wrong, and what you expected to happen.
-
-### What I Did
-
-```
-Paste the command(s) you ran and the output.
-If there was a crash, please include the traceback here.
-```

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment:**
+ - OS: [e.g. Windows]
+ - Python Version [e.g, 3.7]
+ - Anaconda Version [e.g. 3.7]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

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

.github/workflows/main.yml

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

@@ -2,6 +2,8 @@
 __pycache__/
 *.py[cod]
 *$py.class
+.ipynb_checkpoints
+.idea
 
 # C extensions
 *.so
@@ -60,3 +62,6 @@ target/
 
 # pyenv python configuration file
 .python-version
+
+# MacOS DS_store
+.DS_Store

.gitreview

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

.lgtm.yml

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

.readthedocs.yml

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

.travis.yml

@@ -1,29 +0,0 @@
-# Config file for automatic testing at travis-ci.org
-# This file will be regenerated if you run travis_pypi_setup.py
-
-language: python
-python:
-  - 3.5
-  - 3.4
-  - 3.3
-  - 2.7
-  - 2.6
-
-# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
-install: pip install -U tox-travis
-
-# command to run tests, e.g. python setup.py test
-script: tox
-
-# After you create the Github repo and add it to Travis, run the
-# travis_pypi_setup.py script to finish PyPI deployment setup
-deploy:
-  provider: pypi
-  distributions: sdist bdist_wheel
-  user: <TBD>
-  password:
-    secure: PLEASE_REPLACE_ME
-  on:
-    tags: true
-    repo: <TBD>/gnpy
-    python: 2.7

.zuul.yaml

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

@@ -1,13 +1,37 @@
-=======
-Credits
-=======
+gnpy is written and maintained by the Telecom Infra Project with work
+contributed by the following TIP members.
 
-Development Lead
-----------------
+To learn how to contribute, please see CONTRIBUTING.md
 
-* <TBD> <<TBD>@<TBD>.com>
+(*in alphabetical order*)
 
-Contributors
-------------
-
-None yet. Why not be the first?
+- 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>
+- 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>
+- 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>
+- Xufeng Liu (Jabil) <xufeng_liu@jabil.com>

CONTRIBUTING.rst

@@ -1,114 +0,0 @@
-.. highlight:: shell
-
-============
-Contributing
-============
-
-Contributions are welcome, and they are greatly appreciated! Every
-little bit helps, and credit will always be given.
-
-You can contribute in many ways:
-
-Types of Contributions
-----------------------
-
-Report Bugs
-~~~~~~~~~~~
-
-Report bugs at https://github.com/<TBD>/gnpy/issues.
-
-If you are reporting a bug, please include:
-
-* Your operating system name and version.
-* Any details about your local setup that might be helpful in troubleshooting.
-* Detailed steps to reproduce the bug.
-
-Fix Bugs
-~~~~~~~~
-
-Look through the GitHub issues for bugs. Anything tagged with "bug"
-and "help wanted" is open to whoever wants to implement it.
-
-Implement Features
-~~~~~~~~~~~~~~~~~~
-
-Look through the GitHub issues for features. Anything tagged with "enhancement"
-and "help wanted" is open to whoever wants to implement it.
-
-Write Documentation
-~~~~~~~~~~~~~~~~~~~
-
-gnpy could always use more documentation, whether as part of the
-official gnpy docs, in docstrings, or even on the web in blog posts,
-articles, and such.
-
-Submit Feedback
-~~~~~~~~~~~~~~~
-
-The best way to send feedback is to file an issue at https://github.com/<TBD>/gnpy/issues.
-
-If you are proposing a feature:
-
-* Explain in detail how it would work.
-* Keep the scope as narrow as possible, to make it easier to implement.
-* Remember that this is a volunteer-driven project, and that contributions
-  are welcome :)
-
-Get Started!
-------------
-
-Ready to contribute? Here's how to set up `gnpy` for local development.
-
-1. Fork the `gnpy` repo on GitHub.
-2. Clone your fork locally::
-
-    $ git clone git@github.com:your_name_here/gnpy.git
-
-3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
-
-    $ mkvirtualenv gnpy
-    $ cd gnpy/
-    $ python setup.py develop
-
-4. Create a branch for local development::
-
-    $ git checkout -b name-of-your-bugfix-or-feature
-
-   Now you can make your changes locally.
-
-5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
-
-    $ flake8 gnpy tests
-    $ python setup.py test or py.test
-    $ tox
-
-   To get flake8 and tox, just pip install them into your virtualenv.
-
-6. Commit your changes and push your branch to GitHub::
-
-    $ git add .
-    $ git commit -m "Your detailed description of your changes."
-    $ git push origin name-of-your-bugfix-or-feature
-
-7. Submit a pull request through the GitHub website.
-
-Pull Request Guidelines
------------------------
-
-Before you submit a pull request, check that it meets these guidelines:
-
-1. The pull request should include tests.
-2. If the pull request adds functionality, the docs should be updated. Put
-   your new functionality into a function with a docstring, and add the
-   feature to the list in README.rst.
-3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
-   https://travis-ci.org/<TBD>/gnpy/pull_requests
-   and make sure that the tests pass for all supported Python versions.
-
-Tips
-----
-
-To run a subset of tests::
-
-$ py.test tests.test_gnpy
-

Dockerfile

@@ -0,0 +1,8 @@
+FROM python:3.9-slim
+COPY . /oopt-gnpy
+WORKDIR /oopt-gnpy
+RUN apt update; apt install -y git
+RUN pip install .
+WORKDIR /shared/example-data
+ENTRYPOINT ["/oopt-gnpy/.docker-entry.sh"]
+CMD ["/bin/bash"]

HISTORY.rst

@@ -1,8 +0,0 @@
-=======
-History
-=======
-
-0.1.0 (2017-06-29)
-------------------
-
-* First release on PyPI.

LICENSE

@@ -1,31 +1,29 @@
+BSD 3-Clause License
 
-BSD License
-
-Copyright (c) 2017, <TBD>
+Copyright (c) 2018, Telecom Infra Project
 All rights reserved.
 
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 
-* Redistributions in binary form must reproduce the above copyright notice, this
-  list of conditions and the following disclaimer in the documentation and/or
-  other materials provided with the distribution.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
 
 * Neither the name of the copyright holder nor the names of its
-  contributors may be used to endorse or promote products derived from this
-  software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-OF THE POSSIBILITY OF SUCH DAMAGE.
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -1,11 +0,0 @@
-include AUTHORS.rst
-include CONTRIBUTING.rst
-include HISTORY.rst
-include LICENSE
-include README.rst
-
-recursive-include tests *
-recursive-exclude * __pycache__
-recursive-exclude * *.py[co]
-
-recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

Makefile

@@ -1,87 +0,0 @@
-.PHONY: clean clean-test clean-pyc clean-build docs help
-.DEFAULT_GOAL := help
-define BROWSER_PYSCRIPT
-import os, webbrowser, sys
-try:
-	from urllib import pathname2url
-except:
-	from urllib.request import pathname2url
-
-webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
-endef
-export BROWSER_PYSCRIPT
-
-define PRINT_HELP_PYSCRIPT
-import re, sys
-
-for line in sys.stdin:
-	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
-	if match:
-		target, help = match.groups()
-		print("%-20s %s" % (target, help))
-endef
-export PRINT_HELP_PYSCRIPT
-BROWSER := python -c "$$BROWSER_PYSCRIPT"
-
-help:
-	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
-
-clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
-
-
-clean-build: ## remove build artifacts
-	rm -fr build/
-	rm -fr dist/
-	rm -fr .eggs/
-	find . -name '*.egg-info' -exec rm -fr {} +
-	find . -name '*.egg' -exec rm -f {} +
-
-clean-pyc: ## remove Python file artifacts
-	find . -name '*.pyc' -exec rm -f {} +
-	find . -name '*.pyo' -exec rm -f {} +
-	find . -name '*~' -exec rm -f {} +
-	find . -name '__pycache__' -exec rm -fr {} +
-
-clean-test: ## remove test and coverage artifacts
-	rm -fr .tox/
-	rm -f .coverage
-	rm -fr htmlcov/
-
-lint: ## check style with flake8
-	flake8 gnpy tests
-
-test: ## run tests quickly with the default Python
-	py.test
-	
-
-test-all: ## run tests on every Python version with tox
-	tox
-
-coverage: ## check code coverage quickly with the default Python
-	coverage run --source gnpy -m pytest
-	coverage report -m
-	coverage html
-	$(BROWSER) htmlcov/index.html
-
-docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/gnpy.rst
-	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ gnpy
-	$(MAKE) -C docs clean
-	$(MAKE) -C docs html
-	$(BROWSER) docs/_build/html/index.html
-
-servedocs: docs ## compile the docs watching for changes
-	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
-
-release: clean ## package and upload a release
-	python setup.py sdist upload
-	python setup.py bdist_wheel upload
-
-dist: clean ## builds source and wheel package
-	python setup.py sdist
-	python setup.py bdist_wheel
-	ls -l dist
-
-install: clean ## install the package to the active Python's site-packages
-	python setup.py install

README.md

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

@@ -1,32 +0,0 @@
-====
-gnpy
-====
-
-
-.. image:: https://img.shields.io/pypi/v/gnpy.svg
-        :target: https://pypi.python.org/pypi/gnpy
-
-.. image:: https://img.shields.io/travis/<TBD>/gnpy.svg
-        :target: https://travis-ci.org/<TBD>/gnpy
-
-.. image:: https://readthedocs.org/projects/gnpy/badge/?version=latest
-        :target: https://gnpy.readthedocs.io/en/latest/?badge=latest
-        :alt: Documentation Status
-
-.. image:: https://pyup.io/repos/github/<TBD>/gnpy/shield.svg
-     :target: https://pyup.io/repos/github/<TBD>/gnpy/
-     :alt: Updates
-
-
-Gaussian Noise (GN) modeling library
-
-
-* Free software: BSD license
-* Documentation: https://gnpy.readthedocs.io.
-
-
-Features
---------
-
-* TODO
-

bindep.txt

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

docs/.gitignore

@@ -1,3 +0,0 @@
-/gnpy.rst
-/gnpy.*.rst
-/modules.rst

docs/Makefile

@@ -1,177 +1,20 @@
-# Makefile for Sphinx documentation
+# Minimal makefile for Sphinx documentation
 #
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-PAPER         =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = GNpy
+SOURCEDIR     = .
 BUILDDIR      = _build
 
-# User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
-
-# Internal variables.
-PAPEROPT_a4     = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
-
+# Put it first so that "make" without argument is like "make help".
 help:
-	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  html       to make standalone HTML files"
-	@echo "  dirhtml    to make HTML files named index.html in directories"
-	@echo "  singlehtml to make a single large HTML file"
-	@echo "  pickle     to make pickle files"
-	@echo "  json       to make JSON files"
-	@echo "  htmlhelp   to make HTML files and a HTML help project"
-	@echo "  qthelp     to make HTML files and a qthelp project"
-	@echo "  devhelp    to make HTML files and a Devhelp project"
-	@echo "  epub       to make an epub"
-	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
-	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
-	@echo "  text       to make text files"
-	@echo "  man        to make manual pages"
-	@echo "  texinfo    to make Texinfo files"
-	@echo "  info       to make Texinfo files and run them through makeinfo"
-	@echo "  gettext    to make PO message catalogs"
-	@echo "  changes    to make an overview of all changed/added/deprecated items"
-	@echo "  xml        to make Docutils-native XML files"
-	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
-	@echo "  linkcheck  to check all external links for integrity"
-	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-clean:
-	rm -rf $(BUILDDIR)/*
+.PHONY: help Makefile
 
-html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
-	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
-	@echo
-	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-	@echo
-	@echo "Build finished; now you can process the pickle files."
-
-json:
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-	@echo
-	@echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-	@echo
-	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/gnpy.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gnpy.qhc"
-
-devhelp:
-	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
-	@echo
-	@echo "Build finished."
-	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/gnpy"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gnpy"
-	@echo "# devhelp"
-
-epub:
-	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
-	@echo
-	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-	@echo "Run \`make' in that directory to run these through (pdf)latex" \
-	      "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through pdflatex..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-latexpdfja:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through platex and dvipdfmx..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
-	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
-	@echo
-	@echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
-	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
-	@echo
-	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-texinfo:
-	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-	@echo
-	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
-	@echo "Run \`make' in that directory to run these through makeinfo" \
-	      "(use \`make info' here to do that automatically)."
-
-info:
-	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-	@echo "Running Texinfo files through makeinfo..."
-	make -C $(BUILDDIR)/texinfo info
-	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
-
-gettext:
-	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
-	@echo
-	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-changes:
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-	@echo
-	@echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
-	@echo
-	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
-
-xml:
-	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
-	@echo
-	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
-
-pseudoxml:
-	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
-	@echo
-	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/custom.css

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

docs/about-project.md

@@ -0,0 +1,60 @@
+(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/amplifier_models_description.rst

@@ -0,0 +1,318 @@
+.. _amp_models:
+
+**********************************
+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
+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.
+
+- *"type_variety"*:
+    Each amplifier is identified by its unique *"type_variety"*, which is used in the topology files input to reference a specific amplifier. It is a user free defined id.
+    
+    For each amplifier *type_variety*, specific parameters are describing its attributes and performance:
+
+- *"type_def"*:
+    Sets the amplifier model that the simulation will use to calculate the ase noise contribution. 5 models are defined with reserved words:
+
+    - *"advanced_model"*
+    - *"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**
+    
+    json file name describing:
+
+    - nf_fit_coeff
+    - f_min/max
+    - gain_ripple
+    - nf_ripple 
+    - dgt
+    
+    *see next section for a full description*
+
+- *"gain_flatmax"*: 
+    amplifier maximum gain in dB before its extended gain range: flat or nominal tilt output. 
+    
+    If gain > gain_flatmax, the amplifier will tilt, based on its dgt function
+
+    If gain > gain_flatmax + target_extended_gain, the amplifier output power is reduced to  not exceed the extended gain range.
+
+- *"gain_min"*: 
+    amplifier minimum gain in dB.
+
+    If gain < gain_min, the amplifier input is automatically padded, which results in
+
+    NF += gain_min - gain 
+
+- *"p_max"*: 
+    amplifier max output power, full load
+
+    Total signal output power will not be allowed beyond this value
+
+- *"nf_min/max"*:
+    **These parameters are only applicable to the _"variable_gain"_ model**
+
+    min & max NF values in dB
+
+    NF_min is the amplifier NF @ gain_max  
+
+    NF_max is the amplifier NF @ gain_min  
+
+- *"nf_coef"*: 
+    **This parameter is only applicable to the *"openroadm"* model**
+
+    [a, b, c, d] 3rd order polynomial coefficients list to define the incremental OSNR vs Pin
+    
+    Incremental OSNR is the amplifier OSNR contribution
+    
+    Pin is the amplifier channel input power defined in a 50GHz bandwidth
+    
+    Incremental OSNR = a*Pin³ + b*Pin² + c*Pin + d
+
+- *"preamp_variety"*: 
+    **This parameter is only applicable to the _"dual_stage"_ model**
+
+    1st stage type_variety
+
+- *"booster_variety"*: 
+    **This parameter is only applicable to the *"dual_stage"* model**
+
+    2nd stage type_variety
+
+- *"out_voa_auto"*: true/false
+    **power_mode only**
+
+    **This parameter is only applicable to the *"advanced_model"* and *"variable_gain"* models**
+
+    If "out_voa_auto": true, auto_design will chose the output_VOA value that maximizes the amplifier gain within its power capability and therefore minimizes its NF.
+
+- *"allowed_for_design"*: true/false
+    **auto_design only**
+
+    Tells auto_design if this amplifier can be picked for the design (deactivates unwanted amplifiers)
+
+    It does not prevent the use of an amplifier if it is placed in the topology input.
+
+    .. code-block:: json
+
+        {"Edfa": [{
+                    "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
+                    }
+            ]}
+
+
+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.
+
+5 types of EDFA definition are possible and referenced by the *"type_def"* parameter with the following reserved words:
+
+-  *"advanced_model"* 
+    This model is refered as a whitebox model because of the detailed level of knowledge that is required. The amplifier NF model and ripple definition are described by a json file referenced with *"advanced_config_from_json"*: json filename. This json file contains:
+
+    - nf_fit_coeff: [a,b,c,d]
+         
+        3rd order polynomial NF = f(-dg) coeficients list
+
+        dg = gain - gain_max
+
+    - f_min/max: amplifier frequency range in Hz
+    - gain_ripple : [...]
+
+        amplifier gain ripple excursion comb list in dB across the frequency range.
+    - nf_ripple : [...]
+        
+        amplifier nf ripple excursion comb list in dB across the frequency range. 
+    - dgt : [...]
+        amplifier dynamic gain tilt comb list across the frequency range.
+            
+        *See next section for the generation of this json file*
+
+    .. code-block:: json-object
+
+        "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
+                }
+            ]
+
+- *"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.
+    - gain_ripple =[0,...,0]
+    - nf_ripple = [0,...,0]
+    - dgt = [...] generic dgt comb
+
+    .. code-block:: json-object
+
+        "Edfa":[{
+                "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
+                }
+            ]
+
+-  *"fixed_gain"* 
+    This model is also an operator model with a single NF value that emulates basic single coil amplifiers without internal VOA.
+
+    if gain_min < gain < gain_max, NF == nf0
+    
+    if gain < gain_min, the amplifier input is automatically padded, which results in 
+
+    NF += gain_min - gain
+
+    .. code-block:: json-object
+
+        "Edfa":[{
+                "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
+                }
+            ]
+
+- *"openroadm"* 
+    This model is a black box model replicating OpenRoadm MSA spec for ILA.
+
+    .. code-block:: json-object
+
+        "Edfa":[{
+                "type_variety": "openroadm_ila_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
+                }
+            ]
+
+- *"dual_stage"* 
+    This model allows the cascade (pre-defined combination) of any 2 amplifiers already described in the eqpt_config.json library.
+    
+    - preamp_variety defines the 1st stge type variety
+    
+    - booster variety defines the 2nd stage type variety
+    
+    Both preamp and booster variety must exist in the eqpt libray
+    The resulting NF is the sum of the 2 amplifiers 
+    The preamp is operated to its maximum gain
+    
+    - 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.
+
+    .. code-block:: json
+
+                {
+                "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
+                }
+
+
+- *"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:
+
+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
+returns an updated amplifier json file: output_json_file_name = 'edfa_config.json'
+amplifier file names
+
+Convert a set of amplifier files + input json definiton file into a valid edfa_json_file:
+
+nf_fit_coeff: NF 3rd order polynomial coefficients txt file
+
+nf = f(dg) with dg = gain_operational - gain_max
+
+nf_ripple: NF ripple excursion txt file
+
+gain_ripple: gain ripple txt file
+
+dgt: dynamic gain txt file
+
+input json file in argument (defult = 'OA.json')
+
+the json input file should have the following fields:
+
+    .. code-block:: json
+
+        {
+            "nf_fit_coeff": "nf_filename.txt",
+            "nf_ripple": "nf_ripple_filename.txt", 
+            "gain_ripple": "DFG_filename.txt",
+            "dgt": "DGT_filename.txt"
+        }

docs/authors.rst

@@ -1 +0,0 @@
-.. include:: ../AUTHORS.rst

docs/calendar.html

@@ -0,0 +1,29 @@
+<!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

@@ -0,0 +1,297 @@
+.. _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

@@ -0,0 +1,271 @@
+.. _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

@@ -1,8 +1,8 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
 # gnpy documentation build configuration file, created by
-# sphinx-quickstart on Tue Jul  9 22:26:36 2013.
+# sphinx-quickstart on Mon Dec 18 14:41:01 2017.
 #
 # This file is execfile()d with the current directory set to its
 # containing dir.
@@ -13,263 +13,193 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
 import os
+import sys
 
-# If extensions (or modules to document with autodoc) are in another
-# directory, add these directories to sys.path here. If the directory is
-# relative to the documentation root, use os.path.abspath to make it
-# absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
 
-# Get the project root dir, which is the parent dir of this
-cwd = os.getcwd()
-project_root = os.path.dirname(cwd)
+sys.path.insert(0, os.path.abspath('../'))
 
-# Insert the project root dir as the first element in the PYTHONPATH.
-# This lets us ensure that the source package is imported, and that its
-# version is used.
-sys.path.insert(0, project_root)
-
-import gnpy
-
-# -- General configuration ---------------------------------------------
+# -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+#
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+# 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",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
-# The suffix of source filenames.
-source_suffix = '.rst'
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = ['.rst', '.md']
 
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
-project = u'gnpy'
-copyright = u"2017, <TBD>"
-
-# 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 = gnpy.__version__
-# The full version, including alpha/beta/rc tags.
-release = gnpy.__version__
+project = 'gnpy'
+copyright = '2018 - 2021, Telecom Infra Project - OOPT PSE Group'
+author = 'Telecom Infra Project - OOPT PSE Group'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to
-# some non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+#
+# 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'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built
-# documents.
-#keep_warnings = False
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
 
 
-# -- Options for HTML output -------------------------------------------
+# -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+#
+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'
 
-# 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
+html_logo = 'images/GNPy-logo.png'
+
+# 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
 # documentation.
-#html_theme_options = {}
+#
+# html_theme_options = {}
 
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as
-# html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the
-# top of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon
-# of the docs.  This file should be a Windows icon file (.ico) being
-# 16x16 or 32x32 pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets)
-# here, relative to this directory. They are copied after the builtin
-# static files, so a file named "default.css" will overwrite the builtin
-# "default.css".
+# Add any paths that contain custom static files (such as style sheets) here,
+# 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é
+]
 
-# If not '', a 'Last updated on:' timestamp is inserted at every page
-# bottom, using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names
+# Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
-#html_additional_pages = {}
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+        'donate.html',
+    ]
+}
 
-# If false, no module index is generated.
-#html_domain_indices = True
+html_secnum_depth = 4
 
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer.
-# Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer.
-# Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages
-# will contain a <link> tag referring to it.  The value of this option
-# must be the base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'gnpydoc'
 
 
-# -- Options for LaTeX output ------------------------------------------
+# -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
+    #
+    # 'papersize': 'letterpaper',
 
     # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
+    #
+    # 'pointsize': '10pt',
 
     # Additional stuff for the LaTeX preamble.
-    #'preamble': '',
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass
-# [howto/manual]).
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ('index', 'gnpy.tex',
-     u'gnpy Documentation',
-     u'<TBD>', 'manual'),
+    (master_doc, 'gnpy.tex', 'gnpy Documentation',
+     'Telecom Infra Project - OOPT PSE Group', 'manual'),
 ]
 
-# The name of an image file (relative to this directory) to place at
-# the top of the title page.
-#latex_logo = None
 
-# For "manual" documents, if this is true, then toplevel headings
-# are parts, not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output ------------------------------------
+# -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'gnpy',
-     u'gnpy Documentation',
-     [u'<TBD>'], 1)
+    (master_doc, 'gnpy', 'gnpy Documentation',
+     [author], 1)
 ]
 
-# If true, show URL addresses after external links.
-#man_show_urls = False
 
-
-# -- Options for Texinfo output ----------------------------------------
+# -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'gnpy',
-     u'gnpy Documentation',
-     u'<TBD>',
-     'gnpy',
-     'One line description of project.',
+    (master_doc, 'gnpy', 'gnpy Documentation',
+     author, 'gnpy', 'One line description of project.',
      'Miscellaneous'),
 ]
 
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+autodoc_default_options = {
+    'members': True,
+    'undoc-members': True,
+    'private-members': True,
+    'show-inheritance': True,
+}
 
-# If false, no module index is generated.
-#texinfo_domain_indices = True
+graphviz_output_format = 'svg'
 
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+bibtex_bibfiles = ['biblio.bib']

docs/contributing.rst

@@ -1 +0,0 @@
-.. include:: ../CONTRIBUTING.rst

docs/excel.rst

@@ -0,0 +1,269 @@
+.. _excel:
+
+*****************************
+Excel (XLS, XLSX) input files
+*****************************
+
+``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.
+
+The file named 'meshTopologyExampleV2.xls' is an example.
+
+In order to work the excel file MUST contain at least 2 sheets:
+
+- `Nodes`
+- `Links`
+
+(In progress) The File MAY contain additional sheets:
+
+- `Eqpt`
+- `Service`
+- `Roadms`
+
+.. _excel-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`)::
+
+  City (Mandatory) ; State ; Country ; Region ; Latitude ; Longitude ; Type
+
+- **City** is used for the name of a node of the graph. It accepts letters, numbers,underscore,dash, blank... (not exhaustive). The user may want to avoid commas for future CSV exports.
+
+   **City name MUST be unique** 
+
+- **Type** is not mandatory. 
+
+  - If not filled, it will be interpreted as an 'ILA' site if node degree is 2 and as a ROADM otherwise.
+  - 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.
+
+- *Longitude*, *Latitude* are not mandatory. If filled they should contain numbers.
+
+- **Booster_restriction** and **Preamp_restriction** are not mandatory.
+  If used, they must contain one or several amplifier type_variety names separated by ' | '. This information is used to restrict types of amplifiers used in a ROADM node during autodesign. If a ROADM booster or preamp is already specified in the Eqpt sheet , the field is ignored. The field is also ignored if the node is not a ROADM node.
+
+**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                                 -->
+   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.
+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.
+
+
+Parameters for "east cable from a to z" and "west from z to a" are detailed in 2x7 columns. If not filled, "west from z to a" is copied from "east cable from a to z".
+
+For example, a line filled with::
+
+  node6 ; node3 ; 80 ; SSMF ; 0.2 ; 0.5 ; 0.5 ; 0.1 ; cableB ;  ;  ; 0.21 ; 0.2 ;  ;  ;  
+
+will generate a unidir fiber span from node6 to node3 with::
+ 
+  [node6 node3 80 SSMF 0.2 0.5 0.5 0.1 cableB] 
+
+and a fiber span from node3 to node6::
+
+ [node6 node3 80 SSMF 0.21 0.2 0.5 0.1 cableB] attributes. 
+
+- **NodeA** and **NodeZ** are Mandatory. 
+  They are the two endpoints of the link. They MUST contain a node name from the **City** names listed in Nodes sheet.
+
+- **Distance km** is not mandatory. 
+  It is the link length.
+
+  - 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.
+
+- **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 not filled it takes "SSMF" as default value.
+
+- **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.
+
+  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.
+
+  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.
+  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:
+
+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.
+
+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 ; 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 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):
+
+::
+
+  A    - amp1
+  amp1 - amp2
+  Amp2 - B
+  A    - amp3
+  amp3 - C
+
+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)
+
+::
+
+  A    - amp1
+  amp1 - amp2
+  Amp2 - B
+  A    - amp3
+  amp3 - C
+  B    - amp2
+  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.
+
+.. code-block:: shell
+
+    $ cd $(gnpy-example-data)
+    $ 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.
+
+
+- **Node A** is mandatory. It is the name of the node (as listed in Nodes sheet).
+  If Node A is a 'ROADM' (Type attribute in sheet Node), its number of occurence must be equal to its degree.
+  If Node A is an 'ILA' it should appear only once.
+
+- **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 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.
+
+- **amp_gain** is not mandatory. It is the value to be set on the amplifier (in dB).
+  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).
+  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.
+
+- **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.
+
+(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 must contain 11 columns::  
+
+   route id ; Source ; Destination ; TRX type ; Mode ; System: spacing ; System: input power (dBm) ; System: nb of channels ;  routing: disjoint from ; routing: path ; routing: is loose?
+
+- **route id** is mandatory. It must be unique. It is the identifier of the request. It can be an integer or a string (do not  use blank or dash or coma)
+
+- **Source** is mandatory. It is the name of the source node (as listed in Nodes sheet). Source MUST be a ROADM node. (TODO: relax this and accept trx entries)
+
+- **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.
+
+- **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. 
+
+- **System: spacing** is mandatory. Spacing is the channel spacing defined in GHz difined for the feasibility propagation simulation, assuming system full load.
+
+- **System: input power (dBm) ; System: nb of channels** are optional input defining the system parameters for the propagation simulation.
+
+  - input power is the channel optical input power in dBm
+  - nb of channels is the number of channels to be used for the simulation.
+
+- **routing: disjoint from ; routing: path ; routing: is loose?** are optional.
+
+  - disjoint from: identifies the requests from which this request must be disjoint. If filled it must contain request ids separated by ' | ' 
+  - 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.  

docs/extending.rst

@@ -0,0 +1,173 @@
+.. _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

@@ -0,0 +1,13 @@
+``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

@@ -0,0 +1,10 @@
+``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

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

docs/gnpy-api.rst

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

docs/history.rst

@@ -1 +0,0 @@
-.. include:: ../HISTORY.rst

docs/index.rst

@@ -1,22 +1,36 @@
-Welcome to gnpy's documentation!
-======================================
+************************************
+GNPy: Optical Route Planning Library
+************************************
 
-Contents:
+`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.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 4
+   :caption: Contents
 
-   readme
-   installation
-   usage
-   modules
-   contributing
-   authors
-   history
+   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`
+

docs/install.rst

@@ -0,0 +1,112 @@
+***************
+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/installation.rst

@@ -1,51 +0,0 @@
-.. highlight:: shell
-
-============
-Installation
-============
-
-
-Stable release
---------------
-
-To install gnpy, run this command in your terminal:
-
-.. code-block:: console
-
-    $ pip install gnpy
-
-This is the preferred method to install gnpy, as it will always install the most recent stable release. 
-
-If you don't have `pip`_ installed, this `Python installation guide`_ can guide
-you through the process.
-
-.. _pip: https://pip.pypa.io
-.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
-
-
-From sources
-------------
-
-The sources for gnpy can be downloaded from the `Github repo`_.
-
-You can either clone the public repository:
-
-.. code-block:: console
-
-    $ git clone git://github.com/<TBD>/gnpy
-
-Or download the `tarball`_:
-
-.. code-block:: console
-
-    $ curl  -OL https://github.com/<TBD>/gnpy/tarball/master
-
-Once you have a copy of the source, you can install it with:
-
-.. code-block:: console
-
-    $ python setup.py install
-
-
-.. _Github repo: https://github.com/<TBD>/gnpy
-.. _tarball: https://github.com/<TBD>/gnpy/tarball/master

docs/intro.rst

@@ -0,0 +1,97 @@
+.. _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/make.bat

@@ -1,242 +1,36 @@
-@ECHO OFF
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set BUILDDIR=_build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
-set I18NSPHINXOPTS=%SPHINXOPTS% .
-if NOT "%PAPER%" == "" (
-	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
-	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
-	:help
-	echo.Please use `make ^<target^>` where ^<target^> is one of
-	echo.  html       to make standalone HTML files
-	echo.  dirhtml    to make HTML files named index.html in directories
-	echo.  singlehtml to make a single large HTML file
-	echo.  pickle     to make pickle files
-	echo.  json       to make JSON files
-	echo.  htmlhelp   to make HTML files and a HTML help project
-	echo.  qthelp     to make HTML files and a qthelp project
-	echo.  devhelp    to make HTML files and a Devhelp project
-	echo.  epub       to make an epub
-	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
-	echo.  text       to make text files
-	echo.  man        to make manual pages
-	echo.  texinfo    to make Texinfo files
-	echo.  gettext    to make PO message catalogs
-	echo.  changes    to make an overview over all changed/added/deprecated items
-	echo.  xml        to make Docutils-native XML files
-	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
-	echo.  linkcheck  to check all external links for integrity
-	echo.  doctest    to run all doctests embedded in the documentation if enabled
-	goto end
-)
-
-if "%1" == "clean" (
-	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
-	del /q /s %BUILDDIR%\*
-	goto end
-)
-
-
-%SPHINXBUILD% 2> nul
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-if "%1" == "html" (
-	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
-	goto end
-)
-
-if "%1" == "dirhtml" (
-	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
-	goto end
-)
-
-if "%1" == "singlehtml" (
-	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
-	goto end
-)
-
-if "%1" == "pickle" (
-	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can process the pickle files.
-	goto end
-)
-
-if "%1" == "json" (
-	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can process the JSON files.
-	goto end
-)
-
-if "%1" == "htmlhelp" (
-	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
-	goto end
-)
-
-if "%1" == "qthelp" (
-	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\gnpy.qhcp
-	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\gnpy.ghc
-	goto end
-)
-
-if "%1" == "devhelp" (
-	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished.
-	goto end
-)
-
-if "%1" == "epub" (
-	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The epub file is in %BUILDDIR%/epub.
-	goto end
-)
-
-if "%1" == "latex" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "latexpdf" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	cd %BUILDDIR%/latex
-	make all-pdf
-	cd %BUILDDIR%/..
-	echo.
-	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "latexpdfja" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	cd %BUILDDIR%/latex
-	make all-pdf-ja
-	cd %BUILDDIR%/..
-	echo.
-	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "text" (
-	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The text files are in %BUILDDIR%/text.
-	goto end
-)
-
-if "%1" == "man" (
-	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The manual pages are in %BUILDDIR%/man.
-	goto end
-)
-
-if "%1" == "texinfo" (
-	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
-	goto end
-)
-
-if "%1" == "gettext" (
-	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
-	goto end
-)
-
-if "%1" == "changes" (
-	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.The overview file is in %BUILDDIR%/changes.
-	goto end
-)
-
-if "%1" == "linkcheck" (
-	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
-	goto end
-)
-
-if "%1" == "doctest" (
-	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
-	goto end
-)
-
-if "%1" == "xml" (
-	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The XML files are in %BUILDDIR%/xml.
-	goto end
-)
-
-if "%1" == "pseudoxml" (
-	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
-	goto end
-)
-
-:end
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=GNpy
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/model.rst

@@ -0,0 +1,149 @@
+.. _physical-model:
+
+***************************
+Physical Model used in GNPy
+***************************
+
+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
+network route. For backbone transport networks, we can suppose that
+transceivers are operating polarization-division-multiplexed multilevel
+modulation formats with DSP-based coherent receivers, including equalization.
+For the optical links, we focus on state-of-the-art amplified and uncompensated
+fiber links, connecting network nodes including ROADMs, where add and drop
+operations on data traffic are performed. In such a transmission scenario, it
+is well accepted
+:cite:`vacondio_nonlinear_2012,bononi_modeling_2012,carena_modeling_2012,mecozzi_nonlinear_2012,secondini_analytical_2012,johannisson_perturbation_2013,dar_properties_2013,serena_alternative_2013,secondini_achievable_2013,poggiolini_gn-model_2014,dar_accumulation_2014,poggiolini_analytical_2011,savory_approximations_2013,bononi_single-_2013,johannisson_modeling_2014`
+to assume that transmission performances are limited by the amplified
+spontaneous emission (ASE) noise generated by optical amplifiers and and
+by nonlinear propagation effects: accumulation of a Gaussian disturbance
+defined as nonlinear interference (NLI) and generation of phase noise.
+State-of-the-art DSP in commercial transceivers are typically able to
+compensate for most of the phase noise through carrier-phase estimator
+(CPE) algorithms, for modulation formats with cardinality up to 16, per
+polarization state
+:cite:`poggiolini_recent_2017,schmidt_experimental_2015,fehenberger_experimental_2016`.
+So, for backbone networks covering medium-to-wide geographical areas, we
+can suppose that propagation is limited by the accumulation of two
+Gaussian disturbances: the ASE noise and the NLI. Additional impairments
+such as filtering effects introduced by ROADMs can be considered as
+additional equivalent power penalties depending on the ratio between the
+channel bandwidth and the ROADMs filters and the number of traversed
+ROADMs (hops) of the route under analysis. Modeling the two major
+sources of impairments as Gaussian disturbances, and being the receivers
+*coherent*, the unique QoT parameter determining the bit error rate
+(BER) for the considered transmission scenario is the generalized
+signal-to-noise ratio (SNR) defined as
+
+.. math::
+
+   {\text{SNR}}= L_F \frac{P_{\text{ch}}}{P_{\text{ASE}}+P_{\text{NLI}}} = L_F \left(\frac{1}{{\text{SNR}}_{\text{LIN}}}+\frac{1}{{\text{SNR}}_{\text{NL}}}\right)^{-1}
+
+
+where :math:`P_{\text{ch}}` is the channel power,
+:math:`P_{\text{ASE}}` and :math:`P_{\text{NLI}}` are the power levels of the disturbances 
+in the channel bandwidth for ASE noise and NLI, respectively.
+:math:`L_F` is a parameter assuming values smaller or equal than one
+that summarizes the equivalent power penalty loss such as 
+filtering effects. Note that for state-of-the art equipment, filtering
+effects can be typically neglected over routes with few hops
+:cite:`rahman_mitigation_2014,foggi_overcoming_2015`.
+
+To properly estimate :math:`P_{\text{ch}}` and :math:`P_{\text{ASE}}`
+the transmitted power at the beginning of the considered route must be
+known, and losses and amplifiers gain and noise figure, including their
+variation with frequency, must be characterized. So, the evaluation of
+:math:`{\text{SNR}}_{\text{LIN}}` *just* requires an accurate
+knowledge of equipment, which is not a trivial aspect, but it is not
+related to physical-model issues. For the evaluation of the NLI, several
+models have been proposed and validated in the technical literature
+:cite:`vacondio_nonlinear_2012,bononi_modeling_2012,carena_modeling_2012,mecozzi_nonlinear_2012,secondini_analytical_2012,johannisson_perturbation_2013,dar_properties_2013,serena_alternative_2013,secondini_achievable_2013,poggiolini_gn-model_2014,dar_accumulation_2014,poggiolini_analytical_2011,savory_approximations_2013,bononi_single-_2013,johannisson_modeling_2014`.
+The decision about which model to test within the PSE activities was
+driven by requirements of the entire PSE framework:
+
+i. the model must be *local*, i.e., related individually to each network
+element (i.e. fiber span) generating NLI, independently of preceding and
+subsequent elements; and ii. the related computational time must be compatible
+with interactive operations. 
+
+So, the choice fell on the Gaussian Noise
+(GN) model with incoherent accumulation of NLI over fiber spans
+:cite:`poggiolini_gn-model_2014`. We implemented both the
+exact GN-model evaluation of NLI based on a double integral (Eq. (11) of
+:cite:`poggiolini_gn-model_2014`) and its analytical
+approximation (Eq. (120-121) of
+:cite:`poggiolini_analytical_2011`). We performed several
+validation analyses comparing results of the two implementations with
+split-step simulations over wide bandwidths
+:cite:`pilori_ffss_2017`, and results clearly showed that
+for fiber types with chromatic dispersion roughly larger than 4
+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
+can be summarized as  a disturbance called nonlinear interference (NLI), when
+exploiting a DSP-based coherent receiver, as in all state-of-the-art equipment.
+From a practical point of view, the NLI can be modeled as an additive Gaussian
+random process added by each fiber span, and whose strength depends on the cube
+of the input power spectral density and on the fiber-span parameters. 
+
+Since the introduction in the market in 2007 of the first transponder based on
+such a transmission technique, the scientific community has intensively worked
+to define the propagation behavior of such a trasnmission technique.  First,
+the role of in-line chromatic dispersion compensation has been investigated,
+deducing that besides being not essential, it is indeed detrimental for
+performances :cite:`curri_dispersion_2008`.  Then, it has been observed that
+the fiber propagation impairments are practically summarized by the sole NLI,
+being all the other phenomena compensated for by the blind equalizer
+implemented in the receiver DSP :cite:`carena_statistical_2010`.  Once these
+assessments have been accepted by the community, several prestigious research
+groups have started to work on deriving analytical models able to estimating
+the NLI accumulation, and consequentially the generalized SNR that sets the
+BER, according to the transponder BER vs. SNR performance.  Many models
+delivering different levels of accuracy have been developed and validated. As
+previously clarified, for the purposes of the PSE framework, the  GN-model with
+incoherent accumulation of NLI over fiber spans has been selected as adequate.
+The reason for such a choice is first such a model being a "local" model, so
+related to each fiber spans, independently of the preceding and succeeding
+network elements. The other model characteristic driving the choice is the
+availability of a closed form for the model, so permitting a real-time
+evaluation, as required by the PSE framework.  For a detailed derivation of the
+model, please refer to :cite:`poggiolini_analytical_2011`, while a qualitative
+description can be summarized as in the following.  The GN-model assumes that
+the channel comb propagating in the fiber is well approximated by unpolarized
+spectrally shaped Gaussian noise. In such a scenario, supposing to rely - as in
+state-of-the-art equipment - on a receiver entirely compensating for linear
+propagation effects, propagation in the fiber only excites the four-wave mixing
+(FWM) process among the continuity of the tones occupying the bandwidth. Such a
+FWM generates an unpolarized complex Gaussian disturbance in each spectral slot
+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
+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
+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.
+So, considering these characteristics, and the fact that the NLI is always a
+secondary effect with respect to the ASE noise accumulation, and - most
+importantly - that typically linear propagation parameters (losses, gains and
+noise figures) are known within a variation range, a QoT estimator based on the
+GN model is adequate to deliver performance predictions in terms of a
+reasonable SNR range, rather than an exact value.  As final remark, it must be
+clarified that the GN-model is adequate to be used when relying on a relatively
+narrow bandwidth up to few THz. When exceeding such a bandwidth occupation, the
+GN-model must be generalized introducing the interaction with the Stimulated
+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::

docs/publications.rst

@@ -0,0 +1,25 @@
+.. _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/readme.rst

@@ -1 +0,0 @@
-.. include:: ../README.rst

docs/release-notes.rst

@@ -0,0 +1,527 @@
+.. _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/usage.rst

@@ -1,7 +0,0 @@
-=====
-Usage
-=====
-
-To use gnpy in a project::
-
-    import gnpy

gnpy/__init__.py

@@ -1,7 +1,8 @@
-# -*- coding: utf-8 -*-
+"""
+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.
 
-from .gnpy import (raised_cosine_comb, analytic_formula, compute_psi, fwm_eff,
-                   get_f_computed_interp, get_freqarray, gn_analytic, gn_model,
-                   interpolate_in_range, GN_integral)
-
-__all__ = ['gnpy']
+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/__main__.py

@@ -1,75 +0,0 @@
-import gnpy as gn
-import numpy as np
-import matplotlib.pyplot as plt
-import time
-
-
-def main():
-
-    # Accuracy parameters
-    flag_analytic = True
-    num_computed_values = 2
-    interp_method = 'linear'
-    threshold_fwm = 50
-    n_points = 500
-    n_points_min = 4
-    accuracy_param = {'is_analytic': flag_analytic, 'points_not_interp': num_computed_values, 'kind_interp': interp_method,
-                      'th_fwm': threshold_fwm, 'n_points': n_points, 'n_points_min': n_points_min}
-
-    # Parallelization Parameters
-    n_cores = 1
-
-    # Spectrum parameters
-    num_ch = 95
-    rs = np.ones(num_ch) * 0.032
-    b_ch = rs            # For root raised cosine shapes, the -3 dB band is equal to the symbol rate
-    roll_off = np.ones(num_ch) * 0.05
-    power = np.ones(num_ch) * 0.001
-    central_freq = 193.5
-    if num_ch % 2 == 1:  # odd number of channels
-        fch = np.arange(-(num_ch // 2), (num_ch // 2) + 1, 1) * 0.05  # noqa: E501
-    else:
-        fch = (np.arange(0, num_ch) - (num_ch / 2.0) + 0.5) * 0.05
-    spectrum_param = {'num_ch': num_ch, 'f_ch': fch, 'b_ch': b_ch, 'roll_off': roll_off, 'power': power}
-
-    # Fiber Parameters
-    beta2 = 21.27
-    l_span = 100.0
-    loss = 0.2
-    gam = 1.27
-    fiber_param = {'alpha': loss, 'span_length': l_span, 'beta_2': beta2, 'gamma': gam}
-
-    # EDFA Parameters
-    noise_fig = 5.5
-    gain_zero = 25.0
-    gain_tilting = 0.5
-
-    # Compute the GN model
-    t = time.time()
-    nli_cmp, f_nli_cmp, nli_int, f_nli_int = gn.gn_model(spectrum_param, fiber_param, accuracy_param, n_cores)  # noqa: E501
-    print('Elapsed: %s' % (time.time() - t))
-
-    # Compute the EDFA profile
-    gain, g_ase = gn.compute_edfa_profile(gain_zero, gain_tilting, noise_fig, central_freq, fch)
-
-    # Compute the raised cosine comb
-    f1_array = np.linspace(np.amin(fch), np.amax(fch), 1e3)
-    gtx = gn.raised_cosine_comb(f1_array, rs, roll_off, fch, power)
-    gtx = gtx + 10 ** -6  # To avoid log10 issues.
-
-    # Plot the results
-    plt.figure(1)
-    plt.plot(f1_array, 10 * np.log10(gtx), '-b', label='WDM comb')
-    plt.plot(f_nli_cmp, 10 * np.log10(nli_cmp), 'ro', label='GNLI computed')
-    plt.plot(f_nli_int, 10 * np.log10(nli_int), 'g+', label='GNLI interpolated')
-    plt.plot(fch, 10 * np.log10(g_ase), 'yo', label='GASE')
-    plt.ylabel('PSD [dB(W/THz)]')
-    plt.xlabel('f [THz]')
-    plt.legend(loc='upper left')
-    plt.grid()
-    plt.draw()
-    plt.show()
-
-
-if __name__ == '__main__':
-    main()

gnpy/__main_ole__.py

@@ -1,84 +0,0 @@
-import os
-import gnpy as gn
-import numpy as np
-import matplotlib.pyplot as plt
-import time
-
-
-def main_ole():
-
-    # String indicating the folder in which outputs will be saved
-    string_date_time = time.strftime("%Y-%m-%d") + '_' + time.strftime("%H-%M-%S")
-    output_path = './output/' + string_date_time + '/'
-
-    # Creates the directory if it doesn't exist
-    if not os.path.isdir(output_path):
-        os.makedirs(output_path)
-
-    from configuration.fiber_parameters import fibers
-    from configuration.general_parameters import sys_param, control_param
-    from configuration.link_description import link
-    from input.spectrum_in import spectrum
-
-    # adapt the laser position to the grid
-    if len(spectrum['laser_position']) < sys_param['ns']:
-        n = sys_param['ns'] - len(spectrum['laser_position'])
-        missing_zeros = [0 for _ in range(n)]
-        spectrum['laser_position'] += missing_zeros
-    elif len(spectrum['laser_position']) > sys_param['ns']:
-        print('Error: the spectrum definition requires a larger number of slots ns in the spectrum grid')
-
-    delta_f = 6.25E-3
-    f_0 = sys_param['f0']
-    f_cent = f_0 + ((sys_param['ns'] // 2.0) * delta_f)
-
-    n_ch = spectrum['laser_position'].count(1)
-    # Get comb parameters
-    f_ch = np.zeros(n_ch)
-    count = 0
-    for index, bool_laser in enumerate(spectrum['laser_position']):
-        if bool_laser:
-            f_ch[count] = delta_f * index + (f_0 - f_cent)
-            count += 1
-
-    t = time.time()
-    # It runs the OLE
-    osnr_nl_db, osnr_lin_db = gn.ole(spectrum, link, fibers, sys_param, control_param, output_path=output_path)
-    print('Elapsed: %s' % (time.time() - t))
-
-    # Compute the raised cosine comb
-    power, rs, roll_off, p_ase, p_nli, n_ch = gn.get_spectrum_param(spectrum)
-    f1_array = np.linspace(np.amin(f_ch), np.amax(f_ch), 1e3)
-    gtx = gn.raised_cosine_comb(f1_array, rs, roll_off, f_ch, power)
-    gtx = gtx + 10 ** -6  # To avoid log10 issues.
-
-    # OSNR at in the central channel
-    ind_c = n_ch // 2
-    osnr_lin_central_db = osnr_lin_db[ind_c]
-    osnr_nl_central_db = osnr_nl_db[ind_c]
-    print('The linear OSNR in the central channel is: ' + str(osnr_lin_central_db) + ' dB')
-    print('The non linear OSNR in the central channel is: ' + str(osnr_nl_central_db) + ' dB')
-
-    # Plot the results
-    plt.figure(1)
-    plt.plot(f1_array, 10 * np.log10(gtx), '-b', label='WDM comb PSD [dB(W/THz)]')
-    plt.plot(f_ch, 10 * np.log10(p_nli), 'ro', label='NLI [dBw]')
-    plt.plot(f_ch, 10 * np.log10(p_ase), 'g+', label='ASE noise [dBw]')
-    plt.ylabel('')
-    plt.xlabel('f [THz]')
-    plt.legend(loc='upper right')
-    plt.grid()
-    plt.draw()
-
-    plt.figure(2)
-    plt.plot(f_ch, osnr_nl_db, 'ro', label='non-linear OSNR')
-    plt.plot(f_ch, osnr_lin_db, 'g+', label='linear OSNR')
-    plt.ylabel('OSNR [dB]')
-    plt.xlabel('f [THz]')
-    plt.legend(loc='lower left')
-    plt.grid()
-    plt.show()
-
-
-if __name__ == '__main__':
-    main_ole()

gnpy/cli.py

@@ -1,17 +0,0 @@
-# -*- coding: utf-8 -*-
-
-"""Console script for gnpy."""
-
-import click
-
-
-@click.command()
-def main(args=None):
-    """Console script for gnpy."""
-    click.echo("Replace this message by putting your code into "
-               "gnpy.cli.main")
-    click.echo("See click documentation at http://click.pocoo.org/")
-
-
-if __name__ == "__main__":
-    main()

gnpy/configuration/__init__.py

@@ -1 +0,0 @@
- 

gnpy/configuration/fiber_parameters.py

@@ -1,32 +0,0 @@
-# coding=utf-8
-""" fiber_parameters.py describes the fiber parameters.
-    fibers is a dictionary containing a dictionary for each kind of fiber
-    each dictionary has to report:
-        reference_frequency: the frequency at which the parameters are evaluated [THz]
-        alpha: the attenuation coefficient [dB/km]
-        alpha_1st: the first derivative of alpha indicating the alpha slope [dB/km/THz]
-                if you assume a flat attenuation with respect to the frequency you put it as zero
-        beta_2: the dispersion coefficient [ps^2/km]
-        n_2: second-order nonlinear refractive index [m^2/W]
-            a typical value is 2.5E-20 m^2/W
-        a_eff: the effective area of the fiber [um^2]
-"""
-
-fibers = {
-    'SMF': {
-        'reference_frequency': 193.5,
-        'alpha': 0.2,
-        'alpha_1st': 0,
-        'beta_2': 21.27,
-        'n_2': 2.5E-20,
-        'a_eff': 77.77,
-    },
-    'NZDF': {
-        'reference_frequency': 193.5,
-        'alpha': 0.22,
-        'alpha_1st': 0,
-        'beta_2': 21,
-        'n_2': 2.5E-20,
-        'a_eff': 70,
-    }
-}

gnpy/configuration/general_parameters.py

@@ -1,40 +0,0 @@
-# -*- coding: utf-8 -*
-"""general_parameters.py contains the general configuration settings
-
-    The sectings are subdivided in two dictionaries:
-        sys_param: a dictionary containing the general system parameters:
-            f0: the starting frequency of the laser grid used to describe the WDM system [THz]
-            ns: the number of 6.25 GHz slots in the grid
-
-        control_param:
-            save_each_comp: a boolean flag. If true, it saves in output folder one spectrum file at the output of each
-                            component, otherwise it saves just the last spectrum
-            is_linear: a bool flag. If true, is doesn't compute NLI, if false, OLE will consider NLI
-            is_analytic: a boolean flag. If true, the NLI is computed through the analytic formula, otherwise it uses
-                the double integral. Warning: the double integral is very slow.
-            points_not_interp: if the double integral is used, it indicates how much points are calculated, others will
-                be interpolated
-            kind_interp: a string indicating the interpolation method for the double integral
-            th_fwm: the threshold of the four wave mixing efficiency for the double integral
-            n_points: number of points in which the double integral is computed in the high FWM efficiency region
-            n_points_min: number of points in which the double integral is computed in the low FWM efficiency region
-            n_cores: number of cores for parallel computation [not yet implemented]
-"""
-# System parameters
-sys_param = {
-    'f0': 192.075,
-    'ns': 328
-}
-
-# control parameters
-control_param = {
-    'save_each_comp': True,
-    'is_linear': False,
-    'is_analytic': True,
-    'points_not_interp': 2,
-    'kind_interp': 'linear',
-    'th_fwm': 50,
-    'n_points': 500,
-    'n_points_min': 4,
-    'n_cores': 1
-}

gnpy/configuration/link_description.py

@@ -1,59 +0,0 @@
-# coding=utf-8
-""" link_description.py contains the full description of that OLE has to emulate.
-    It contains a list of dictionaries, following the structure of the link and each element of the list describes one
-    component.
-
-    'comp_cat': the kind of link component:
-        PC: a passive component defined by a loss at a certain frequency and a loss tilt
-        OA: an optical amplifier defined by a gain at a certain frequency, a gain tilt and a noise figure
-        fiber: a span of fiber described by the type and the length
-    'comp_id': is an id identifying the component. It has to be unique for each component!
-
-    extra fields for PC:
-        'ref_freq': the frequency at which the 'loss' parameter is evaluated [THz]
-        'loss': the loss at the frequency 'ref_freq' [dB]
-        'loss_tlt': the frequency dependent loss [dB/THz]
-    extra fields for OA:
-        'ref_freq': the frequency at which the 'gain' parameter is evaluated [THz]
-        'gain': the gain at the frequency 'ref_freq' [dB]
-        'gain_tlt': the frequency dependent gain [dB/THz]
-        'noise_figure': the noise figure of the optical amplifier [dB]
-    extra fields for fiber:
-        'fiber_type': a string calling the type of fiber described in the file fiber_parameters.py
-        'length': the fiber length [km]
-
-"""
-smf = {
-    'comp_cat': 'fiber',
-    'comp_id': '',
-    'fiber_type': 'SMF',
-    'length': 100
-    }
-
-oa = {
-    'comp_cat': 'OA',
-    'comp_id': '',
-    'ref_freq': 193.5,
-    'gain': 20,
-    'gain_tlt': 0.0,
-    'noise_figure': 5
-    }
-
-pc = {
-    'comp_cat': 'PC',
-    'comp_id': '04',
-    'ref_freq': 193.,
-    'loss': 2.0,
-    'loss_tlt': 0.0
-    }
-
-link = []
-
-for index in range(20):
-    smf['comp_id'] = '%03d' % (2 * index)
-    oa['comp_id'] = '%03d' % (2 * index + 1)
-    link += [dict(smf)]
-    link += [dict(oa)]
-
-pc['comp_id'] = '%03d' % 40
-link += [dict(pc)]

gnpy/core/__init__.py

@@ -0,0 +1,9 @@
+"""
+Simulation of signal propagation in the DWDM network
+
+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`.
+"""

gnpy/core/ansi_escapes.py

@@ -0,0 +1,20 @@
+#!/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/equipment.py

@@ -0,0 +1,137 @@
+#!/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
+
+
+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.
+    """
+    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')
+
+    trx_params = {**default_trx_params}
+    return trx_params
+
+
+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.
+
+    Returns:
+    str: an amplifier type variety
+    """
+    listes = find_type_varieties(amps, equipment)
+
+    _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.
+    """
+    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]

gnpy/core/exceptions.py

@@ -0,0 +1,42 @@
+#!/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"""
+
+
+class EquipmentConfigError(ConfigurationError):
+    """Incomplete or wrong configuration within the equipment library"""
+
+
+class NetworkTopologyError(ConfigurationError):
+    """Topology of user-provided network is wrong"""
+
+
+class ServiceError(Exception):
+    """Service of user-provided request is wrong"""
+
+
+class DisjunctionError(ServiceError):
+    """Disjunction of user-provided request can not be satisfied"""
+
+
+class SpectrumError(Exception):
+    """Spectrum errors of the program"""
+
+
+class ParametersError(ConfigurationError):
+    """Incomplete or wrong configurations within parameters json"""

gnpy/core/info.py

@@ -0,0 +1,433 @@
+#!/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)"""
+
+
+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 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
+
+
+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
+
+
+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 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
+
+
+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

gnpy/core/parameters.py

@@ -0,0 +1,731 @@
+#!/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/science_utils.py

@@ -0,0 +1,735 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# SPDX-License-Identifier: BSD-3-Clause
+# gnpy.core.science_utils: Solver definitions to calculate the Raman effect and the nonlinear interference noise
+# Copyright (C) 2025 Telecom Infra Project and GNPy contributors
+# see AUTHORS.rst for a list of contributors
+
+"""
+gnpy.core.science_utils
+=======================
+
+Solver definitions to calculate the Raman effect and the nonlinear interference noise
+
+The solvers take as input instances of the spectral information, the fiber and the simulation parameters
+"""
+
+from numpy import interp, pi, zeros, cos, array, append, ones, exp, arange, sqrt, trapz, arcsinh, clip, abs, sum, \
+    concatenate, flip, outer, inner, transpose, max, format_float_scientific, diag, sort, unique, argsort, cumprod, \
+    polyfit, log, reshape, swapaxes, full, nan, cumsum
+from logging import getLogger
+from scipy.constants import k, h
+from scipy.interpolate import interp1d
+from math import isclose, factorial
+
+from gnpy.core.utils import db2lin, lin2db
+from gnpy.core.exceptions import EquipmentConfigError, ParametersError
+from gnpy.core.parameters import SimParams
+from gnpy.core.info import SpectralInformation
+
+logger = getLogger(__name__)
+sim_params = SimParams()
+
+
+def raised_cosine(frequency, channel_frequency, channel_baud_rate, channel_roll_off):
+    """Returns a unitary raised cosine profile for the given parame
+
+    :param frequency: numpy array of frequencies in Hz for the resulting raised cosine
+    :param channel_frequency: channel frequencies in Hz
+    :param channel_baud_rate: channel baud rate in Hz
+    :param channel_roll_off: channel roll off
+    """
+    raised_cosine_mask = zeros(frequency.size)
+    base_frequency = frequency - channel_frequency
+    ts = 1 / channel_baud_rate
+    pass_band = (1 - channel_roll_off) * channel_baud_rate / 2
+    stop_band = (1 + channel_roll_off) * channel_baud_rate / 2
+
+    flat_condition = (abs(base_frequency) <= pass_band) == 1
+    cosine_condition = (pass_band < abs(base_frequency)) * (abs(base_frequency) < stop_band) == 1
+
+    raised_cosine_mask[flat_condition] = 1
+    raised_cosine_mask[cosine_condition] = \
+        0.5 * (1 + cos(pi * ts / channel_roll_off * (abs(base_frequency[cosine_condition]) - pass_band)))
+    return raised_cosine_mask
+
+
+class StimulatedRamanScattering:
+    def __init__(self, power_profile, loss_profile, frequency, z):
+        """
+        :params power_profile: power profile matrix along frequency and z [W]
+        :params loss_profile: power profile matrix along frequency and z [linear units]
+        :params frequency: channels frequencies array [Hz]
+        :params z: positions array [m]
+        """
+        self.power_profile = power_profile
+        self.loss_profile = loss_profile
+        # Field loss profile matrix along frequency and z
+        self.rho = sqrt(loss_profile)
+        self.frequency = frequency
+        self.z = z
+
+
+class RamanSolver:
+    """This class contains the methods to calculate the Raman scattering effect."""
+
+    @staticmethod
+    def _create_lumped_losses(z, lumped_losses, z_lumped_losses):
+        lumped_losses = concatenate((lumped_losses, ones(z.size)))
+        z, unique_indices = unique(concatenate((z_lumped_losses, z)), return_index=True)
+        order = argsort(z)
+        lumped_losses = (lumped_losses[unique_indices])[order]
+        z = z[order]
+        return z, lumped_losses
+
+    @staticmethod
+    def calculate_attenuation_profile(spectral_info: SpectralInformation, fiber):
+        """Evaluates the attenuation profile along the z axis for all the frequency propagating in the
+        fiber without considering the stimulated Raman scattering.
+        """
+        # z array definition
+        z = array([0, fiber.params.length])
+
+        # Lumped losses array definition
+        z, lumped_losses = RamanSolver._create_lumped_losses(z, fiber.lumped_losses, fiber.z_lumped_losses)
+
+        lumped_loss_acc = cumprod(lumped_losses)
+        frequency = spectral_info.frequency
+        alpha = fiber.alpha(frequency)
+        loss_profile = exp(- outer(alpha, z)) * lumped_loss_acc
+        power_profile = outer(spectral_info.signal, ones(z.size)) * loss_profile
+        return StimulatedRamanScattering(power_profile, loss_profile, spectral_info.frequency, z)
+
+    @staticmethod
+    def calculate_stimulated_raman_scattering(spectral_info: SpectralInformation, fiber):
+        """Evaluates the Raman profile along the z axis for all the frequency propagated in the fiber
+        including the Raman pumps co- and counter-propagating
+        """
+        logger.debug('Start computing fiber Stimulated Raman Scattering')
+
+        if sim_params.raman_params.flag:
+            # Raman parameters
+            z_resolution = sim_params.raman_params.result_spatial_resolution
+            z_step = sim_params.raman_params.solver_spatial_resolution
+            z = append(arange(0, fiber.params.length, z_step), fiber.params.length)
+            z_final = append(arange(0, fiber.params.length, z_resolution), fiber.params.length)
+            z_final = sort(unique(concatenate((fiber.z_lumped_losses, z_final))))
+
+            # Lumped losses array definition
+            z, lumped_losses = RamanSolver._create_lumped_losses(z, fiber.lumped_losses, fiber.z_lumped_losses)
+
+            if hasattr(fiber, 'raman_pumps'):
+                # TODO: verify co-propagating pumps computation and in general unsorted frequency
+                # Co-propagating spectrum definition
+                co_raman_pump_power = array([pump.power for pump in fiber.raman_pumps
+                                             if pump.propagation_direction == 'coprop'])
+                co_raman_pump_frequency = array([pump.frequency for pump in fiber.raman_pumps
+                                                 if pump.propagation_direction == 'coprop'])
+
+                co_power = concatenate((spectral_info.signal, co_raman_pump_power))
+                co_frequency = concatenate((spectral_info.frequency, co_raman_pump_frequency))
+
+                # Counter-propagating spectrum definition
+                cnt_power = array([pump.power for pump in fiber.raman_pumps
+                                   if pump.propagation_direction == 'counterprop'])
+                cnt_frequency = array([pump.frequency for pump in fiber.raman_pumps
+                                       if pump.propagation_direction == 'counterprop'])
+                # Co-propagating profile initialization
+                co_power_profile = zeros([co_frequency.size, z.size])
+                if co_frequency.size:
+                    co_cr = fiber.cr(co_frequency)
+                    co_alpha = fiber.alpha(co_frequency)
+                    co_power_profile = \
+                        RamanSolver.calculate_unidirectional_stimulated_raman_scattering(co_power, co_alpha, co_cr, z,
+                                                                                         lumped_losses)
+                # Counter-propagating profile initialization
+                cnt_power_profile = zeros([cnt_frequency.size, z.size])
+                if cnt_frequency.size:
+                    cnt_cr = fiber.cr(cnt_frequency)
+                    cnt_alpha = fiber.alpha(cnt_frequency)
+                    cnt_power_profile = flip(
+                        RamanSolver.calculate_unidirectional_stimulated_raman_scattering(cnt_power, cnt_alpha, cnt_cr,
+                                                                                         z[-1] - flip(z),
+                                                                                         flip(lumped_losses)), axis=1)
+                # Co-propagating and Counter-propagating Profile Computation
+                if co_frequency.size and cnt_frequency.size:
+                    co_power_profile, cnt_power_profile = \
+                        RamanSolver.iterative_algorithm(co_power_profile, cnt_power_profile,
+                                                        co_frequency, cnt_frequency, z, fiber, lumped_losses)
+                # Complete Power Profile
+                power_profile = concatenate((co_power_profile, cnt_power_profile), axis=0)
+                # Complete Loss Profile
+                co_loss_profile = co_power_profile / outer(co_power, ones(z.size))
+                cnt_loss_profile = cnt_power_profile / outer(cnt_power, ones(z.size))
+                loss_profile = concatenate((co_loss_profile, cnt_loss_profile), axis=0)
+                # Complete frequency
+                frequency = concatenate((co_frequency, cnt_frequency))
+            else:
+                # Without Raman pumps
+                alpha = fiber.alpha(spectral_info.frequency)
+                cr = fiber.cr(spectral_info.frequency)
+                # Power profile
+                power_profile = (
+                    RamanSolver.calculate_unidirectional_stimulated_raman_scattering(spectral_info.signal, alpha, cr, z,
+                                                                                     lumped_losses))
+                # Loss profile
+                loss_profile = power_profile / outer(spectral_info.signal, ones(z.size))
+                frequency = spectral_info.frequency
+            power_profile = interp1d(z, power_profile, axis=1)(z_final)
+            loss_profile = interp1d(z, loss_profile, axis=1)(z_final)
+            stimulated_raman_scattering = StimulatedRamanScattering(power_profile, loss_profile, frequency, z_final)
+        else:
+            stimulated_raman_scattering = \
+                RamanSolver.calculate_attenuation_profile(spectral_info, fiber)
+        return stimulated_raman_scattering
+
+    @staticmethod
+    def calculate_spontaneous_raman_scattering(spectral_info: SpectralInformation, srs: StimulatedRamanScattering,
+                                               fiber):
+        """Evaluates the Raman profile along the z axis for all the frequency propagated in the fiber
+        including the Raman pumps co- and counter-propagating.
+        """
+        logger.debug('Start computing fiber Spontaneous Raman Scattering')
+        z = srs.z
+        baud_rate = spectral_info.baud_rate
+        frequency = spectral_info.frequency
+        channels_loss = srs.loss_profile[:spectral_info.number_of_channels, :]
+
+        # calculate ase power
+        ase = zeros(spectral_info.number_of_channels)
+        cr = fiber.cr(srs.frequency)[:spectral_info.number_of_channels, spectral_info.number_of_channels:]
+        for i, pump in enumerate(fiber.raman_pumps):
+            pump_power = srs.power_profile[spectral_info.number_of_channels + i, :]
+            df = pump.frequency - frequency
+            eta = - 1 / (1 - exp(h * df / (k * fiber.temperature)))
+            integral = trapz(pump_power / channels_loss, z, axis=1)
+            ase += 2 * h * baud_rate * frequency * (1 + eta) * cr[:, i] * (df > 0) * integral  # 2 factor for double pol
+        return ase
+
+    @staticmethod
+    def calculate_unidirectional_stimulated_raman_scattering(power_in, alpha, cr, z, lumped_losses):
+        """Solves the Raman equation
+
+        :param power_in: launch power array
+        :param alpha: loss coefficient array
+        :param cr: Raman efficiency coefficients matrix
+        :param z: z position array
+        :param lumped_losses: concentrated losses array along the fiber span
+        :return: power profile matrix
+        """
+        if sim_params.raman_params.method == 'perturbative':
+            if sim_params.raman_params.order > 4:
+                raise ValueError(f'Order {sim_params.raman_params.order} not implemented in Raman Solver.')
+            z_lumped_losses = append(z[lumped_losses != 1], z[-1])
+            llumped_losses = append(1, lumped_losses[lumped_losses != 1])
+            power = outer(power_in, ones(z.size))
+            last_position = 0
+            z_indices = arange(0, z.size)
+
+            for z_lumped_loss, lumped_loss in zip(z_lumped_losses, llumped_losses):
+                if last_position < z[-1]:
+                    interval = z_indices[(z >= last_position) * (z <= z_lumped_loss) == 1]
+                    z_interval = z[interval] - last_position
+                    dz = z_interval[1:] - z_interval[:-1]
+                    last_position = z[interval][-1]
+                    p0 = power_in * lumped_loss
+                    power_interval = outer(p0, ones(z_interval.size))
+                    alphaz = outer(alpha, z_interval)
+                    expz = exp(- alphaz)
+                    eff_length = 1 / outer(alpha, ones(z_interval.size)) * (1 - expz)
+                    crpz = transpose(ones([z_interval.size, cr.shape[0], cr.shape[1]]) * cr * p0, (1, 2, 0))
+                    exponent = - alphaz
+                    if sim_params.raman_params.order >= 1:
+                        gamma1 = sum(crpz * eff_length, 1)
+                        exponent += gamma1
+                    if sim_params.raman_params.order >= 2:
+                        z_integrand = expz * gamma1
+                        z_integral = cumsum((z_integrand[:, :-1] + z_integrand[:, 1:]) / 2 * dz, 1)
+                        gamma2 = zeros(gamma1.shape)
+                        gamma2[:, 1:] = sum(crpz[:, :, 1:] * z_integral, 1)
+                        exponent += gamma2
+                    if sim_params.raman_params.order >= 3:
+                        z_integrand = expz * (gamma2 + 1/2 * gamma1**2)
+                        z_integral = cumsum((z_integrand[:, :-1] + z_integrand[:, 1:]) / 2 * dz, 1)
+                        gamma3 = zeros(gamma1.shape)
+                        gamma3[:, 1:] = sum(crpz[:, :, 1:] * z_integral, 1)
+                        exponent += gamma3
+                    if sim_params.raman_params.order >= 4:
+                        z_integrand = expz * (gamma3 + gamma1 * gamma2 + 1/factorial(3) * gamma1**3)
+                        z_integral = cumsum((z_integrand[:, :-1] + z_integrand[:, 1:]) / 2 * dz, 1)
+                        gamma4 = zeros(gamma1.shape)
+                        gamma4[:, 1:] = sum(crpz[:, :, 1:] * z_integral, 1)
+                        exponent += gamma4
+                    power_interval *= exp(exponent)
+                    power[:, interval[1:]] = power_interval[:, 1:]
+                    power_in = power_interval[:, -1]
+        elif sim_params.raman_params.method == 'numerical':
+            dz = z[1:] - z[:-1]
+            power = outer(power_in, ones(z.size))
+            for i in range(1, z.size):
+                power[:, i] = (power[:, i - 1] * (1 + (- alpha + sum(cr * power[:, i - 1], 1)) * dz[i - 1]) *
+                               lumped_losses[i - 1])
+        else:
+            raise ValueError(f'Method {sim_params.raman_params.method} not implemented in Raman Solver.')
+        return power
+
+    @staticmethod
+    def iterative_algorithm(co_initial_guess_power, cnt_initial_guess_power, co_frequency, cnt_frequency, z, fiber,
+                            lumped_losses):
+        """Solves the Raman equation in case of both co- and counter-propagating frequencies
+
+        :param co_initial_guess_power: co-propagationg Raman first order derivative equation solution
+        :param cnt_initial_guess_power: counter-propagationg Raman first order derivative equation solution
+        :param co_frequency: co-propagationg frequencies
+        :param cnt_frequency: counter-propagationg frequencies
+        :param z: z position array
+        :param fiber: instance of gnpy.core.elements.Fiber or gnpy.core.elements.RamanFiber
+        :param lumped_losses: concentrated losses array along the fiber span
+        :return: co- and counter-propagatng power profile matrix
+        """
+        logger.debug('  Start iterative algorithm')
+        residue = 1
+        residue_tol = 1e-6
+        accuracy = 1
+        accuracy_tol = 1e-3
+        iteration = 0
+        num_max_iter = 1000
+        prev_power = concatenate((co_initial_guess_power, cnt_initial_guess_power))
+        frequency = concatenate((co_frequency, cnt_frequency))
+        dz = z[1:] - z[:-1]
+        cr = fiber.cr(frequency)
+        alpha = fiber.alpha(frequency)
+        next_power = array(prev_power)
+        while residue > residue_tol and accuracy > accuracy_tol and iteration < num_max_iter:
+            iteration += 1
+            for i in range(1, z.size):
+                dpdz = - alpha + sum(cr * next_power[:, i - 1], 1)
+                next_power[:co_frequency.size, i] = \
+                    next_power[:co_frequency.size, i - 1] * (1 + dpdz[:co_frequency.size] * dz[i - 1]) * \
+                    lumped_losses[i - 1]
+            for i in range(1, z.size):
+                dpdz = - alpha + sum(cr * next_power[:, -i], 1)
+                next_power[co_frequency.size:, -i - 1] = \
+                    next_power[co_frequency.size:, -i] * (1 + dpdz[co_frequency.size:] * dz[-i]) * \
+                    lumped_losses[-i]
+
+            dpdz_num = (next_power[:co_frequency.size, 1:] - next_power[:co_frequency.size, :-1]) / dz
+            dpdz_exp = next_power[:co_frequency.size, :-1] * \
+                (- outer(alpha, ones(z.size)) + inner(cr, transpose(next_power)))[:co_frequency.size, :-1] * \
+                lumped_losses[:-1]
+
+            residue = max(abs((next_power - prev_power) / next_power))
+            accuracy = max(abs((dpdz_exp - dpdz_num) / dpdz_exp))
+            prev_power = array(next_power)
+            logger.debug(f'     Iteration: {iteration}  Accuracy: {format_float_scientific(accuracy, precision=3)}')
+        return next_power[:co_frequency.size, :], next_power[co_frequency.size:, :]
+
+
+class NliSolver:
+    """This class implements the NLI models.
+    Model and method can be specified in `sim_params.nli_params.method`.
+    List of implemented methods:
+    'gn_model_analytic': eq. 120 from arXiv:1209.0394
+    'ggn_spectrally_separated': eq. 21 from arXiv: 1710.02225
+    'ggn_approx': eq. 24-25 jlt:9741324
+    """
+
+    SPM_WEIGHT = (16.0 / 27.0)
+    XPM_WEIGHT = 2 * (16.0 / 27.0)
+
+    @staticmethod
+    def effective_length(alpha, length):
+        """The effective length identify the region in which the NLI has a significant contribution to
+        the signal degradation.
+        """
+        return (1 - exp(- alpha * length)) / alpha
+
+    @staticmethod
+    def compute_nli(spectral_info: SpectralInformation, srs: StimulatedRamanScattering, fiber):
+        """Compute NLI power generated by the WDM comb `*carriers` on the channel under test `carrier`
+        at the end of the fiber span.
+        """
+        logger.debug('Start computing fiber NLI noise')
+
+        if 'gn_model_analytic' == sim_params.nli_params.method:
+            eta = NliSolver._gn_analytic(spectral_info, fiber)
+
+            cut_power = outer(spectral_info.signal, ones(spectral_info.number_of_channels))
+            pump_power = outer(ones(spectral_info.number_of_channels), spectral_info.signal)
+            nli_matrix = cut_power * pump_power ** 2 * eta
+            nli = sum(nli_matrix, 1)
+        elif 'ggn_spectrally_separated' in sim_params.nli_params.method:
+            if sim_params.nli_params.computed_channels is not None:
+                cut_indices = array(sim_params.nli_params.computed_channels) - 1
+            elif sim_params.nli_params.computed_number_of_channels is not None:
+                nb_ch_computed = sim_params.nli_params.computed_number_of_channels
+                nb_ch = len(spectral_info.channel_number)
+                cut_indices = array([round(i * (nb_ch - 1) / (nb_ch_computed - 1)) for i in range(0, nb_ch_computed)])
+            else:
+                cut_indices = array(spectral_info.channel_number) - 1
+
+            eta = NliSolver._ggn_spectrally_separated(cut_indices, spectral_info, fiber, srs)
+
+            # Interpolation over the channels not indicated as compted channels in simulation parameters
+            cut_power = outer(spectral_info.signal[cut_indices], ones(spectral_info.number_of_channels))
+            cut_frequency = spectral_info.frequency[cut_indices]
+            pump_power = outer(ones(cut_indices.size), spectral_info.signal)
+            cut_baud_rate = outer(spectral_info.baud_rate[cut_indices], ones(spectral_info.number_of_channels))
+
+            g_nli = eta * cut_power * pump_power**2 / cut_baud_rate
+            g_nli = sum(g_nli, 1)
+            g_nli = interp(spectral_info.frequency, cut_frequency, g_nli)
+            nli = spectral_info.baud_rate * g_nli  # Local white noise
+        elif 'ggn_approx' in sim_params.nli_params.method:
+            if sim_params.nli_params.computed_channels is not None:
+                cut_indices = array(sim_params.nli_params.computed_channels) - 1
+            elif sim_params.nli_params.computed_number_of_channels is not None:
+                nb_ch_computed = sim_params.nli_params.computed_number_of_channels
+                nb_ch = len(spectral_info.channel_number)
+                cut_indices = array([round(i * (nb_ch - 1) / (nb_ch_computed - 1)) for i in range(0, nb_ch_computed)])
+            else:
+                cut_indices = array(spectral_info.channel_number) - 1
+
+            eta = NliSolver._ggn_approx(cut_indices, spectral_info, fiber, srs)
+
+            # Interpolation over the channels not indicated as computed channels in simulation parameters
+            cut_power = outer(spectral_info.signal[cut_indices], ones(spectral_info.number_of_channels))
+            cut_frequency = spectral_info.frequency[cut_indices]
+            pump_power = outer(ones(cut_indices.size), spectral_info.signal)
+            cut_baud_rate = outer(spectral_info.baud_rate[cut_indices], ones(spectral_info.number_of_channels))
+
+            g_nli = eta * cut_power * pump_power ** 2 / cut_baud_rate
+            g_nli = sum(g_nli, 1)
+            g_nli = interp(spectral_info.frequency, cut_frequency, g_nli)
+            nli = spectral_info.baud_rate * g_nli  # Local white noise
+        else:
+            raise ValueError(f'Method {sim_params.nli_params.method} not implemented.')
+
+        return nli
+
+    # Methods for computing GN-model eta matrix
+    @staticmethod
+    def _gn_analytic(spectral_info, fiber, spm_weight=SPM_WEIGHT, xpm_weight=XPM_WEIGHT):
+        """Computes the nonlinear interference power evaluated at the fiber input.
+        The method uses eq. 120 from arXiv:1209.0394
+        """
+        # Spectral Features
+        nch = spectral_info.number_of_channels
+        frequency = spectral_info.frequency
+        baud_rate = spectral_info.baud_rate
+        delta_frequency = spectral_info.df
+
+        # Physical fiber parameters
+        alpha = fiber.alpha(frequency)
+        beta2 = fiber.beta2(frequency)
+        gamma = outer(fiber.gamma(frequency), ones(nch))
+        length = fiber.params.length
+
+        identity = diag(ones(nch))
+        weight = spm_weight * identity + xpm_weight * (ones([nch, nch]) - identity)
+
+        effective_length = NliSolver.effective_length(alpha, length)
+        asymptotic_length = 1 / alpha
+
+        cut_baud_rate = outer(baud_rate, ones(nch))
+        pump_baud_rate = outer(ones(nch), baud_rate)
+
+        psi = NliSolver._psi(delta_frequency, baud_rate, beta2, effective_length, asymptotic_length)
+        eta_cut_central_frequency = gamma ** 2 * weight * psi / (cut_baud_rate * pump_baud_rate ** 2)
+        eta = cut_baud_rate * eta_cut_central_frequency  # Local white noise
+        return eta
+
+    @staticmethod
+    def _psi(df, baud_rate, beta2, effective_length, asymptotic_length):
+        """Calculates eq. 123 from `arXiv:1209.0394 <https://arxiv.org/abs/1209.0394>`__"""
+        cut_baud_rate = outer(baud_rate, ones(baud_rate.size))
+        cut_beta = outer(beta2, ones(baud_rate.size))
+        pump_baud_rate = baud_rate
+        pump_beta = outer(ones(baud_rate.size), beta2)
+        beta2 = (cut_beta + pump_beta) / 2
+        right_extreme = df + pump_baud_rate / 2
+        left_extreme = df - pump_baud_rate / 2
+        psi = (arcsinh(pi ** 2 * asymptotic_length * abs(beta2) * cut_baud_rate * right_extreme) -
+               arcsinh(pi ** 2 * asymptotic_length * abs(beta2) * cut_baud_rate * left_extreme)) / 2
+        psi *= effective_length ** 2 / (2 * pi * abs(beta2) * asymptotic_length)
+        return psi
+
+    # Methods for computing the GGN-model eta matrix
+    @staticmethod
+    def _ggn_spectrally_separated(cut_indices, spectral_info, fiber, srs, spm_weight=SPM_WEIGHT, xpm_weight=XPM_WEIGHT):
+        """Computes the nonlinear interference power evaluated at the fiber input.
+        The method uses eq. 21 from arXiv: 1710.02225
+        """
+        # Spectral Features
+        nch = spectral_info.number_of_channels
+        frequency = spectral_info.frequency
+        baud_rate = spectral_info.baud_rate
+        slot_width = spectral_info.slot_width
+        roll_off = spectral_info.roll_off
+
+        # Physical fiber parameters
+        alpha = fiber.alpha(frequency)
+        beta2 = fiber.beta2(frequency)
+        gamma = outer(fiber.gamma(frequency[cut_indices]), ones(nch))
+
+        identity = diag(ones(nch))
+        weight = spm_weight * identity + xpm_weight * (ones([nch, nch]) - identity)
+        weight = weight[cut_indices, :]
+
+        dispersion_tolerance = sim_params.nli_params.dispersion_tolerance
+        phase_shift_tolerance = sim_params.nli_params.phase_shift_tolerance
+        max_slot_width = max(slot_width)
+        delta_z = sim_params.raman_params.result_spatial_resolution
+
+        psi_cut_central_frequency = zeros([cut_indices.size, nch])
+        for i, cut_index in enumerate(cut_indices):
+            logger.debug(f'Start computing fiber NLI noise of cut: {cut_index + 1}')
+            cut_frequency = frequency[cut_index]
+            cut_baud_rate = baud_rate[cut_index]
+            cut_roll_off = roll_off[cut_index]
+            cut_number = cut_index + 1
+            cut_beta2 = beta2[cut_index]
+            cut_base_frequency = frequency - cut_frequency
+            cut_beta_coefficients = polyfit(cut_base_frequency, beta2, 2)
+            cut_beta3 = cut_beta_coefficients[1] / (2 * pi)
+
+            for pump_index in range(nch):
+                pump_frequency = frequency[pump_index]
+                pump_baud_rate = baud_rate[pump_index]
+                pump_roll_off = roll_off[pump_index]
+                pump_number = pump_index + 1
+                pump_alpha = alpha[pump_index]
+                dn = abs(pump_number - cut_number)
+                delta_f = abs(cut_frequency - pump_frequency)
+                k_tol = dispersion_tolerance * abs(alpha[pump_index])
+                phi_tol = phase_shift_tolerance / delta_z
+                f_cut_resolution = min(k_tol, phi_tol) / abs(cut_beta2) / (4 * pi ** 2 * (1 + dn) * max_slot_width)
+                f_pump_resolution = min(k_tol, phi_tol) / abs(cut_beta2) / (4 * pi ** 2 * max_slot_width)
+                if cut_index == pump_index:  # SPM
+                    psi_cut_central_frequency[i, pump_index] = \
+                        NliSolver._generalized_psi(cut_frequency, cut_frequency, cut_baud_rate, cut_roll_off,
+                                                   pump_frequency, pump_baud_rate, pump_roll_off, f_cut_resolution,
+                                                   f_pump_resolution, srs, pump_alpha, cut_beta2, cut_beta3,
+                                                   cut_frequency)
+                else:  # XPM
+                    frequency_offset_threshold = NliSolver._frequency_offset_threshold(cut_beta2, pump_baud_rate)
+                    if abs(delta_f) <= frequency_offset_threshold:
+                        psi_cut_central_frequency[i, pump_index] = \
+                            NliSolver._generalized_psi(cut_frequency, cut_frequency, cut_baud_rate, cut_roll_off,
+                                                       pump_frequency, pump_baud_rate, pump_roll_off, f_cut_resolution,
+                                                       f_pump_resolution, srs, pump_alpha, cut_beta2, cut_beta3,
+                                                       cut_frequency)
+                    else:
+                        psi_cut_central_frequency[i, pump_index] = \
+                            NliSolver._fast_generalized_psi(cut_frequency, cut_frequency, cut_baud_rate, cut_roll_off,
+                                                            pump_frequency, pump_baud_rate, pump_roll_off,
+                                                            f_cut_resolution, srs, pump_alpha, cut_beta2, cut_beta3,
+                                                            cut_frequency)
+
+        cut_baud_rate = outer(baud_rate[cut_indices], ones(nch))
+        pump_baud_rate = outer(ones(cut_indices.size), baud_rate)
+
+        eta_cut_central_frequency = \
+            gamma ** 2 * weight * psi_cut_central_frequency / (cut_baud_rate * pump_baud_rate ** 2)
+        eta = cut_baud_rate * eta_cut_central_frequency  # Local white noise
+        return eta
+
+    @staticmethod
+    def _fast_generalized_psi(f_eval, cut_frequency, cut_baud_rate, cut_roll_off, pump_frequency, pump_baud_rate,
+                              pump_roll_off, f_cut_resolution, srs, alpha, beta2, beta3, f_ref_beta):
+        """Computes the generalized psi function similarly to the one used in the GN model."""
+        z = srs.z
+        rho_norm = srs.rho * exp(outer(alpha / 2, z))
+        rho_pump = interp1d(srs.frequency, rho_norm, axis=0)(pump_frequency)
+
+        f1_array = array([pump_frequency - (pump_baud_rate * (1 + pump_roll_off) / 2),
+                          pump_frequency + (pump_baud_rate * (1 + pump_roll_off) / 2)])
+        f2_array = arange(cut_frequency, cut_frequency + (cut_baud_rate * (1 + cut_roll_off) / 2),
+                          f_cut_resolution)  # Only positive f2 is used since integrand_f2 is symmetric
+
+        integrand_f1 = zeros(f1_array.size)
+        for f1_index, f1 in enumerate(f1_array):
+            delta_beta = 4 * pi ** 2 * (f1 - f_eval) * (f2_array - f_eval) * (
+                        beta2 + pi * beta3 * (f1 + f2_array - 2 * f_ref_beta))
+            integrand_f2 = NliSolver._generalized_rho_nli(delta_beta, rho_pump, z, alpha)
+            integrand_f1[f1_index] = 2 * trapz(integrand_f2, f2_array)  # 2x since integrand_f2 is symmetric in f2
+        generalized_psi = 0.5 * sum(integrand_f1) * pump_baud_rate
+        return generalized_psi
+
+    @staticmethod
+    def _generalized_psi(f_eval, cut_frequency, cut_baud_rate, cut_roll_off, pump_frequency, pump_baud_rate,
+                         pump_roll_off, f_cut_resolution, f_pump_resolution, srs, alpha, beta2, beta3, f_ref_beta):
+        """Computes the generalized psi function similarly to the one used in the GN model."""
+        z = srs.z
+        rho_norm = srs.rho * exp(outer(alpha / 2, z))
+        rho_pump = interp1d(srs.frequency, rho_norm, axis=0)(pump_frequency)
+
+        f1_array = arange(pump_frequency - (pump_baud_rate * (1 + pump_roll_off) / 2),
+                          pump_frequency + (pump_baud_rate * (1 + pump_roll_off) / 2),
+                          f_pump_resolution)
+        f2_array = arange(cut_frequency - (cut_baud_rate * (1 + cut_roll_off) / 2),
+                          cut_frequency + (cut_baud_rate * (1 + cut_roll_off) / 2),
+                          f_cut_resolution)
+        rc1 = raised_cosine(f1_array, pump_frequency, pump_baud_rate, pump_roll_off)
+
+        integrand_f1 = zeros(f1_array.size)
+        for i in range(f1_array.size):
+            f3_array = f1_array[i] + f2_array - f_eval
+            rc2 = raised_cosine(f2_array, cut_frequency, cut_baud_rate, cut_roll_off)
+            rc3 = raised_cosine(f3_array, pump_frequency, pump_baud_rate, pump_roll_off)
+            delta_beta = 4 * pi ** 2 * (f1_array[i] - f_eval) * (f2_array - f_eval) * (
+                        beta2 + pi * beta3 * (f1_array[i] + f2_array - 2 * f_ref_beta))
+            integrand_f2 = rc1[i] * rc2 * rc3 * NliSolver._generalized_rho_nli(delta_beta, rho_pump, z, alpha)
+            integrand_f1[i] = trapz(integrand_f2, f2_array)
+        generalized_psi = trapz(integrand_f1, f1_array)
+        return generalized_psi
+
+    @staticmethod
+    def _generalized_rho_nli(delta_beta, rho_pump, z, alpha):
+        w = 1j * delta_beta - alpha
+        generalized_rho_nli = (rho_pump[-1]**2 * exp(w * z[-1]) - rho_pump[0]**2 * exp(w * z[0])) / w
+        for z_ind in range(0, len(z) - 1):
+            derivative_rho = (rho_pump[z_ind + 1]**2 - rho_pump[z_ind]**2) / (z[z_ind + 1] - z[z_ind])
+            generalized_rho_nli -= derivative_rho * (exp(w * z[z_ind + 1]) - exp(w * z[z_ind])) / (w**2)
+        generalized_rho_nli = abs(generalized_rho_nli)**2
+        return generalized_rho_nli
+
+    @staticmethod
+    def _frequency_offset_threshold(beta2, symbol_rate):
+        k_ref = 5
+        beta2_ref = 21.3e-27
+        delta_f_ref = 50e9
+        rs_ref = 32e9
+        beta2 = abs(beta2)
+        freq_offset_th = ((k_ref * delta_f_ref) * rs_ref * beta2_ref) / (beta2 * symbol_rate)
+        return freq_offset_th
+
+    @staticmethod
+    def _ggn_approx(cut_indices, spectral_info: SpectralInformation, fiber, srs, spm_weight=SPM_WEIGHT,
+                    xpm_weight=XPM_WEIGHT):
+        """Computes the nonlinear interference power evaluated at the fiber input.
+        The method uses eq. 24-25 of https://ieeexplore.ieee.org/document/9741324
+        """
+        # Spectral Features
+        nch = spectral_info.number_of_channels
+        frequency = spectral_info.frequency
+        baud_rate = spectral_info.baud_rate
+        slot_width = spectral_info.slot_width
+        roll_off = spectral_info.roll_off
+        df = spectral_info.df + diag(full(nch, nan))
+
+        # Physical fiber parameters
+        alpha = fiber.alpha(frequency)
+        beta2 = fiber.beta2(frequency)
+        gamma = outer(fiber.gamma(frequency[cut_indices]), ones(nch))
+
+        identity = diag(ones(nch))
+        weight = spm_weight * identity + xpm_weight * (ones([nch, nch]) - identity)
+        weight = weight[cut_indices, :]
+
+        dispersion_tolerance = sim_params.nli_params.dispersion_tolerance
+        phase_shift_tolerance = sim_params.nli_params.phase_shift_tolerance
+        max_slot_width = max(slot_width)
+        max_beta2 = max(abs(beta2))
+        delta_z = sim_params.raman_params.result_spatial_resolution
+
+        # Approximation psi
+        loss_profile = srs.loss_profile[:nch]
+        z = srs.z
+        psi = NliSolver._approx_psi(df=df, frequency=frequency, beta2=beta2, baud_rate=baud_rate,
+                                    loss_profile=loss_profile, z=z)
+
+        # GGN for SPM
+        for cut_index in cut_indices:
+            dn = 0
+            cut_frequency = frequency[cut_index]
+            cut_baud_rate = baud_rate[cut_index]
+            cut_roll_off = roll_off[cut_index]
+            cut_beta2 = beta2[cut_index]
+            cut_alpha = alpha[cut_index]
+            k_tol = dispersion_tolerance * abs(cut_alpha)
+            phi_tol = phase_shift_tolerance / delta_z
+            f_cut_resolution = min(k_tol, phi_tol) / abs(max_beta2) / (4 * pi ** 2 * (1 + dn) * max_slot_width)
+            f_pump_resolution = min(k_tol, phi_tol) / abs(max_beta2) / (4 * pi ** 2 * max_slot_width)
+            psi[cut_index, cut_index] = NliSolver._generalized_psi(cut_frequency, cut_frequency, cut_baud_rate,
+                                                                   cut_roll_off, cut_frequency, cut_baud_rate,
+                                                                   cut_roll_off, f_cut_resolution, f_pump_resolution,
+                                                                   srs, cut_alpha, cut_beta2, 0, cut_frequency)
+        psi = psi[cut_indices, :]
+        cut_baud_rate = outer(baud_rate[cut_indices], ones(nch))
+        pump_baud_rate = outer(ones(cut_indices.size), baud_rate)
+
+        eta_cut_central_frequency = \
+            gamma ** 2 * weight * psi / (cut_baud_rate * pump_baud_rate ** 2)
+        eta = cut_baud_rate * eta_cut_central_frequency  # Local white noise
+
+        return eta
+
+    @staticmethod
+    def _approx_psi(df, frequency, baud_rate, beta2, loss_profile, z):
+        """Computes the approximated psi function similarly to the one used in the GN model.
+        The method uses eq. 25 of https://ieeexplore.ieee.org/document/9741324"""
+        pump_baud_rate = outer(ones(frequency.size), baud_rate)
+        cut_beta = outer(beta2, ones(frequency.size))
+        pump_beta = outer(ones(frequency.size), beta2)
+        delta_z = abs(z[:-1] - z[1:])
+
+        loss_lin = log(loss_profile)
+        pump_alpha = (loss_lin[:, 1:] - loss_lin[:, :-1]) / delta_z
+        leff = abs((loss_profile[:, 1:] - loss_profile[:, :-1]) / sqrt(abs(pump_alpha))) * pump_alpha / abs(pump_alpha)
+        leff = reshape(outer(leff, ones(z.size - 1)), newshape=[leff.shape[0], leff.shape[1], leff.shape[1]])
+        leff2 = leff * swapaxes(leff, 2, 1)
+        leff2 = sum(leff2, axis=(1, 2))
+        z_int = outer(ones(frequency.size), leff2)
+
+        delta_beta = (cut_beta + pump_beta) / 2
+        psi = z_int * pump_baud_rate / (4 * pi * abs(delta_beta * df))
+        return psi
+
+
+
+def estimate_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

gnpy/core/utils.py

@@ -0,0 +1,825 @@
+#!/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.
+"""
+
+from csv import writer
+from numpy import pi, cos, sqrt, log10, linspace, zeros, shape, where, logical_and, mean, array
+from scipy import constants
+from copy import deepcopy
+from typing import List, Union, Dict
+
+from gnpy.core.exceptions import ConfigurationError
+
+
+def write_csv(obj, filename):
+    """
+    Convert dictionary items to a CSV file the dictionary format:
+    ::
+
+        {'result category 1':
+                        [
+                        # 1st line of results
+                        {'header 1' : value_xxx,
+                         'header 2' : value_yyy},
+                         # 2nd line of results: same headers, different results
+                        {'header 1' : value_www,
+                         'header 2' : 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
+            w.writerow([data_key])
+            # 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 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
+    :rtype: numpy.ndarray
+    """
+    return linspace(start, stop, length)
+
+
+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)
+        number = round(number * step, 1)
+    else:
+        number = round(number, 2)
+    return number
+
+
+wavelength2freq = constants.lambda2nu
+freq2wavelength = constants.nu2lambda
+
+
+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))
+    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):
+    delta_wl is BW in wavelength units
+    wavelength is the center wl
+    units for delta_wl and wavelength must be same
+
+    :param delta_wl: delta wavelength BW in same units as wavelength
+    :param wavelength: wavelength BW is relevant for
+    :type delta_wl: float or numpy.ndarray
+    :type wavelength: float
+    :return: The BW in frequency units
+    :rtype: float or ndarray
+
+    """
+    f = wavelength2freq(wavelength)
+    return delta_wl * f / wavelength
+
+
+def deltaf2deltawl(delta_f, frequency):
+    """convert 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
+    :type delta_f: float or numpy.ndarray
+    :type frequency: float
+    :return: The BW in wavelength units
+    :rtype: float or ndarray
+
+    """
+    wl = freq2wavelength(frequency)
+    return delta_f * wl / frequency
+
+
+def rrc(ffs, baud_rate, alpha):
+    """compute the root-raised cosine filter function
+
+    :param ffs: A numpy array of frequencies
+    :param baud_rate: The Baud Rate of the System
+    :param alpha: The roll-off factor of the filter
+    :type ffs: numpy.ndarray
+    :type baud_rate: float
+    :type alpha: float
+    :return: hf a numpy array of the filter shape
+    :rtype: numpy.ndarray
+
+    """
+    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[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))
+    hf[p_inds] = 1
+    return sqrt(hf)
+
+
+def merge_amplifier_restrictions(dict1, dict2):
+    """Update contents of dicts recursively
+
+    >>> d1 = {'params': {'restrictions': {'preamp_variety_list': [], 'booster_variety_list': []}}}
+    >>> d2 = {'params': {'target_pch_out_db': -20}}
+    >>> merge_amplifier_restrictions(d1, d2)
+    {'params': {'restrictions': {'preamp_variety_list': [], 'booster_variety_list': []}, 'target_pch_out_db': -20}}
+
+    >>> d3 = {'params': {'restrictions': {'preamp_variety_list': ['foo'], 'booster_variety_list': ['bar']}}}
+    >>> merge_amplifier_restrictions(d1, d3)
+    {'params': {'restrictions': {'preamp_variety_list': [], 'booster_variety_list': []}}}
+    """
+
+    copy_dict1 = dict1.copy()
+    for key in dict2:
+        if key in dict1:
+            if isinstance(dict1[key], dict):
+                copy_dict1[key] = merge_amplifier_restrictions(copy_dict1[key], dict2[key])
+        else:
+            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
+
+    >>> li = [0, 1]
+    >>> li = silent_remove(li, 1)
+    >>> li
+    [0]
+    >>> li = silent_remove(li, 1)
+    >>> li
+    [0]
+    """
+
+    try:
+        this_list.remove(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

@@ -0,0 +1,160 @@
+{
+  "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/create_eqpt_sheet.py

@@ -0,0 +1,109 @@
+#!/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
+====================
+
+XLS parser that can be called to create a "City" column in the "Eqpt" sheet.
+
+If not present in the "Nodes" sheet, the "Type" column will be implicitly
+determined based on the topology.
+"""
+
+from xlrd import open_workbook
+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))
+
+
+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
+        self.eqpt = None
+
+    def __repr__(self):
+        return f'uid {self.uid} \nto_node {[node for node in self.to_node]}\neqpt {self.eqpt}\n'
+
+    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
+    """
+    with open_workbook(input_filename) as wobo:
+        # reading Links sheet
+        links_sheet = wobo.sheet_by_name('Links')
+        nodes = {}
+        for row in ALL_ROWS(links_sheet, start=5):
+            try:
+                nodes[row[0].value].to_node.append(row[1].value)
+            except KeyError:
+                nodes[row[0].value] = Node(row[0].value, [row[1].value])
+            try:
+                nodes[row[1].value].to_node.append(row[0].value)
+            except KeyError:
+                nodes[row[1].value] = Node(row[1].value, [row[0].value])
+
+        nodes_sheet = wobo.sheet_by_name('Nodes')
+        for row in ALL_ROWS(nodes_sheet, start=5):
+            node = row[0].value
+            eqpt = row[6].value
+            try:
+                if eqpt == 'ILA' and len(nodes[node].to_node) != 2:
+                    print(f'Inconsistancy ILA node with degree > 2: {node} ')
+                    exit()
+                if eqpt == '' and len(nodes[node].to_node) == 2:
+                    nodes[node].eqpt = 'ILA'
+                elif eqpt == '' and len(nodes[node].to_node) != 2:
+                    nodes[node].eqpt = 'ROADM'
+                else:
+                    nodes[node].eqpt = eqpt
+            except KeyError:
+                print(f'inconsistancy between nodes and links sheet: {node} is not listed in links')
+                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
+    """
+    output_filename = f'{input_filename[:-4]}_eqpt_sheet.txt'
+    with open(output_filename, 'w', encoding='utf-8') as my_file:
+        # print header similar to excel
+        my_file.write('OPTIONAL\n\n\n\
+           \t\tNode a egress amp (from a to z)\t\t\t\t\tNode a ingress amp (from z to a) \
+           \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')
+            if node.eqpt == 'ROADM':
+                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.')
+
+
+if __name__ == '__main__':
+    ARGS = PARSER.parse_args()
+    create_eqt_template(read_excel(ARGS.workbook), ARGS.workbook)

gnpy/example-data/edfa_example_network.json

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

gnpy/example-data/edfa_model/DFG_96.txt

@@ -0,0 +1 @@
+   2.5135969849999999e+01   2.5118228139999999e+01   2.5095421330000001e+01   2.5062457710000000e+01   2.5026027650000000e+01   2.4996379529999999e+01   2.4981672549999999e+01   2.4975306679999999e+01   2.4983207260000000e+01   2.4997185649999999e+01   2.5017572470000001e+01   2.5038327809999998e+01   2.5054955849999999e+01   2.5067071899999998e+01   2.5070914110000000e+01   2.5070943650000000e+01   2.5071143240000001e+01   2.5075336270000001e+01   2.5087310179999999e+01   2.5103139360000000e+01   2.5122762040000001e+01   2.5142394790000001e+01   2.5159456330000001e+01   2.5173927039999999e+01   2.5176737670000001e+01   2.5170371410000001e+01   2.5152162539999999e+01   2.5131143099999999e+01   2.5108023350000000e+01   2.5085487770000000e+01   2.5069166750000001e+01   2.5058481759999999e+01   2.5054473130000002e+01   2.5051544410000002e+01   2.5049460589999999e+01   2.5047178490000000e+01   2.5045516559999999e+01   2.5044676490000001e+01   2.5040729200000001e+01   2.5032854080000000e+01   2.5023488300000000e+01   2.5016592339999999e+01   2.5013321359999999e+01   2.5011234340000001e+01   2.5010300149999999e+01   2.5009365480000000e+01   2.5008739640000002e+01   2.5008425350000000e+01   2.5006964660000001e+01   2.5004043100000001e+01   2.5000709980000000e+01   2.4998423200000001e+01   2.4993063320000001e+01   2.4983524209999999e+01   2.4971251030000001e+01   2.4960381080000001e+01   2.4948887209999999e+01   2.4935314890000001e+01   2.4921319270000001e+01   2.4908986970000001e+01   2.4898965140000001e+01   2.4889584630000002e+01   2.4880838700000002e+01   2.4872100920000001e+01   2.4864620259999999e+01   2.4858397730000000e+01   2.4854458380000001e+01   2.4851554430000000e+01   2.4851766009999999e+01   2.4854080140000001e+01   2.4859096240000000e+01   2.4864744580000000e+01   2.4872034859999999e+01   2.4880365200000000e+01   2.4889106689999998e+01   2.4897213130000001e+01   2.4902826040000001e+01   2.4906566900000001e+01   2.4908650800000000e+01   2.4910939440000000e+01   2.4913430790000000e+01   2.4915923440000000e+01   2.4921553509999999e+01   2.4930318610000000e+01   2.4940528120000000e+01   2.4949046689999999e+01   2.4957571229999999e+01   2.4967818449999999e+01   2.4981800929999999e+01   2.4997826860000000e+01   2.5013931830000001e+01   2.5028098459999999e+01   2.5040325750000001e+01   2.5052569810000001e+01   2.5064797009999999e+01   2.5077046970000001e+01

gnpy/example-data/edfa_model/DGT_96.txt

@@ -0,0 +1 @@
+   2.7145266811316859e+00   2.7054438192385049e+00   2.6947834587664494e+00   2.6841217449620203e+00   2.6681935771243177e+00   2.6521732021128046e+00   2.6303964408153848e+00   2.6028603502864280e+00   2.5696460593920065e+00   2.5364027376452056e+00   2.4994462867966041e+00   2.4587748041127506e+00   2.4143984371852212e+00   2.3699990328716107e+00   2.3223736962293420e+00   2.2715207713712529e+00   2.2174389328192197e+00   2.1633756538423898e+00   2.1183028432496016e+00   2.0822250998736478e+00   2.0551007720052352e+00   2.0279625371819305e+00   2.0008103857988204e+00   1.9736443063300082e+00   1.9482128147680253e+00   1.9245345552113182e+00   1.9026104247588487e+00   1.8806927939516411e+00   1.8622356724442459e+00   1.8472755032011290e+00   1.8358140813807049e+00   1.8243814368429321e+00   1.8139629377087627e+00   1.8045606557581335e+00   1.7961751115773796e+00   1.7877868031023945e+00   1.7793941781790852e+00   1.7709972329654864e+00   1.7625959636196327e+00   1.7541903672600494e+00   1.7459181197626403e+00   1.7377807579136351e+00   1.7297783508684146e+00   1.7217732861435076e+00   1.7137640932265894e+00   1.7057507692361864e+00   1.6918150918099673e+00   1.6719047669939942e+00   1.6460167077689267e+00   1.6201194134191075e+00   1.5986915141218316e+00   1.5817353179379183e+00   1.5691997641843789e+00   1.5566577309558969e+00   1.5453741527614671e+00   1.5353620432989845e+00   1.5266220576235803e+00   1.5178910621476225e+00   1.5097346239790443e+00   1.5021530399096861e+00   1.4951454560626991e+00   1.4881342434792260e+00   1.4811193973568100e+00   1.4741004422522110e+00   1.4670307626366115e+00   1.4599103316162523e+00   1.4527395948591399e+00   1.4455651371583680e+00   1.4340878115214444e+00   1.4182738067303231e+00   1.3981208704326855e+00   1.3779439775587023e+00   1.3598972673004606e+00   1.3439818461440451e+00   1.3301807335621048e+00   1.3163839268630830e+00   1.3040618749785347e+00   1.2932153453410835e+00   1.2838336236692311e+00   1.2744470198196236e+00   1.2650555289898042e+00   1.2556591482982988e+00   1.2428104897182262e+00   1.2264996957264114e+00   1.2067249615595257e+00   1.1869318618366975e+00   1.1672278304018044e+00   1.1476135933863398e+00   1.1280891949729075e+00   1.1085552896156590e+00   1.0895983485572227e+00   1.0712204022764056e+00   1.0534217504465226e+00   1.0356155337864215e+00   1.0178077678537021e+00   1.0000000000000000e+00

gnpy/example-data/edfa_model/NFR_96.txt

@@ -0,0 +1 @@
+  -3.1537433199999998e-01  -3.1537433199999998e-01  -3.1540091571002721e-01  -3.1849146117510951e-01  -3.2158358425400546e-01  -3.2467728615499991e-01  -3.2762368641496226e-01  -3.2054138461232762e-01  -3.1345546385118733e-01  -3.0636592135697482e-01  -2.9920267890990127e-01  -2.7061972852631744e-01  -2.4202215770774693e-01  -2.1340995523361256e-01  -1.8478227130158695e-01  -1.4809761118389625e-01  -1.1139416731807622e-01  -7.4671925273579881e-02  -3.8026748965679924e-02  -1.9958469399422092e-02  -1.8809287980157928e-03   1.6205879960573561e-02   3.4301964005709673e-02   5.2407330474054062e-02   7.0521986509597359e-02   7.9578036683472006e-02   8.8546647361909522e-02   9.7519863231965306e-02   1.0649768784154924e-01   9.7741380449907406e-02   8.8803437172660038e-02   7.9860899732845866e-02   7.0913764587403796e-02   6.3335892740565308e-02   5.5756212252058776e-02   4.8172631747863209e-02   4.0585148217162359e-02   3.3381591675710129e-02   2.6178308595650738e-02   1.8971315351761126e-02   1.1760609076833628e-02   1.6950294922759991e-02   2.2274991357701439e-02   2.7602433189104329e-02   3.2932622540790261e-02   3.8265561538776145e-02   4.3601252311271169e-02   3.4856990743481552e-02   2.5991055149117932e-02   1.7120541224980364e-02   8.2757587359203223e-03   1.9423214065246042e-03  -4.3943890171043590e-03  -1.0734375072893196e-02  -1.7077639301414434e-02  -2.4679702899572852e-02  -3.2297970403821680e-02  -3.9920180090477250e-02  -4.7534566327530239e-02  -4.9234003141433724e-02  -5.0934320036547187e-02  -5.2635517696692252e-02  -5.4337596806402461e-02  -5.6040558050919301e-02  -5.7718452237076875e-02  -5.6840590379175944e-02  -5.5962273198734966e-02  -5.5083500341416583e-02  -5.4204271452516814e-02  -5.8396088726955113e-02  -6.2627330169715334e-02  -6.6860769089203700e-02  -7.0901736256069450e-02  -5.2096097309052243e-02  -3.3280684121412940e-02  -1.4455489070928059e-02   4.3150387579057158e-03   1.4839202394482527e-02   2.5368841662503576e-02   3.5903960836465652e-02   4.6444564195321399e-02   5.6990656022467459e-02   6.7542240605774059e-02   1.0002709623672751e-01   1.3258013095133617e-01   1.6515013362773309e-01   1.9773711753599391e-01   2.3194802687829724e-01   2.6618779883837107e-01   3.0044543658085349e-01   3.3472095409250663e-01   3.5929034770587287e-01   3.8384389188855605e-01   4.0841026111391787e-01   4.3298946543290784e-01   4.3298946543290784e-01

gnpy/example-data/edfa_model/OA.json

@@ -0,0 +1,6 @@
+{
+    "nf_ripple": "NFR_96.txt", 
+    "gain_ripple": "DFG_96.txt",
+    "dgt": "DGT_96.txt",
+    "nf_fit_coeff": "pNFfit3.txt"
+}

gnpy/example-data/edfa_model/build_oa_json.py

@@ -0,0 +1,95 @@
+#!/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
+
+@author: jeanluc-auge
+
+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
+returns an updated amplifier json file: output_json_file_name = 'edfa_config.json'
+"""
+import re
+import sys
+import json
+import numpy as np
+
+"""amplifier file names
+convert a set of amplifier files + input json definiton file into a valid edfa_json_file:
+nf_fit_coeff: NF 3rd order polynomial coefficients txt file
+    nf = f(dg)
+    with dg = gain_operational - gain_max
+nf_ripple: NF ripple excursion txt file
+gain_ripple: gain ripple txt file
+dgt: dynamic gain txt file
+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",
+    "gain_ripple": "DFG_filename.txt",
+    "dgt": "DGT_filename.txt",
+}
+
+"""
+
+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:
+    #   data = this_file.read()
+    # 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
+        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:
+        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)):
+            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:
+        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)

gnpy/example-data/edfa_model/pNFfit3.txt

@@ -0,0 +1 @@
+   1.6824099999999999e-04   4.6996099999999999e-02   3.5954899999999998e-02   5.8285099999999996e+00

gnpy/example-data/eqpt_config.json

@@ -0,0 +1,444 @@
+{
+  "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": "openroadm_ila_low_noise",
+      "type_def": "openroadm",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "nf_coef": [
+        -8.104e-4,
+        -6.221e-2,
+        -5.889e-1,
+        37.62
+      ],
+      "allowed_for_design": false
+    },
+    {
+      "type_variety": "openroadm_ila_standard",
+      "type_def": "openroadm",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "nf_coef": [
+        -5.952e-4,
+        -6.250e-2,
+        -1.071,
+        28.99
+      ],
+      "allowed_for_design": false
+    },
+    {
+      "type_variety": "openroadm_mw_mw_preamp",
+      "type_def": "openroadm_preamp",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "allowed_for_design": false
+    },
+    {
+      "type_variety": "openroadm_mw_mw_preamp_typical_ver5",
+      "type_def": "openroadm",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "nf_coef": [
+        -5.952e-4,
+        -6.250e-2,
+        -1.071,
+        28.99
+      ],
+      "allowed_for_design": false
+    },
+    {
+      "type_variety": "openroadm_mw_mw_preamp_worstcase_ver5",
+      "type_def": "openroadm",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "nf_coef": [
+        -5.952e-4,
+        -6.250e-2,
+        -1.071,
+        27.99
+      ],
+      "allowed_for_design": false
+    },
+    {
+      "type_variety": "openroadm_mw_mw_booster",
+      "type_def": "openroadm_booster",
+      "gain_flatmax": 32,
+      "gain_min": 0,
+      "p_max": 22,
+      "allowed_for_design": false
+    },
+    {
+      "type_variety": "std_high_gain",
+      "type_def": "variable_gain",
+      "gain_flatmax": 35,
+      "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,
+      "effective_area": 83e-12,
+      "pmd_coef": 1.265e-15
+    },
+    {
+      "type_variety": "NZDF",
+      "dispersion": 0.5e-05,
+      "effective_area": 72e-12,
+      "pmd_coef": 1.265e-15
+    },
+    {
+      "type_variety": "LOF",
+      "dispersion": 2.2e-05,
+      "effective_area": 125e-12,
+      "pmd_coef": 1.265e-15
+    }
+  ],
+  "RamanFiber": [
+    {
+      "type_variety": "SSMF",
+      "dispersion": 1.67e-05,
+      "effective_area": 83e-12,
+      "pmd_coef": 1.265e-15
+    }
+  ],
+  "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,
+      "pmd": 0,
+      "pdl": 0,
+      "restrictions": {
+        "preamp_variety_list": [],
+        "booster_variety_list": []
+      }
+    },
+    {
+      "type_variety": "roadm_type_1",
+      "target_pch_out_db": -18,
+      "add_drop_osnr": 35,
+      "pmd": 0,
+      "pdl": 0,
+      "restrictions": {
+        "preamp_variety_list": [],
+        "booster_variety_list": []
+      },
+      "roadm-path-impairments": []
+    },
+    {
+      "type_variety": "detailed_impairments",
+      "target_pch_out_db": -20,
+      "add_drop_osnr": 38,
+      "pmd": 0,
+      "pdl": 0,
+      "restrictions": {
+        "preamp_variety_list": [],
+        "booster_variety_list": []
+      },
+      "roadm-path-impairments": [
+        {
+          "roadm-path-impairments-id": 0,
+          "roadm-express-path": [
+            {
+              "frequency-range": {
+                "lower-frequency": 191.3e12,
+                "upper-frequency": 196.1e12
+              },
+              "roadm-pmd": 0,
+              "roadm-cd": 0,
+              "roadm-pdl": 0,
+              "roadm-inband-crosstalk": 0,
+              "roadm-maxloss": 16.5
+            }
+          ]
+        },
+        {
+          "roadm-path-impairments-id": 1,
+          "roadm-add-path": [
+            {
+              "frequency-range": {
+                "lower-frequency": 191.3e12,
+                "upper-frequency": 196.1e12
+              },
+              "roadm-pmd": 0,
+              "roadm-cd": 0,
+              "roadm-pdl": 0,
+              "roadm-inband-crosstalk": 0,
+              "roadm-maxloss": 11.5,
+              "roadm-pmax": 2.5,
+              "roadm-osnr": 41,
+              "roadm-noise-figure": 23
+            }
+          ]
+        },
+        {
+          "roadm-path-impairments-id": 2,
+          "roadm-drop-path": [
+            {
+              "frequency-range": {
+                "lower-frequency": 191.3e12,
+                "upper-frequency": 196.1e12
+              },
+              "roadm-pmd": 0,
+              "roadm-cd": 0,
+              "roadm-pdl": 0,
+              "roadm-inband-crosstalk": 0,
+              "roadm-maxloss": 11.5,
+              "roadm-minloss": 7.5,
+              "roadm-typloss": 10,
+              "roadm-pmin": -13.5,
+              "roadm-pmax": -9.5,
+              "roadm-ptyp": -12,
+              "roadm-osnr": 41,
+              "roadm-noise-figure": 15
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "SI": [
+    {
+      "f_min": 191.3e12,
+      "baud_rate": 32e9,
+      "f_max": 195.1e12,
+      "spacing": 50e9,
+      "power_dbm": 0,
+      "power_range_db": [
+        0,
+        0,
+        1
+      ],
+      "tx_power_dbm": 0,
+      "roll_off": 0.15,
+      "tx_osnr": 40,
+      "sys_margins": 2,
+      "use_si_channel_count_for_design": true
+    }
+  ],
+  "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
+        }
+      ]
+    }
+  ]
+}

gnpy/example-data/eqpt_config_multiband.json

@@ -0,0 +1,479 @@
+{
+    "Edfa": [
+        {
+            "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_reduced",
+            "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
+        },
+        {
+            "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_low_gain",
+            "f_min": 191.25e12,
+            "f_max": 196.15e12,
+            "type_def": "variable_gain",
+            "gain_flatmax": 16,
+            "gain_min": 8,
+            "p_max": 21,
+            "nf_min": 7,
+            "nf_max": 11,
+            "out_voa_auto": false,
+            "allowed_for_design": true
+        },
+        {
+            "type_variety": "std_low_gain_reduced_band",
+            "f_min": 192.25e12,
+            "f_max": 196.15e12,
+            "type_def": "variable_gain",
+            "gain_flatmax": 16,
+            "gain_min": 8,
+            "p_max": 21,
+            "nf_min": 7,
+            "nf_max": 11,
+            "out_voa_auto": false,
+            "allowed_for_design": true
+        },
+        {
+            "type_variety": "std_low_gain_bis",
+            "f_min": 191.25e12,
+            "f_max": 196.15e12,
+            "type_def": "variable_gain",
+            "gain_flatmax": 16,
+            "gain_min": 8,
+            "p_max": 21,
+            "nf_min": 6,
+            "nf_max": 10,
+            "out_voa_auto": false,
+            "allowed_for_design": true
+        },
+        {
+            "type_variety": "std_low_gain_L_ter",
+            "f_min": 186.55e12,
+            "f_max": 190.05e12,
+            "type_def": "variable_gain",
+            "gain_flatmax": 16,
+            "gain_min": 8,
+            "p_max": 16,
+            "nf_min": 7,
+            "nf_max": 11,
+            "out_voa_auto": false,
+            "allowed_for_design": true
+        },
+        {
+            "type_variety": "std_low_gain_L",
+            "f_min": 186.55e12,
+            "f_max": 190.05e12,
+            "type_def": "variable_gain",
+            "gain_flatmax": 16,
+            "gain_min": 8,
+            "p_max": 21,
+            "nf_min": 7,
+            "nf_max": 11,
+            "out_voa_auto": false,
+            "allowed_for_design": true
+        },
+        {
+            "type_variety": "std_low_gain_L_reduced_band",
+            "f_min": 187.3e12,
+            "f_max": 190.05e12,
+            "type_def": "variable_gain",
+            "gain_flatmax": 16,
+            "gain_min": 8,
+            "p_max": 21,
+            "nf_min": 7,
+            "nf_max": 11,
+            "out_voa_auto": false,
+            "allowed_for_design": true
+        },
+        {
+            "type_variety": "test",
+            "type_def": "variable_gain",
+            "gain_flatmax": 25,
+            "gain_min": 15,
+            "p_max": 21,
+            "nf_min": 5.8,
+            "nf_max": 10,
+            "out_voa_auto": false,
+            "allowed_for_design": true
+        },
+        {
+            "type_variety": "test_fixed_gain",
+            "type_def": "fixed_gain",
+            "gain_flatmax": 21,
+            "gain_min": 20,
+            "p_max": 21,
+            "nf0": 5,
+            "allowed_for_design": true
+        },
+        {
+            "type_variety": "std_booster",
+            "type_def": "fixed_gain",
+            "gain_flatmax": 21,
+            "gain_min": 20,
+            "p_max": 21,
+            "nf0": 5,
+            "allowed_for_design": false
+        },
+        {
+            "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
+        },
+        {
+            "type_variety": "std_booster_multiband",
+            "type_def": "multi_band",
+            "amplifiers": [
+                "std_booster",
+                "std_booster_L"
+            ],
+            "allowed_for_design": false
+        },
+        {
+            "type_variety": "std_medium_gain_multiband",
+            "type_def": "multi_band",
+            "amplifiers": [
+                "std_medium_gain_C",
+                "std_medium_gain_L"
+            ],
+            "allowed_for_design": false
+        },
+        {
+            "type_variety": "std_low_gain_multiband",
+            "type_def": "multi_band",
+            "amplifiers": [
+                "std_low_gain",
+                "std_low_gain_L"
+            ],
+            "allowed_for_design": false
+        },
+        {
+            "type_variety": "std_low_gain_multiband_ter",
+            "type_def": "multi_band",
+            "amplifiers": [
+                "std_low_gain",
+                "std_low_gain_L_ter"
+            ],
+            "allowed_for_design": false
+        },
+        {
+            "type_variety": "std_low_gain_multiband_bis",
+            "type_def": "multi_band",
+            "amplifiers": [
+                "std_low_gain_bis",
+                "std_low_gain_L"
+            ],
+            "allowed_for_design": true
+        },
+        {
+            "type_variety": "std_low_gain_multiband_reduced",
+            "type_def": "multi_band",
+            "amplifiers": [
+                "std_low_gain_reduced",
+                "std_low_gain_L"
+            ],
+            "allowed_for_design": true
+        },
+        {
+            "type_variety": "std_low_gain_multiband_reduced_bis",
+            "type_def": "multi_band",
+            "amplifiers": [
+                "std_low_gain_bis",
+                "std_low_gain_L_reduced_band"
+            ],
+            "allowed_for_design": true
+        }
+    ],
+    "Fiber": [
+        {
+            "type_variety": "SSMF",
+            "dispersion": 1.67e-05,
+            "effective_area": 83e-12,
+            "pmd_coef": 1.265e-15
+        },
+        {
+            "type_variety": "NZDF",
+            "dispersion": 0.5e-05,
+            "effective_area": 72e-12,
+            "pmd_coef": 1.265e-15
+        },
+        {
+            "type_variety": "LOF",
+            "dispersion": 2.2e-05,
+            "effective_area": 125e-12,
+            "pmd_coef": 1.265e-15
+        }
+    ],
+    "RamanFiber": [
+        {
+            "type_variety": "SSMF",
+            "dispersion": 1.67e-05,
+            "effective_area": 83e-12,
+            "pmd_coef": 1.265e-15
+        }
+    ],
+    "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,
+            "pmd": 0,
+            "pdl": 0,
+            "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
+        },
+        {
+            "type_variety": "lband",
+            "f_min": 186.3e12,
+            "baud_rate": 32e9,
+            "f_max": 190.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
+                }
+            ]
+        }
+    ]
+}

gnpy/example-data/eqpt_config_openroadm_ver4.json

@@ -0,0 +1,371 @@
+{
+  "Edfa": [
+    {
+      "type_variety": "openroadm_ila_low_noise",
+      "type_def": "openroadm",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "nf_coef": [
+        -8.104e-4,
+        -6.221e-2,
+        -5.889e-1,
+        37.62
+      ],
+      "pmd": 3e-12,
+      "pdl": 0.7,
+      "allowed_for_design": true
+    },
+    {
+      "type_variety": "openroadm_ila_standard",
+      "type_def": "openroadm",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "nf_coef": [
+        -5.952e-4,
+        -6.250e-2,
+        -1.071,
+        28.99
+      ],
+      "pmd": 3e-12,
+      "pdl": 0.7,
+      "allowed_for_design": true
+    },
+    {
+      "type_variety": "openroadm_mw_mw_preamp",
+      "type_def": "openroadm_preamp",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "pmd": 0,
+      "pdl": 0,
+      "allowed_for_design": false
+    },
+    {
+      "type_variety": "openroadm_mw_mw_booster",
+      "type_def": "openroadm_booster",
+      "gain_flatmax": 32,
+      "gain_min": 0,
+      "p_max": 22,
+      "pmd": 0,
+      "pdl": 0,
+      "allowed_for_design": false
+    }
+  ],
+  "Fiber": [
+    {
+      "type_variety": "SSMF",
+      "dispersion": 1.67e-05,
+      "effective_area": 83e-12,
+      "pmd_coef": 1.265e-15
+    },
+    {
+      "type_variety": "NZDF",
+      "dispersion": 0.5e-05,
+      "effective_area": 72e-12,
+      "pmd_coef": 1.265e-15
+    },
+    {
+      "type_variety": "LOF",
+      "dispersion": 2.2e-05,
+      "effective_area": 125e-12,
+      "pmd_coef": 1.265e-15
+    }
+  ],
+  "RamanFiber": [
+    {
+      "type_variety": "SSMF",
+      "dispersion": 1.67e-05,
+      "effective_area": 83e-12,
+      "pmd_coef": 1.265e-15
+    }
+  ],
+  "Span": [
+    {
+      "power_mode": true,
+      "delta_power_range_db": [
+        0,
+        0,
+        0
+      ],
+      "max_fiber_lineic_loss_for_raman": 0.25,
+      "target_extended_gain": 0,
+      "max_length": 135,
+      "length_units": "km",
+      "max_loss": 28,
+      "padding": 11,
+      "EOL": 0,
+      "con_in": 0,
+      "con_out": 0
+    }
+  ],
+  "Roadm": [
+    {
+      "target_pch_out_db": -20,
+      "add_drop_osnr": 30,
+      "pmd": 3e-12,
+      "pdl": 1.5,
+      "restrictions": {
+        "preamp_variety_list": [
+          "openroadm_mw_mw_preamp"
+        ],
+        "booster_variety_list": [
+          "openroadm_mw_mw_booster"
+        ]
+      }
+    }
+  ],
+  "SI": [
+    {
+      "f_min": 191.3e12,
+      "baud_rate": 31.57e9,
+      "f_max": 196.1e12,
+      "spacing": 50e9,
+      "power_dbm": 2,
+      "power_range_db": [
+        0,
+        0,
+        1
+      ],
+      "roll_off": 0.15,
+      "tx_osnr": 35,
+      "sys_margins": 2
+    }
+  ],
+  "Transceiver": [
+    {
+      "type_variety": "OpenROADM MSA ver. 4.0",
+      "frequency": {
+        "min": 191.35e12,
+        "max": 196.1e12
+      },
+      "mode": [
+        {
+          "format": "100 Gbit/s, 27.95 Gbaud, DP-QPSK",
+          "baud_rate": 27.95e9,
+          "OSNR": 17,
+          "bit_rate": 100e9,
+          "roll_off": null,
+          "tx_osnr": 33,
+          "penalties": [
+            {
+              "chromatic_dispersion": 4e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 18e3,
+              "penalty_value": 0.5
+            },
+            {
+              "pmd": 10,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 30,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 2,
+              "penalty_value": 1
+            },
+            {
+              "pdl": 4,
+              "penalty_value": 2.5
+            },
+            {
+              "pdl": 6,
+              "penalty_value": 4
+            }
+          ],
+          "min_spacing": 50e9,
+          "cost": 1
+        },
+        {
+          "format": "100 Gbit/s, 31.57 Gbaud, DP-QPSK",
+          "baud_rate": 31.57e9,
+          "OSNR": 12,
+          "bit_rate": 100e9,
+          "roll_off": 0.15,
+          "tx_osnr": 35,
+          "penalties": [
+            {
+              "chromatic_dispersion": -1e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 4e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 40e3,
+              "penalty_value": 0.5
+            },
+            {
+              "pmd": 10,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 30,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 2,
+              "penalty_value": 1
+            },
+            {
+              "pdl": 4,
+              "penalty_value": 2.5
+            },
+            {
+              "pdl": 6,
+              "penalty_value": 4
+            }
+          ],
+          "min_spacing": 50e9,
+          "cost": 1
+        },
+        {
+          "format": "200 Gbit/s, DP-QPSK",
+          "baud_rate": 63.1e9,
+          "OSNR": 17,
+          "bit_rate": 200e9,
+          "roll_off": 0.15,
+          "tx_osnr": 36,
+          "penalties": [
+            {
+              "chromatic_dispersion": -1e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 4e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 24e3,
+              "penalty_value": 0.5
+            },
+            {
+              "pmd": 10,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 25,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 2,
+              "penalty_value": 1
+            },
+            {
+              "pdl": 4,
+              "penalty_value": 2.5
+            }
+          ],
+          "min_spacing": 87.5e9,
+          "cost": 1
+        },
+        {
+          "format": "300 Gbit/s, DP-8QAM",
+          "baud_rate": 63.1e9,
+          "OSNR": 21,
+          "bit_rate": 300e9,
+          "roll_off": 0.15,
+          "tx_osnr": 36,
+          "penalties": [
+            {
+              "chromatic_dispersion": -1e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 4e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 18e3,
+              "penalty_value": 0.5
+            },
+            {
+              "pmd": 10,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 25,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 2,
+              "penalty_value": 1
+            },
+            {
+              "pdl": 4,
+              "penalty_value": 2.5
+            }
+          ],
+          "min_spacing": 87.5e9,
+          "cost": 1
+        },
+        {
+          "format": "400 Gbit/s, DP-16QAM",
+          "baud_rate": 63.1e9,
+          "OSNR": 24,
+          "bit_rate": 400e9,
+          "roll_off": 0.15,
+          "tx_osnr": 36,
+          "penalties": [
+            {
+              "chromatic_dispersion": -1e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 4e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 12e3,
+              "penalty_value": 0.5
+            },
+            {
+              "pmd": 10,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 20,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 2,
+              "penalty_value": 1
+            },
+            {
+              "pdl": 4,
+              "penalty_value": 2.5
+            }
+          ],
+          "min_spacing": 87.5e9,
+          "cost": 1
+        }
+      ]
+    }
+  ]
+}

gnpy/example-data/eqpt_config_openroadm_ver5.json

@@ -0,0 +1,441 @@
+{
+  "Edfa": [
+    {
+      "type_variety": "openroadm_ila_low_noise",
+      "type_def": "openroadm",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "nf_coef": [
+        -8.104e-4,
+        -6.221e-2,
+        -5.889e-1,
+        37.62
+      ],
+      "pmd": 3e-12,
+      "pdl": 0.7,
+      "allowed_for_design": true
+    },
+    {
+      "type_variety": "openroadm_ila_standard",
+      "type_def": "openroadm",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "nf_coef": [
+        -5.952e-4,
+        -6.250e-2,
+        -1.071,
+        28.99
+      ],
+      "pmd": 3e-12,
+      "pdl": 0.7,
+      "allowed_for_design": true
+    },
+    {
+      "type_variety": "openroadm_mw_mw_preamp_typical_ver5",
+      "type_def": "openroadm",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "nf_coef": [
+        -5.952e-4,
+        -6.250e-2,
+        -1.071,
+        28.99
+      ],
+      "pmd": 0,
+      "pdl": 0,
+      "allowed_for_design": false
+    },
+    {
+      "type_variety": "openroadm_mw_mw_preamp_worstcase_ver5",
+      "type_def": "openroadm",
+      "gain_flatmax": 27,
+      "gain_min": 0,
+      "p_max": 22,
+      "nf_coef": [
+        -5.952e-4,
+        -6.250e-2,
+        -1.071,
+        27.99
+      ],
+      "pmd": 0,
+      "pdl": 0,
+      "allowed_for_design": false
+    },
+    {
+      "type_variety": "openroadm_mw_mw_booster",
+      "type_def": "openroadm_booster",
+      "gain_flatmax": 32,
+      "gain_min": 0,
+      "p_max": 22,
+      "pmd": 0,
+      "pdl": 0,
+      "allowed_for_design": false
+    }
+  ],
+  "Fiber": [
+    {
+      "type_variety": "SSMF",
+      "dispersion": 1.67e-05,
+      "effective_area": 83e-12,
+      "pmd_coef": 1.265e-15
+    },
+    {
+      "type_variety": "NZDF",
+      "dispersion": 0.5e-05,
+      "effective_area": 72e-12,
+      "pmd_coef": 1.265e-15
+    },
+    {
+      "type_variety": "LOF",
+      "dispersion": 2.2e-05,
+      "effective_area": 125e-12,
+      "pmd_coef": 1.265e-15
+    }
+  ],
+  "RamanFiber": [
+    {
+      "type_variety": "SSMF",
+      "dispersion": 1.67e-05,
+      "effective_area": 83e-12,
+      "pmd_coef": 1.265e-15
+    }
+  ],
+  "Span": [
+    {
+      "power_mode": true,
+      "delta_power_range_db": [
+        0,
+        0,
+        0
+      ],
+      "max_fiber_lineic_loss_for_raman": 0.25,
+      "target_extended_gain": 0,
+      "max_length": 135,
+      "length_units": "km",
+      "max_loss": 28,
+      "padding": 11,
+      "EOL": 0,
+      "con_in": 0,
+      "con_out": 0
+    }
+  ],
+  "Roadm": [
+    {
+      "target_pch_out_db": -20,
+      "add_drop_osnr": 33,
+      "pmd": 3e-12,
+      "pdl": 1.5,
+      "restrictions": {
+        "preamp_variety_list": [
+          "openroadm_mw_mw_preamp_worstcase_ver5"
+        ],
+        "booster_variety_list": [
+          "openroadm_mw_mw_booster"
+        ]
+      }
+    }
+  ],
+  "SI": [
+    {
+      "f_min": 191.3e12,
+      "baud_rate": 31.57e9,
+      "f_max": 196.1e12,
+      "spacing": 50e9,
+      "power_dbm": 2,
+      "power_range_db": [
+        0,
+        0,
+        1
+      ],
+      "roll_off": 0.15,
+      "tx_osnr": 35,
+      "sys_margins": 2
+    }
+  ],
+  "Transceiver": [
+    {
+      "type_variety": "OpenROADM MSA ver. 5.0",
+      "frequency": {
+        "min": 191.35e12,
+        "max": 196.1e12
+      },
+      "mode": [
+        {
+          "format": "100 Gbit/s, 27.95 Gbaud, DP-QPSK",
+          "baud_rate": 27.95e9,
+          "OSNR": 17,
+          "bit_rate": 100e9,
+          "roll_off": null,
+          "tx_osnr": 33,
+          "penalties": [
+            {
+              "chromatic_dispersion": 4e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 18e3,
+              "penalty_value": 0.5
+            },
+            {
+              "pmd": 10,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 30,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 2,
+              "penalty_value": 1
+            },
+            {
+              "pdl": 4,
+              "penalty_value": 2.5
+            },
+            {
+              "pdl": 6,
+              "penalty_value": 4
+            }
+          ],
+          "min_spacing": 50e9,
+          "cost": 1
+        },
+        {
+          "format": "100 Gbit/s, 31.57 Gbaud, DP-QPSK",
+          "baud_rate": 31.57e9,
+          "OSNR": 12,
+          "bit_rate": 100e9,
+          "roll_off": 0.15,
+          "tx_osnr": 36,
+          "penalties": [
+            {
+              "chromatic_dispersion": -1e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 4e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 48e3,
+              "penalty_value": 0.5
+            },
+            {
+              "pmd": 10,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 30,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 2,
+              "penalty_value": 1
+            },
+            {
+              "pdl": 4,
+              "penalty_value": 2.5
+            },
+            {
+              "pdl": 6,
+              "penalty_value": 4
+            }
+          ],
+          "min_spacing": 50e9,
+          "cost": 1
+        },
+        {
+          "format": "200 Gbit/s, 31.57 Gbaud, DP-16QAM",
+          "baud_rate": 31.57e9,
+          "OSNR": 20.5,
+          "bit_rate": 100e9,
+          "roll_off": 0.15,
+          "tx_osnr": 36,
+          "penalties": [
+            {
+              "chromatic_dispersion": -1e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 4e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 24e3,
+              "penalty_value": 0.5
+            },
+            {
+              "pmd": 10,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 30,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 2,
+              "penalty_value": 1
+            },
+            {
+              "pdl": 4,
+              "penalty_value": 2.5
+            },
+            {
+              "pdl": 6,
+              "penalty_value": 4
+            }
+          ],
+          "min_spacing": 50e9,
+          "cost": 1
+        },
+        {
+          "format": "200 Gbit/s, DP-QPSK",
+          "baud_rate": 63.1e9,
+          "OSNR": 17,
+          "bit_rate": 200e9,
+          "roll_off": 0.15,
+          "tx_osnr": 36,
+          "penalties": [
+            {
+              "chromatic_dispersion": -1e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 4e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 24e3,
+              "penalty_value": 0.5
+            },
+            {
+              "pmd": 10,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 25,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 2,
+              "penalty_value": 1
+            },
+            {
+              "pdl": 4,
+              "penalty_value": 2.5
+            }
+          ],
+          "min_spacing": 87.5e9,
+          "cost": 1
+        },
+        {
+          "format": "300 Gbit/s, DP-8QAM",
+          "baud_rate": 63.1e9,
+          "OSNR": 21,
+          "bit_rate": 300e9,
+          "roll_off": 0.15,
+          "tx_osnr": 36,
+          "penalties": [
+            {
+              "chromatic_dispersion": -1e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 4e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 18e3,
+              "penalty_value": 0.5
+            },
+            {
+              "pmd": 10,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 25,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 2,
+              "penalty_value": 1
+            },
+            {
+              "pdl": 4,
+              "penalty_value": 2.5
+            }
+          ],
+          "min_spacing": 87.5e9,
+          "cost": 1
+        },
+        {
+          "format": "400 Gbit/s, DP-16QAM",
+          "baud_rate": 63.1e9,
+          "OSNR": 24,
+          "bit_rate": 400e9,
+          "roll_off": 0.15,
+          "tx_osnr": 36,
+          "penalties": [
+            {
+              "chromatic_dispersion": -1e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 4e3,
+              "penalty_value": 0
+            },
+            {
+              "chromatic_dispersion": 12e3,
+              "penalty_value": 0.5
+            },
+            {
+              "pmd": 10,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 20,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 2,
+              "penalty_value": 1
+            },
+            {
+              "pdl": 4,
+              "penalty_value": 2.5
+            }
+          ],
+          "min_spacing": 87.5e9,
+          "cost": 1
+        }
+      ]
+    }
+  ]
+}

gnpy/example-data/extra_eqpt_config.json

@@ -0,0 +1,74 @@
+{
+  "Edfa": [
+    {
+      "type_variety": "user_defined",
+      "type_def": "variable_gain",
+      "f_min": 192.0e12,
+      "f_max": 195.9e12,
+      "gain_flatmax": 25,
+      "gain_min": 15,
+      "p_max": 21,
+      "nf_min": 6,
+      "nf_max": 10,
+      "default_config_from_json": "user_edfa_config.json",
+      "out_voa_auto": false,
+      "allowed_for_design": true
+    }, {
+      "type_variety": "user_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
+    }
+  ],
+  "Transceiver": [
+    {
+      "type_variety": "ZR400G",
+      "frequency": {
+        "min": 191.3e12,
+        "max": 196.1e12
+      },
+      "mode": [
+        {
+          "format": "SFF-ID:70",
+          "baud_rate": 60138546798,
+          "OSNR": 24,
+          "bit_rate": 400e9,
+          "roll_off": 0.2,
+          "tx_osnr": 34,
+          "min_spacing": 75e9,
+          "penalties": [
+            {
+              "chromatic_dispersion": 20e3,
+              "penalty_value": 0.5
+            },
+            {
+              "chromatic_dispersion": 0,
+              "penalty_value": 0
+            },
+            {
+              "pmd": 20,
+              "penalty_value": 0.5
+            },
+            {
+              "pdl": 1.5,
+              "penalty_value": 0
+            },
+            {
+              "pdl": 3.5,
+              "penalty_value": 1.8
+            },
+            {
+              "pdl": 3,
+              "penalty_value": 1.3
+            }
+          ],
+          "cost": 1
+        }
+      ]
+    }
+  ]
+}

gnpy/example-data/fused_roadm_example_network.json

@@ -0,0 +1,196 @@
+{
+  "elements": [
+    {
+      "uid": "trx Site_A",
+      "metadata": {
+        "location": {
+          "city": "Site_A",
+          "region": "",
+          "latitude": 0,
+          "longitude": 0
+        }
+      },
+      "type": "Transceiver"
+    },
+    {
+      "uid": "trx Site_C",
+      "metadata": {
+        "location": {
+          "city": "Site_C",
+          "region": "",
+          "latitude": 0,
+          "longitude": 0
+        }
+      },
+      "type": "Transceiver"
+    },
+    {
+      "uid": "roadm Site_A",
+      "metadata": {
+        "location": {
+          "city": "Site_A",
+          "region": "",
+          "latitude": 0,
+          "longitude": 0
+        }
+      },
+      "type": "Roadm",
+      "params": {
+        "loss": 17
+      }
+    },
+    {
+      "uid": "roadm Site_C",
+      "metadata": {
+        "location": {
+          "city": "Site_C",
+          "region": "",
+          "latitude": 0,
+          "longitude": 0
+        }
+      },
+      "type": "Roadm"
+    },
+    {
+      "uid": "ingress fused spans in Site_B",
+      "metadata": {
+        "location": {
+          "city": "Site_B",
+          "region": "",
+          "latitude": 0,
+          "longitude": 0
+        }
+      },
+      "type": "Fused",
+      "params": {
+        "loss": 0.5
+      }
+    },
+    {
+      "uid": "egress fused spans in Site_B",
+      "metadata": {
+        "location": {
+          "city": "Site_B",
+          "region": "",
+          "latitude": 0,
+          "longitude": 0
+        }
+      },
+      "type": "Fused"
+    },
+    {
+      "uid": "fiber (Site_A \u2192 Site_B)-",
+      "metadata": {
+        "location": {
+          "latitude": 0.0,
+          "longitude": 0.0
+        }
+      },
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "length": 40.0,
+        "length_units": "km",
+        "loss_coef": 0.2
+      }
+    },
+    {
+      "uid": "fiber (Site_B \u2192 Site_C)-",
+      "metadata": {
+        "location": {
+          "latitude": 0.0,
+          "longitude": 0.0
+        }
+      },
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "length": 50.0,
+        "length_units": "km",
+        "loss_coef": 0.2
+      }
+    },
+    {
+      "uid": "fiber (Site_B \u2192 Site_A)-",
+      "metadata": {
+        "location": {
+          "latitude": 0.0,
+          "longitude": 0.0
+        }
+      },
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "length": 40.0,
+        "length_units": "km",
+        "loss_coef": 0.2
+      }
+    },
+    {
+      "uid": "fiber (Site_C \u2192 Site_B)-",
+      "metadata": {
+        "location": {
+          "latitude": 0.0,
+          "longitude": 0.0
+        }
+      },
+      "type": "Fiber",
+      "type_variety": "SSMF",
+      "params": {
+        "length": 50.0,
+        "length_units": "km",
+        "loss_coef": 0.2
+      }
+    }
+  ],
+  "connections": [
+    {
+      "from_node": "roadm Site_A",
+      "to_node": "fiber (Site_A \u2192 Site_B)-"
+    },
+    {
+      "from_node": "fiber (Site_B \u2192 Site_A)-",
+      "to_node": "roadm Site_A"
+    },
+    {
+      "from_node": "fiber (Site_A \u2192 Site_B)-",
+      "to_node": "ingress fused spans in Site_B"
+    },
+    {
+      "from_node": "ingress fused spans in Site_B",
+      "to_node": "fiber (Site_B \u2192 Site_C)-"
+    },
+    {
+      "from_node": "fiber (Site_C \u2192 Site_B)-",
+      "to_node": "egress fused spans in Site_B"
+    },
+    {
+      "from_node": "egress fused spans in Site_B",
+      "to_node": "fiber (Site_B \u2192 Site_A)-"
+    },
+    {
+      "from_node": "roadm Site_C",
+      "to_node": "fiber (Site_C \u2192 Site_B)-"
+    },
+    {
+      "from_node": "fiber (Site_B \u2192 Site_C)-",
+      "to_node": "roadm Site_C"
+    },
+    {
+      "from_node": "trx Site_A",
+      "to_node": "roadm Site_A"
+    },
+    {
+      "from_node": "roadm Site_A",
+      "to_node": "trx Site_A"
+    },
+    {
+      "from_node": "trx Site_C",
+      "to_node": "roadm Site_C"
+    },
+    {
+      "from_node": "roadm Site_C",
+      "to_node": "trx Site_C"
+    }
+  ]
+}

gnpy/example-data/initial_spectrum1.json

@@ -0,0 +1,12 @@
+{
+  "spectrum": [
+    {
+      "f_min": 191.35e12,
+      "f_max": 195.1e12,
+      "baud_rate": 32e9,
+      "slot_width": 50e9,
+      "roll_off": 0.15,
+      "tx_osnr": 40
+    }
+  ]
+}

gnpy/example-data/initial_spectrum2.json

@@ -0,0 +1,23 @@
+{
+  "spectrum": [
+    {
+      "f_min": 191.4e12,
+      "f_max": 193.1e12,
+      "baud_rate": 32e9,
+      "slot_width": 50e9,
+      "delta_pdb": 0,
+      "roll_off": 0.15,
+      "tx_osnr": 40,
+      "label": "mode_1"
+    },
+    {
+      "f_min": 193.1625e12,
+      "f_max": 195e12,
+      "baud_rate": 64e9,
+      "slot_width": 75e9,
+      "roll_off": 0.15,
+      "tx_osnr": 40,
+      "label": "mode_2"
+    }
+  ]
+}