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

examples: add some additional descriptions help context

Browse Source 
The main reason for doing this is becasue of the next commit which
re-adds testing of the generated wrappers.

Change-Id: I7137c6cf7a5b414fc708a15b125eaf88e996366c
This commit is contained in:
Jan Kundrát
2020-06-05 15:28:02 +02:00
parent 3b61c6ca4c
commit 1009b44d2a
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
gnpy/tools/cli_examples.py
View File

@@ -34,6 +34,12 @@ from gnpy.tools.plots import plot_baseline, plot_results
_logger = logging.getLogger(__name__) _logger = logging.getLogger(__name__)
_examples_dir = Path(__file__).parent.parent.parent / 'examples' _examples_dir = Path(__file__).parent.parent.parent / 'examples'
_help_footer = '''
This program is part of GNPy, https://github.com/TelecomInfraProject/oopt-gnpy
Learn more at https://gnpy.readthedocs.io/
'''
def load_common_data(equipment_filename, topology_filename, simulation_filename=None, fuzzy_name_matching=False): def load_common_data(equipment_filename, topology_filename, simulation_filename=None, fuzzy_name_matching=False):
@@ -73,7 +79,10 @@ def _setup_logging(args):
def transmission_main_example(args=None): def transmission_main_example(args=None):
parser = ArgumentParser() parser = ArgumentParser(
description='Send a full spectrum load through the network from point A to point B',
epilog=_help_footer,
)
parser.add_argument('-e', '--equipment', type=Path, parser.add_argument('-e', '--equipment', type=Path,
default=_examples_dir / 'eqpt_config.json') default=_examples_dir / 'eqpt_config.json')
parser.add_argument('--sim-params', type=Path, parser.add_argument('--sim-params', type=Path,
@@ -290,7 +299,10 @@ def _path_result_json(pathresult):
def path_requests_run(args=None): def path_requests_run(args=None):
parser = ArgumentParser(description='Compute performance for a list of services provided in a json file or an excel sheet.') parser = ArgumentParser(
description='Compute performance for a list of services provided in a json file or an excel sheet',
epilog=_help_footer,
)
parser.add_argument('network_filename', nargs='?', type=Path, parser.add_argument('network_filename', nargs='?', type=Path,
default=_examples_dir / 'meshTopologyExampleV2.xls', default=_examples_dir / 'meshTopologyExampleV2.xls',
help='input topology file in xls or json') help='input topology file in xls or json')