GNPy: Optical Route Planning Library

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.

Contents

• Introduction
  • Further Instructions for Use
• Simulating networks with GNPy
  • Network Topology
    • Fully Specified vs. Partially Designed Networks
  • The Equipment Library
    • Amplifier Noise Figure Models
      • Min-max NF
      • Raman Approximation
  • Simulation
• Installing GNPy
  • Using prebuilt Docker images
  • Using Python on your computer
    • Installing the Python package
• gnpy-path-request and gnpy-transmission-example scripts
  • Common options
    • Option: –no-insert-edfas
    • Option: –equipment, -e
    • Option: –extra-equipment and –extra-config
    • Option: –save-network
    • Option: –save-network-before-autodesign
    • Option: –sim-params
  • gnpy-transmission-example options
    • Option: –show-channels
    • Option: -pl, –plot
    • Option: -l, –list-nodes
    • Option: -po, –power
    • Option: –spectrum
  • Options for path_requests_run
    • Option: -bi, –bidir
    • Option: -o, –output
    • Option: –redesign-per-request
• Amplifier models and Configuration
  • 1. Equipment configuration description
  • 2. Amplifier parameters and subtypes
  • 3. Amplifier models
  • 4. advanced_config_from_json
• JSON Input Files
  • Equipment Library
    • EDFA
    • Fiber
    • RamanFiber
    • Transceiver
    • ROADM
  • Global parameters
    • Span
    • SpectralInformation
    • Arbitrary channel definition
    • Equalization choices
  • Topology
    • Common attributes
    • Fiber attributes/ RamanFiber attributes
    • Edfa attributes
    • Multiband_amplifier attributes
    • Roadm
    • Fused
    • Transceiver
  • Service JSON file
• JSON examples
  • 1. Equipment description
    • 1.1. Structure definition
      • 1.1.1. Equipment types
      • 1.1.2. Equipment parameters and subtypes
    • 1.2. Equipment parameters by type
      • 1.2.1. Amplifier types
      • 1.2.2. Fiber and RamanFiber types
      • 1.2.3 Roadm types
      • 1.2.5. Transceiver type
      • 1.2.3. Spans element
      • 1.2.4. Spectral Information
  • 2. Network description
    • 2.1. Structure definition
      • 2.1.1. File root structure
      • 2.1.2. Elements parameters and subtypes
    • 2.2. Element parameters by type
      • 2.2.1. Transceiver element
      • 2.2.2. ROADM element
      • 2.2.3. Fused element
      • 2.2.4. Fiber element
      • 2.2.5. RamanFiber element
      • 2.2.6. EDFA element
    • 2.3. Connections objects
  • 3. Simulation Parameters
  • 4. Services file
    • 4.1. Service Excel format
    • 4.2. Service JSON format
      • 4.2.1. requests
      • 4.2.2. synchronization
  • 5. Spectrum file
• Excel (XLS, XLSX) input files
  • Nodes sheet
  • Links sheet
  • Eqpt sheet
  • Roadms sheet
  • Service sheet
• Extending GNPy with vendor-specific data
  • EDFAs
    • Polynomial NF
    • Polynomial OSNR (OpenROADM-style for inline amplifier)
    • Noise mask (OpenROADM-style for combined preamp and booster)
    • Min-max NF
    • Dual-stage
    • Advanced Specification
  • Raman Amplifiers
  • Transponders
  • ROADMs
• About the project
  • Contributing
  • Project Background
  • TIP OOPT/PSE & PSE WG Charter
  • License
• Physical Model used in GNPy
  • QoT-E including ASE noise and NLI accumulation
  • The Gaussian Noise Model to evaluate the NLI
• API Reference Documentation
  • GNPy package
    • gnpy.core
      • gnpy.core.ansi_escapes
      • gnpy.core.elements
      • Edfa
      • Fiber
      • Fused
      • Location
      • Multiband_amplifier
      • RamanFiber
      • Roadm
      • Transceiver
      • _Node
      • gnpy.core.equipment
      • find_type_varieties()
      • find_type_variety()
      • trx_mode_params()
      • gnpy.core.exceptions
      • ConfigurationError
      • DisjunctionError
      • EquipmentConfigError
      • NetworkTopologyError
      • ParametersError
      • ServiceError
      • SpectrumError
      • gnpy.core.info
      • Carrier
      • Channel
      • DEFAULT_SLOT_WIDTH_STEP
      • Power
      • ReferenceCarrier
      • SpectralInformation
      • carriers_to_spectral_information()
      • create_arbitrary_spectral_information()
      • create_input_spectral_information()
      • demuxed_spectral_information()
      • is_in_band()
      • muxed_spectral_information()
      • gnpy.core.network
      • add_connector_loss()
      • add_fiber_padding()
      • add_inline_amplifier()
      • add_missing_elements_in_network()
      • add_missing_fiber_attributes()
      • add_roadm_booster()
      • add_roadm_preamp()
      • build_network()
      • calculate_new_length()
      • check_oms_single_type()
      • compute_band_power_deviation_and_tilt()
      • compute_gain_power_and_tilt_target()
      • compute_tilt_using_previous_and_next_spans()
      • design_network()
      • edfa_nf()
      • estimate_raman_gain()
      • estimate_srs_power_deviation()
      • filter_edfa_list_based_on_targets()
      • find_first_node()
      • find_last_node()
      • get_next_node()
      • get_node_restrictions()
      • get_oms_edge_list()
      • get_oms_edge_list_from_egress()
      • get_previous_node()
      • next_node_generator()
      • preselect_multiband_amps()
      • prev_node_generator()
      • select_edfa()
      • set_amplifier_voa()
      • set_egress_amplifier()
      • set_fiber_input_power()
      • set_one_amplifier()
      • set_per_degree_design_band()
      • set_roadm_input_powers()
      • set_roadm_internal_paths()
      • set_roadm_per_degree_targets()
      • set_roadm_ref_carrier()
      • span_loss()
      • split_fiber()
      • target_power()
      • gnpy.core.parameters
      • EdfaOperational
      • EdfaParams
      • FiberParams
      • FrequencyBand
      • FusedParams
      • MultiBandParams
      • NLIParams
      • Parameters
      • PumpParams
      • RamanGainCoefficient
      • RamanParams
      • RoadmImpairment
      • RoadmParams
      • RoadmPath
      • SimParams
      • TransceiverParams
      • find_band_name()
      • gnpy.core.science_utils
      • NliSolver
      • RamanSolver
      • StimulatedRamanScattering
      • estimate_nf_model()
      • raised_cosine()
      • gnpy.core.utils
      • arrange_frequencies()
      • automatic_fmax()
      • automatic_nch()
      • calculate_absolute_min_or_zero()
      • convert_length()
      • db2lin()
      • dbm2watt()
      • deltaf2deltawl()
      • deltawl2deltaf()
      • find_common_range()
      • lin2db()
      • merge_amplifier_restrictions()
      • nice_column_str()
      • order_slots()
      • per_label_average()
      • power_dbm_to_psd_mw_ghz()
      • pretty_summary_print()
      • psd2powerdbm()
      • psd_mw_per_ghz()
      • replace_none()
      • restore_order()
      • round2float()
      • rrc()
      • silent_remove()
      • snr_sum()
      • transform_data()
      • unique_ordered()
      • watt2dbm()
      • write_csv()
    • gnpy.topology
      • gnpy.topology.request
      • Disjunction
      • DisjunctionParams
      • PathRequest
      • RequestParams
      • ResultElement
      • _penalty_msg()
      • compare_reqs()
      • compute_constrained_path()
      • compute_path_dsjctn()
      • compute_path_with_disjunction()
      • compute_spectrum_slot_vs_bandwidth()
      • correct_json_route_list()
      • deduplicate_disjunctions()
      • explicit_path()
      • filter_si()
      • find_elements_common_range()
      • find_reversed_path()
      • is_adjacent()
      • isdisjoint()
      • ispart()
      • jsontocsv()
      • jsontoparams()
      • jsontopath_metric()
      • propagate()
      • propagate_and_optimize_mode()
      • remove_candidate()
      • requests_aggregation()
      • gnpy.topology.spectrum_assignment
      • Bitmap
      • OMS
      • OMSParams
      • aggregate_oms_bitmap()
      • align_grids()
      • bitmap_sum()
      • build_oms_list()
      • build_path_oms_id_list()
      • compute_n_m()
      • create_oms_bitmap()
      • determine_slot_numbers()
      • find_network_freq_range()
      • frequency_to_n()
      • m_to_freq()
      • mvalue_to_slots()
      • nvalue_to_frequency()
      • pth_assign_spectrum()
      • reversed_oms()
      • select_candidate()
      • slots_to_m()
      • spectrum_selection()
    • gnpy.tools
      • gnpy.tools.cli_examples
      • _add_common_options()
      • _path_result_json()
      • _setup_logging()
      • load_common_data()
      • path_requests_run()
      • show_example_data_dir()
      • transmission_main_example()
      • gnpy.tools.convert
      • Eqpt
      • Link
      • Node
      • Roadm
      • _do_convert()
      • _format_items()
      • all_rows()
      • connect_eqpt()
      • convert_file()
      • corresp_names()
      • corresp_next_node()
      • create_east_eqpt_element()
      • create_roadm_element()
      • create_west_eqpt_element()
      • eqpt_connection_by_city()
      • eqpt_in_city_to_city()
      • fiber_dest_from_source()
      • fiber_link()
      • midpoint()
      • parse_excel()
      • parse_headers()
      • parse_row()
      • parse_sheet()
      • read_header()
      • read_slice()
      • sanity_check()
      • xls_to_json_data()
      • gnpy.tools.json_io
      • Amp
      • Fiber
      • Model_dual_stage
      • Model_fg
      • Model_hybrid
      • Model_openroadm_booster
      • Model_openroadm_ila
      • Model_openroadm_preamp
      • Model_vg
      • RamanFiber
      • Roadm
      • SI
      • Span
      • Transceiver
      • _JsonThing
      • _check_fiber_vs_raman_fiber()
      • _check_one_request()
      • _cls_for()
      • _equipment_from_json()
      • _roadm_restrictions_sanity_check()
      • _si_sanity_check()
      • _spectrum_from_json()
      • _update_band()
      • _update_dual_stage()
      • convert_service_sheet()
      • disjunctions_from_json()
      • find_equalisation()
      • load_eqpt_topo_from_json()
      • load_equipment()
      • load_equipments_and_configs()
      • load_initial_spectrum()
      • load_json()
      • load_network()
      • load_requests()
      • merge_equalization()
      • merge_equipment()
      • network_from_json()
      • network_to_json()
      • requests_from_json()
      • results_to_json()
      • save_json()
      • save_network()
      • gnpy.tools.plots
      • _try_city()
      • plot_baseline()
      • plot_results()
      • gnpy.tools.service_sheet
      • Element
      • Request
      • Request_element
      • check_end_points()
      • correct_xlrd_int_to_str_reading()
      • correct_xls_route_list()
      • find_node_sugestion()
      • parse_excel()
      • parse_row()
      • parse_service_sheet()
      • read_service_sheet()
      • gnpy.tools.worker_utils
      • check_request_path_ids()
      • designed_network()
      • planning()
      • transmission_simulation()
• Release change log
  • v2.11
  • v2.10
  • v2.9
  • v2.8
  • v2.7
• Publications
• Index
• Module Index

Indices and tables

• Index

• Module Index

• Search Page