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.
- Introduction
- Simulating networks with GNPy
- Installing GNPy
- JSON Input Files
- Excel (XLS, XLSX) input files
- Extending GNPy with vendor-specific data
- About the project
- Physical Model used in GNPy
- API Reference Documentation
gnpypackagegnpy.core- gnpy.core.ansi_escapes
- gnpy.core.elements
EdfaFiberFusedLocationRamanFiberRoadmTransceiver_Node- gnpy.core.equipment
trx_mode_params()- gnpy.core.exceptions
ConfigurationErrorDisjunctionErrorEquipmentConfigErrorNetworkTopologyErrorParametersErrorServiceErrorSpectrumError- gnpy.core.info
CarrierChannelDEFAULT_SLOT_WIDTH_STEPPowerReferenceCarrierSpectralInformationcarriers_to_spectral_information()create_arbitrary_spectral_information()create_input_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()design_network()edfa_nf()estimate_raman_gain()find_first_node()find_last_node()get_next_node()next_node_generator()prev_node_generator()select_edfa()set_amplifier_voa()set_egress_amplifier()set_fiber_input_power()set_roadm_input_powers()set_roadm_per_degree_targets()set_roadm_ref_carrier()span_loss()split_fiber()target_power()- gnpy.core.parameters
EdfaOperationalEdfaParamsFiberParamsFusedParamsNLIParamsParametersPumpParamsRamanGainCoefficientRamanParamsRoadmParamsSimParams- gnpy.core.science_utils
NliSolverRamanSolverStimulatedRamanScatteringestimate_nf_model()raised_cosine()- gnpy.core.utils
arrange_frequencies()automatic_fmax()automatic_nch()convert_length()db2lin()dbm2watt()deltaf2deltawl()deltawl2deltaf()freq2wavelength()lin2db()merge_amplifier_restrictions()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()watt2dbm()write_csv()
gnpy.topology- gnpy.topology.request
DisjunctionDisjunctionParamsPathRequestRequestParamsResultElement_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()find_reversed_path()isdisjoint()ispart()jsontocsv()jsontoparams()jsontopath_metric()propagate()propagate_and_optimize_mode()remove_candidate()requests_aggregation()- gnpy.topology.spectrum_assignment
BitmapOMSOMSParamsaggregate_oms_bitmap()align_grids()bitmap_sum()build_oms_list()build_path_oms_id_list()compute_n_m()determine_slot_numbers()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
EqptLinkNodeRoadm_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
AmpFiberModel_dual_stageModel_fgModel_hybridModel_openroadm_boosterModel_openroadm_ilaModel_openroadm_preampModel_vgRamanFiberRoadmSISpanTransceiver_JsonThing_automatic_spacing()_check_fiber_vs_raman_fiber()_check_one_request()_cls_for()_equipment_from_json()_roadm_restrictions_sanity_check()_spectrum_from_json()_update_dual_stage()convert_service_sheet()disjunctions_from_json()find_equalisation()load_equipment()load_initial_spectrum()load_json()load_network()load_requests()merge_equalization()network_from_json()network_to_json()requests_from_json()save_json()save_network()- gnpy.tools.plots
_try_city()plot_baseline()plot_results()- gnpy.tools.service_sheet
ElementRequestRequest_elementall_rows()correct_xlrd_int_to_str_reading()correct_xls_route_list()parse_excel()parse_row()parse_service_sheet()read_service_sheet()
- Release change log
