From 73ea817cf47f0cdedb62c95da7c372d03bab22b9 Mon Sep 17 00:00:00 2001 From: EstherLerouzic Date: Fri, 14 Feb 2025 14:06:13 +0100 Subject: [PATCH] fix documentation: harmonize titles Signed-off-by: EstherLerouzic Change-Id: I827b4dcd1418017d925b63e50f95514dc1a0eed8 --- docs/cli_options.rst | 41 ++++++++++----------- docs/json_instance_examples.rst | 65 ++++++++++++++++----------------- 2 files changed, 52 insertions(+), 54 deletions(-) diff --git a/docs/cli_options.rst b/docs/cli_options.rst index fe9103849..7e0db3b57 100644 --- a/docs/cli_options.rst +++ b/docs/cli_options.rst @@ -1,13 +1,14 @@ .. _cli-options: -Options Documentation for `gnpy-path-request` and `gnpy-transmission-example` -============================================================================= +*********************************************************** +`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. @@ -37,7 +38,7 @@ When the `--no-insert-edfas` option is specified: **Option**: `--equipment`, `-e` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------- **Description**: Specifies the equipment library file. @@ -52,7 +53,7 @@ When the `--no-insert-edfas` option is 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 @@ -98,8 +99,6 @@ equipment types or specific configurations that are not included in the standard 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. -Example -------- To run the program with additional equipment and configuration files, you can use the following command: .. code-block:: shell-session @@ -116,7 +115,7 @@ In this example: **Option**: `--save-network` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------- **Description**: Saves the final network configuration to a specified JSON file. @@ -130,7 +129,7 @@ In this example: **Option**: `--save-network-before-autodesign` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------------------------- **Description**: Dumps the network into a JSON file prior to autodesign. @@ -144,7 +143,7 @@ In this example: **Option**: `--sim-params` -~~~~~~~~~~~~~~~~~~~~~~~~~~ +-------------------------- **Description**: Path to the JSON file containing simulation parameters. @@ -163,10 +162,10 @@ The tuning of the parameters is detailed here: :ref:`json input sim-params` values of the library a 2.2.2. ROADM element -********************* +^^^^^^^^^^^^^^^^^^^^ ROADM element with its parameters. **“params”** is optional, if nothing is defined, it uses default values from equipment library. @@ -707,7 +707,7 @@ it uses default values from equipment library. 2.2.3. Fused element -********************* +^^^^^^^^^^^^^^^^^^^^ Fused element with its parameters. **“params”** is optional, if not used default loss value of 1dB is used. @@ -732,7 +732,7 @@ default loss value of 1dB is used. 2.2.4. Fiber element -********************* +^^^^^^^^^^^^^^^^^^^^ Fiber element with its parameters. @@ -782,7 +782,7 @@ Fiber element with its parameters. 2.2.5. RamanFiber element -************************* +^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: json @@ -826,7 +826,7 @@ Fiber element with its parameters. 2.2.6. EDFA element -******************** +^^^^^^^^^^^^^^^^^^^ EDFA element with its parameters. @@ -851,7 +851,7 @@ EDFA element with its parameters. } 2.3. Connections objects -************************* +------------------------ Each unidirectional connection object in connections array consist of two unordered **”from_node”** and **”to_node”** name pair with values @@ -866,7 +866,7 @@ corresponding to element **”uid”** 3. Simulation Parameters -######################## +======================== Additional details of the simulation are controlled via ``sim_params.json``: @@ -888,19 +888,19 @@ Additional details of the simulation are controlled via ``sim_params.json``: 4. Services file -################ +================ **gnpy-path-request** requires a second positional file that contains a list of services to be computed. 4.1. Service Excel format -************************* +------------------------- Services can be defined either via a :ref:`XLS files`. 4.2. Service JSON format -************************ +------------------------ The JSON format is derived from draft-ietf-teas-yang-path-computation-01.txt. @@ -915,7 +915,7 @@ to define disjunctions among services. } 4.2.1. requests -*************** +^^^^^^^^^^^^^^^ **path-request** contains the path and transceiver details. See :ref:`services` for a detailed description of each parameter. @@ -985,7 +985,7 @@ See :ref:`services` for a detailed description of each parameter. } 4.2.2. synchronization -********************** +^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: json @@ -1002,9 +1002,8 @@ See :ref:`services` for a detailed description of each parameter. } -**************** -1. Spectrum file -**************** +5. Spectrum file +================ **gnpy-transmission-example** supports a `--spectrum` option to specify non identical type of channels derailed in a JSON file (details :ref:`here`). Note that **gnpy-path-request**