scottk/oopt-gnpy
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/oopt-gnpy.git synced 2025-10-30 01:32:21 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

docs: basic stuff about the module structure

Browse Source 
As a bonus, in the Python shell, `help(gnpy)`, `help(gnpy.core)`, etc,
now produce at least some useful information.

Change-Id: I76ade6f2456fcebd3c0a147374815dd245dc4b10
This commit is contained in:
Jan Kundrát
2020-05-26 18:14:24 +02:00
parent 0b03725295
commit c8daa5ed8c
4 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
gnpy/__init__.py
View File

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

9
gnpy/core/__init__.py Normal file
View File

@@ -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`.
'''

5
gnpy/tools/__init__.py Normal file
View File

@@ -0,0 +1,5 @@
'''
Processing of data via :py:mod:`.json_io`.
Utilities for Excel conversion in :py:mod:`.convert` and :py:mod:`.service_sheet`.
Example code in :py:mod:`.cli_examples` and :py:mod:`.plots`.
'''

3
gnpy/topology/__init__.py Normal file
View File

@@ -0,0 +1,3 @@
'''
Tracking :py:mod:`.request` for spectrum and their :py:mod:`.spectrum_assignment`.
'''