Skip to content

gui#

gui#

dfastbe.gui.gui #

Copyright (C) 2020 Stichting Deltares.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation version 2.1.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, see http://www.gnu.org/licenses/.

contact: delft3d.support@deltares.nl Stichting Deltares P.O. Box 177 2600 MH Delft, The Netherlands

All indications and logos of, and references to, "Delft3D" and "Deltares" are registered trademarks of Stichting Deltares, and remain the property of Stichting Deltares. All rights reserved.

INFORMATION This file is part of D-FAST Bank Erosion: https://github.com/Deltares/D-FAST_Bank_Erosion

activate_dialog() -> None #

Activate the user interface and run the program.

Arguments#

None

Source code in src/dfastbe/gui/gui.py 
584
585
586
587
588
589
590
591
592
593
594
595
def activate_dialog() -> None:
    """
    Activate the user interface and run the program.

    Arguments
    ---------
    None
    """
    app = dialog["application"]
    win = dialog["window"]
    win.show()
    sys.exit(app.exec_())

addAnItem(key: str) -> None #

Implements the actions for the add item button.

Arguments#

key : str Short name of the parameter.

Source code in src/dfastbe/gui/gui.py 
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
def addAnItem(key: str) -> None:
    """
    Implements the actions for the add item button.

    Arguments
    ---------
    key : str
        Short name of the parameter.
    """
    nItems = dialog[key].invisibleRootItem().childCount()
    i = nItems + 1
    istr = str(i)
    if key == "searchLines":
        fileName, dist = editASearchLine(key, istr)
        c1 = QtWidgets.QTreeWidgetItem(dialog["searchLines"], [istr, fileName, dist])
    elif key == "discharges":
        prob = str(1 / (nItems + 1))
        fileName, prob = editADischarge(key, istr, prob=prob)
        c1 = QtWidgets.QTreeWidgetItem(dialog["discharges"], [istr, fileName, prob])
        addTabForLevel(istr)
        dialog["refLevel"].validator().setTop(i)
    dialog[key + "Edit"].setEnabled(True)
    dialog[key + "Remove"].setEnabled(True)

addBankTab(tabs: PyQt5.QtWidgets.QTabWidget, win: PyQt5.QtWidgets.QMainWindow) -> None #

Create the tab for the general bank properties.

Arguments#

tabs : PyQt5.QtWidgets.QTabWidget Tabs object to which the tab should be added. win : PyQt5.QtWidgets.QMainWindow The window object in which the tab item is located.

Source code in src/dfastbe/gui/gui.py 
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
def addBankTab(
    tabs: PyQt5.QtWidgets.QTabWidget, win: PyQt5.QtWidgets.QMainWindow
) -> None:
    """
    Create the tab for the general bank properties.

    Arguments
    ---------
    tabs : PyQt5.QtWidgets.QTabWidget
        Tabs object to which the tab should be added.
    win : PyQt5.QtWidgets.QMainWindow
        The window object in which the tab item is located.
    """
    eParamsWidget = QtWidgets.QWidget()
    eParamsLayout = QtWidgets.QGridLayout(eParamsWidget)
    tabs.addTab(eParamsWidget, "Bank Parameters")

    strength = QtWidgets.QLabel("Strength Parameter")
    eParamsLayout.addWidget(strength, 0, 0)
    strengthPar = QtWidgets.QComboBox()
    strengthPar.addItems(("Bank Type", "Critical Shear Stress"))
    strengthPar.currentIndexChanged.connect(bankStrengthSwitch)
    dialog["strengthPar"] = strengthPar
    eParamsLayout.addWidget(strengthPar, 0, 1, 1, 2)

    generalParLayout(
        eParamsLayout,
        1,
        "bankType",
        "Bank Type",
        selectList=[
            "0 (Beschermde oeverlijn)",
            "1 (Begroeide oeverlijn)",
            "2 (Goede klei)",
            "3 (Matig / slechte klei)",
            "4 (Zand)",
        ],
    )
    generalParLayout(eParamsLayout, 3, "bankShear", "Critical Shear Stress [N/m2]")
    bankStrengthSwitch()
    generalParLayout(eParamsLayout, 4, "bankProtect", "Protection [m]")
    generalParLayout(eParamsLayout, 5, "bankSlope", "Slope [-]")
    generalParLayout(eParamsLayout, 6, "bankReed", "Reed [-]")

    addFilter(eParamsLayout, 7, "velFilter", "Velocity Filter [km]")
    addFilter(eParamsLayout, 8, "bedFilter", "Bank Elevation Filter [km]")

    stretch = QtWidgets.QSpacerItem(10, 10, 13, 7)
    eParamsLayout.addItem(stretch, 9, 0)

addCheckBox(formLayout: PyQt5.QtWidgets.QFormLayout, key: str, labelString: str, isChecked: bool = False) -> None #

Add a line of with checkbox control to a form layout.

Arguments#

formLayout : PyQt5.QtWidgets.QFormLayout Form layout object in which to position the edit controls. key : str Short name of the parameter. labelString : str String describing the parameter to be displayed as label. isChecked : bool Initial state of the check box.

Source code in src/dfastbe/gui/gui.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
def addCheckBox(
    formLayout: PyQt5.QtWidgets.QFormLayout,
    key: str,
    labelString: str,
    isChecked: bool = False,
) -> None:
    """
    Add a line of with checkbox control to a form layout.

    Arguments
    ---------
    formLayout : PyQt5.QtWidgets.QFormLayout
        Form layout object in which to position the edit controls.
    key : str
        Short name of the parameter.
    labelString : str
        String describing the parameter to be displayed as label.
    isChecked : bool
        Initial state of the check box.
    """
    checkBox = QtWidgets.QCheckBox("")
    checkBox.setChecked(isChecked)
    dialog[key + "Edit"] = checkBox

    checkTxt = QtWidgets.QLabel(labelString)
    dialog[key] = checkTxt
    formLayout.addRow(checkTxt, checkBox)

addDetectTab(tabs: PyQt5.QtWidgets.QTabWidget, win: PyQt5.QtWidgets.QMainWindow, app: PyQt5.QtWidgets.QApplication) -> None #

Create the tab for the bank line detection settings.

Arguments#

tabs : PyQt5.QtWidgets.QTabWidget Tabs object to which the tab should be added. win : PyQt5.QtWidgets.QMainWindow The window object in which the tab item is located. app : PyQt5.QtWidgets.QApplication The application object to which the window belongs, needed for font information.

Source code in src/dfastbe/gui/gui.py 
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
def addDetectTab(
    tabs: PyQt5.QtWidgets.QTabWidget,
    win: PyQt5.QtWidgets.QMainWindow,
    app: PyQt5.QtWidgets.QApplication,
) -> None:
    """
    Create the tab for the bank line detection settings.

    Arguments
    ---------
    tabs : PyQt5.QtWidgets.QTabWidget
        Tabs object to which the tab should be added.
    win : PyQt5.QtWidgets.QMainWindow
        The window object in which the tab item is located.
    app : PyQt5.QtWidgets.QApplication
        The application object to which the window belongs, needed for font information.
    """
    detectWidget = QtWidgets.QWidget()
    detectLayout = QtWidgets.QFormLayout(detectWidget)
    tabs.addTab(detectWidget, "Detection")

    addOpenFileRow(detectLayout, "simFile", "Simulation File")

    waterDepth = QtWidgets.QLineEdit(win)
    waterDepth.setValidator(validator("positive_real"))
    dialog["waterDepth"] = waterDepth
    detectLayout.addRow("Water Depth [m]", waterDepth)

    searchLines = QtWidgets.QTreeWidget(win)
    searchLines.setHeaderLabels(["Index", "FileName", "Search Distance [m]"])
    searchLines.setFont(app.font())
    searchLines.setColumnWidth(0, 50)
    searchLines.setColumnWidth(1, 200)
    # c1 = QtWidgets.QTreeWidgetItem(searchLines, ["0", "test\\filename", "50"])

    slLayout = addRemoveEditLayout(searchLines, "searchLines")
    detectLayout.addRow("Search Lines", slLayout)

addErosionTab(tabs: PyQt5.QtWidgets.QTabWidget, win: PyQt5.QtWidgets.QMainWindow, app: PyQt5.QtWidgets.QApplication) -> None #

Create the tab for the main bank erosion settings.

Arguments#

tabs : PyQt5.QtWidgets.QTabWidget Tabs object to which the tab should be added. win : PyQt5.QtWidgets.QMainWindow The window object in which the tab item is located. app : PyQt5.QtWidgets.QApplication The application object to which the window belongs, needed for font information.

Source code in src/dfastbe/gui/gui.py 
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
def addErosionTab(
    tabs: PyQt5.QtWidgets.QTabWidget,
    win: PyQt5.QtWidgets.QMainWindow,
    app: PyQt5.QtWidgets.QApplication,
) -> None:
    """
    Create the tab for the main bank erosion settings.

    Arguments
    ---------
    tabs : PyQt5.QtWidgets.QTabWidget
        Tabs object to which the tab should be added.
    win : PyQt5.QtWidgets.QMainWindow
        The window object in which the tab item is located.
    app : PyQt5.QtWidgets.QApplication
        The application object to which the window belongs, needed for font information.
    """
    erosionWidget = QtWidgets.QWidget()
    erosionLayout = QtWidgets.QFormLayout(erosionWidget)
    tabs.addTab(erosionWidget, "Erosion")

    tErosion = QtWidgets.QLineEdit(win)
    tErosion.setValidator(validator("positive_real"))
    dialog["tErosion"] = tErosion
    erosionLayout.addRow("Simulation Time [yr]", tErosion)

    addOpenFileRow(erosionLayout, "riverAxis", "River Axis File")

    addOpenFileRow(erosionLayout, "fairway", "Fairway File")

    discharges = QtWidgets.QTreeWidget(win)
    discharges.setHeaderLabels(["Level", "FileName", "Probability [-]"])
    discharges.setFont(app.font())
    discharges.setColumnWidth(0, 50)
    discharges.setColumnWidth(1, 250)
    # c1 = QtWidgets.QTreeWidgetItem(discharges, ["0", "test\\filename", "0.5"])

    disLayout = addRemoveEditLayout(discharges, "discharges")
    erosionLayout.addRow("Discharges", disLayout)

    refLevel = QtWidgets.QLineEdit(win)
    refLevel.setValidator(PyQt5.QtGui.QIntValidator(1, 1))
    dialog["refLevel"] = refLevel
    erosionLayout.addRow("Reference Case", refLevel)

    chainageOutStep = QtWidgets.QLineEdit(win)
    chainageOutStep.setValidator(validator("positive_real"))
    dialog["chainageOutStep"] = chainageOutStep
    erosionLayout.addRow("Chainage Output Step [km]", chainageOutStep)

    addOpenFileRow(erosionLayout, "outDir", "Output Directory")

    newBankFile = QtWidgets.QLineEdit(win)
    dialog["newBankFile"] = newBankFile
    erosionLayout.addRow("New Bank File Name", newBankFile)

    newEqBankFile = QtWidgets.QLineEdit(win)
    dialog["newEqBankFile"] = newEqBankFile
    erosionLayout.addRow("New Eq Bank File Name", newEqBankFile)

    eroVol = QtWidgets.QLineEdit(win)
    dialog["eroVol"] = eroVol
    erosionLayout.addRow("EroVol File Name", eroVol)

    eroVolEqui = QtWidgets.QLineEdit(win)
    dialog["eroVolEqui"] = eroVolEqui
    erosionLayout.addRow("EroVolEqui File Name", eroVolEqui)

addFilter(gridLayout: PyQt5.QtWidgets.QGridLayout, row: int, key: str, labelString: str) -> None #

Add a line of controls for a filter

Arguments#

gridLayout : PyQt5.QtWidgets.QGridLayout Grid layout object in which to position the edit controls. row : int Grid row number to be used for this parameter. key : str Short name of the parameter. labelString : str String describing the parameter to be displayed as label.

Source code in src/dfastbe/gui/gui.py 
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
def addFilter(
    gridLayout: PyQt5.QtWidgets.QGridLayout, row: int, key: str, labelString: str
) -> None:
    """
    Add a line of controls for a filter

    Arguments
    ---------
    gridLayout : PyQt5.QtWidgets.QGridLayout
        Grid layout object in which to position the edit controls.
    row : int
        Grid row number to be used for this parameter.
    key : str
        Short name of the parameter.
    labelString : str
        String describing the parameter to be displayed as label.
    """

    widthEdit = QtWidgets.QLineEdit("0.3")
    widthEdit.setValidator(validator("positive_real"))
    gridLayout.addWidget(widthEdit, row, 2)
    dialog[key + "Width"] = widthEdit

    useFilter = QtWidgets.QCheckBox("")
    useFilter.setChecked(False)
    useFilter.stateChanged.connect(partial(updateFilter, key))
    gridLayout.addWidget(useFilter, row, 1)
    dialog[key + "Active"] = useFilter

    filterTxt = QtWidgets.QLabel(labelString)
    gridLayout.addWidget(filterTxt, row, 0)
    dialog[key + "Txt"] = filterTxt

    updateFilter(key)

addGeneralTab(tabs: PyQt5.QtWidgets.QTabWidget, win: PyQt5.QtWidgets.QMainWindow) -> None #

Create the tab for the general settings.

These settings are used by both the bank line detection and the bank erosion analysis.

Arguments#

tabs : PyQt5.QtWidgets.QTabWidget Tabs object to which the tab should be added. win : PyQt5.QtWidgets.QMainWindow Windows in which the tab item is located.

Source code in src/dfastbe/gui/gui.py 
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
def addGeneralTab(
    tabs: PyQt5.QtWidgets.QTabWidget, win: PyQt5.QtWidgets.QMainWindow
) -> None:
    """
    Create the tab for the general settings.

    These settings are used by both the bank line detection and the bank
    erosion analysis.

    Arguments
    ---------
    tabs : PyQt5.QtWidgets.QTabWidget
        Tabs object to which the tab should be added.
    win : PyQt5.QtWidgets.QMainWindow
        Windows in which the tab item is located.
    """
    generalWidget = QtWidgets.QWidget()
    generalLayout = QtWidgets.QFormLayout(generalWidget)
    tabs.addTab(generalWidget, "General")

    addOpenFileRow(generalLayout, "chainFile", "Chain File")

    chainRange = QtWidgets.QWidget()
    gridly = QtWidgets.QGridLayout(chainRange)
    gridly.setContentsMargins(0, 0, 0, 0)

    gridly.addWidget(QtWidgets.QLabel("From [km]", win), 0, 0)
    startRange = QtWidgets.QLineEdit(win)
    dialog["startRange"] = startRange
    gridly.addWidget(startRange, 0, 1)
    gridly.addWidget(QtWidgets.QLabel("To [km]", win), 0, 2)
    endRange = QtWidgets.QLineEdit(win)
    dialog["endRange"] = endRange
    gridly.addWidget(endRange, 0, 3)

    generalLayout.addRow("Study Range", chainRange)

    addOpenFileRow(generalLayout, "bankDir", "Bank Directory")

    bankFileName = QtWidgets.QLineEdit(win)
    dialog["bankFileName"] = bankFileName
    generalLayout.addRow("Bank File Name", bankFileName)

    addCheckBox(generalLayout, "makePlots", "Create Figures", True)
    dialog["makePlotsEdit"].stateChanged.connect(updatePlotting)

    addCheckBox(generalLayout, "savePlots", "Save Figures", True)
    dialog["savePlotsEdit"].stateChanged.connect(updatePlotting)

    zoomPlots = QtWidgets.QWidget()
    gridly = QtWidgets.QGridLayout(zoomPlots)
    gridly.setContentsMargins(0, 0, 0, 0)

    saveZoomPlotsEdit = QtWidgets.QCheckBox("", win)
    saveZoomPlotsEdit.stateChanged.connect(updatePlotting)
    saveZoomPlotsEdit.setChecked(False)
    gridly.addWidget(saveZoomPlotsEdit, 0, 0)
    dialog["saveZoomPlotsEdit"] = saveZoomPlotsEdit

    zoomPlotsRangeTxt = QtWidgets.QLabel("Zoom Range [km]", win)
    zoomPlotsRangeTxt.setEnabled(False)
    gridly.addWidget(zoomPlotsRangeTxt, 0, 1)
    dialog["zoomPlotsRangeTxt"] = zoomPlotsRangeTxt

    zoomPlotsRangeEdit = QtWidgets.QLineEdit("1.0",win)
    zoomPlotsRangeEdit.setValidator(validator("positive_real"))
    zoomPlotsRangeEdit.setEnabled(False)
    gridly.addWidget(zoomPlotsRangeEdit, 0, 2)
    dialog["zoomPlotsRangeEdit"] = zoomPlotsRangeEdit

    saveZoomPlots = QtWidgets.QLabel("Save Zoomed Figures", win)
    generalLayout.addRow(saveZoomPlots, zoomPlots)
    dialog["saveZoomPlots"] = saveZoomPlots

    addOpenFileRow(generalLayout, "figureDir", "Figure Directory")
    addCheckBox(generalLayout, "closePlots", "Close Figures")
    addCheckBox(generalLayout, "debugOutput", "Debug Output")

addOpenFileRow(formLayout: PyQt5.QtWidgets.QFormLayout, key: str, labelString: str) -> None #

Add a line of controls for selecting a file or folder in a form layout.

Arguments#

formLayout : PyQt5.QtWidgets.QFormLayout Form layout object in which to position the edit controls. key : str Short name of the parameter. labelString : str String describing the parameter to be displayed as label.

Source code in src/dfastbe/gui/gui.py 
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
def addOpenFileRow(
    formLayout: PyQt5.QtWidgets.QFormLayout, key: str, labelString: str
) -> None:
    """
    Add a line of controls for selecting a file or folder in a form layout.

    Arguments
    ---------
    formLayout : PyQt5.QtWidgets.QFormLayout
        Form layout object in which to position the edit controls.
    key : str
        Short name of the parameter.
    labelString : str
        String describing the parameter to be displayed as label.
    """
    Label = QtWidgets.QLabel(labelString)
    dialog[key] = Label
    fLayout = openFileLayout(key + "Edit")
    formLayout.addRow(Label, fLayout)

addRemoveEditLayout(mainWidget: PyQt5.QtWidgets.QWidget, key: str) -> PyQt5.QtWidgets.QWidget #

Create a standard layout with list control and add, edit and remove buttons.

Arguments#

mainWidget : PyQt5.QtWidgets.QWidget Main object on which the add, edit and remove buttons should operate. key : str Short name of the parameter.

Returns#

parent : PyQt5.QtWidgets.QWidget Parent QtWidget that contains the add, edit and remove buttons.

Source code in src/dfastbe/gui/gui.py 
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
def addRemoveEditLayout(
    mainWidget: PyQt5.QtWidgets.QWidget, key: str
) -> PyQt5.QtWidgets.QWidget:
    """
    Create a standard layout with list control and add, edit and remove buttons.

    Arguments
    ---------
    mainWidget : PyQt5.QtWidgets.QWidget
        Main object on which the add, edit and remove buttons should operate.
    key : str
        Short name of the parameter.

    Returns
    -------
    parent : PyQt5.QtWidgets.QWidget
        Parent QtWidget that contains the add, edit and remove buttons.
    """
    parent = QtWidgets.QWidget()
    gridly = QtWidgets.QGridLayout(parent)
    gridly.setContentsMargins(0, 0, 0, 0)

    dialog[key] = mainWidget
    gridly.addWidget(mainWidget, 0, 0)

    buttonBar = QtWidgets.QWidget()
    buttonBarLayout = QtWidgets.QBoxLayout(QtWidgets.QBoxLayout.TopToBottom, buttonBar)
    buttonBarLayout.setContentsMargins(0, 0, 0, 0)
    gridly.addWidget(buttonBar, 0, 1)

    addBtn = QtWidgets.QPushButton(getIcon(f"{ICONS_DIR}/add.png"), "")
    addBtn.clicked.connect(partial(addAnItem, key))
    dialog[key + "Add"] = addBtn
    buttonBarLayout.addWidget(addBtn)

    editBtn = QtWidgets.QPushButton(getIcon(f"{ICONS_DIR}/edit.png"), "")
    editBtn.clicked.connect(partial(editAnItem, key))
    editBtn.setEnabled(False)
    dialog[key + "Edit"] = editBtn
    buttonBarLayout.addWidget(editBtn)

    delBtn = QtWidgets.QPushButton(getIcon(f"{ICONS_DIR}/remove.png"), "")
    delBtn.clicked.connect(partial(removeAnItem, key))
    delBtn.setEnabled(False)
    dialog[key + "Remove"] = delBtn
    buttonBarLayout.addWidget(delBtn)

    stretch = QtWidgets.QSpacerItem(10, 10, 13, 7)
    buttonBarLayout.addItem(stretch)

    return parent

addShippingTab(tabs: PyQt5.QtWidgets.QTabWidget, win: PyQt5.QtWidgets.QMainWindow) -> None #

Create the tab for the general shipping settings.

Arguments#

tabs : PyQt5.QtWidgets.QTabWidget Tabs object to which the tab should be added. win : PyQt5.QtWidgets.QMainWindow The window object in which the tab item is located.

Source code in src/dfastbe/gui/gui.py 
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
def addShippingTab(
    tabs: PyQt5.QtWidgets.QTabWidget, win: PyQt5.QtWidgets.QMainWindow
) -> None:
    """
    Create the tab for the general shipping settings.

    Arguments
    ---------
    tabs : PyQt5.QtWidgets.QTabWidget
        Tabs object to which the tab should be added.
    win : PyQt5.QtWidgets.QMainWindow
        The window object in which the tab item is located.
    """
    eParamsWidget = QtWidgets.QWidget()
    eParamsLayout = QtWidgets.QGridLayout(eParamsWidget)
    tabs.addTab(eParamsWidget, "Shipping Parameters")

    generalParLayout(eParamsLayout, 0, "shipType", "Ship Type", selectList=shipTypes())
    generalParLayout(eParamsLayout, 2, "shipVeloc", "Velocity [m/s]")
    generalParLayout(eParamsLayout, 3, "nShips", "# Ships [1/yr]")
    generalParLayout(eParamsLayout, 4, "shipNWaves", "# Waves [1/ship]")
    generalParLayout(eParamsLayout, 5, "shipDraught", "Draught [m]")
    generalParLayout(eParamsLayout, 6, "wavePar0", "Wave0 [m]")
    generalParLayout(eParamsLayout, 7, "wavePar1", "Wave1 [m]")

    stretch = QtWidgets.QSpacerItem(10, 10, 13, 7)
    eParamsLayout.addItem(stretch, 8, 0)

addTabForLevel(istr: str) -> None #

Create the tab for the settings associated with simulation i.

Arguments#

istr : str String representation of the simulation number.

Arguments#

None

Source code in src/dfastbe/gui/gui.py 
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
def addTabForLevel(istr: str) -> None:
    """
    Create the tab for the settings associated with simulation i.

    Arguments
    ---------
    istr : str
        String representation of the simulation number.

    Arguments
    ---------
    None
    """
    newWidget = QtWidgets.QWidget()
    newLayout = QtWidgets.QGridLayout(newWidget)
    dialog["tabs"].addTab(newWidget, "Level " + istr)

    optionalParLayout(
        newLayout, 0, istr + "_shipType", "Ship Type", selectList=shipTypes()
    )
    optionalParLayout(newLayout, 2, istr + "_shipVeloc", "Velocity [m/s]")
    optionalParLayout(newLayout, 3, istr + "_nShips", "# Ships [1/yr]")
    optionalParLayout(newLayout, 4, istr + "_shipNWaves", "# Waves [1/ship]")
    optionalParLayout(newLayout, 5, istr + "_shipDraught", "Draught [m]")
    optionalParLayout(newLayout, 6, istr + "_bankSlope", "Slope [-]")
    optionalParLayout(newLayout, 7, istr + "_bankReed", "Reed [-]")

    Label = QtWidgets.QLabel("EroVol File Name")
    dialog[istr + "_eroVol"] = Label
    newLayout.addWidget(Label, 8, 0)
    Edit = QtWidgets.QLineEdit()
    dialog[istr + "_eroVolEdit"] = Edit
    newLayout.addWidget(Edit, 8, 2)

    stretch = QtWidgets.QSpacerItem(10, 10, 13, 7)
    newLayout.addItem(stretch, 9, 0)

bankStrengthSwitch() -> None #

Implements the dialog settings depending on the bank strength specification method.

Arguments#

None

Source code in src/dfastbe/gui/gui.py 
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
def bankStrengthSwitch() -> None:
    """
    Implements the dialog settings depending on the bank strength specification method.

    Arguments
    ---------
    None
    """
    type = dialog["strengthPar"].currentText()
    if type == "Bank Type":
        dialog["bankType"].setEnabled(True)
        dialog["bankTypeType"].setEnabled(True)
        typeUpdatePar("bankType")
        dialog["bankShear"].setEnabled(False)
        dialog["bankShearType"].setEnabled(False)
        dialog["bankShearEdit"].setText("")
        dialog["bankShearEdit"].setEnabled(False)
        dialog["bankShearEditFile"].setEnabled(False)
    elif type == "Critical Shear Stress":
        dialog["bankShear"].setEnabled(True)
        dialog["bankShearType"].setEnabled(True)
        dialog["bankShearEdit"].setEnabled(True)
        typeUpdatePar("bankShear")
        dialog["bankType"].setEnabled(False)
        dialog["bankTypeType"].setEnabled(False)
        dialog["bankTypeSelect"].setEnabled(False)
        dialog["bankTypeEdit"].setText("")
        dialog["bankTypeEdit"].setEnabled(False)
        dialog["bankTypeEditFile"].setEnabled(False)

close_dialog() -> None #

Close the dialog and program.

Arguments#

None

Source code in src/dfastbe/gui/gui.py 
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
def close_dialog() -> None:
    """
    Close the dialog and program.

    Arguments
    ---------
    None
    """
    matplotlib.pyplot.close("all")
    dialog["window"].close()

close_edit(hDialog: PyQt5.QtWidgets.QDialog) -> None #

Generic close function for edit dialogs.

Arguments#

hDialog : PyQt5.QtWidgets.QDialog Dialog object to be closed.

Source code in src/dfastbe/gui/gui.py 
946
947
948
949
950
951
952
953
954
955
def close_edit(hDialog: PyQt5.QtWidgets.QDialog) -> None:
    """
    Generic close function for edit dialogs.

    Arguments
    ---------
    hDialog : PyQt5.QtWidgets.QDialog
        Dialog object to be closed.
    """
    hDialog.close()

createMenus(menubar: PyQt5.QtWidgets.QMenuBar) -> None #

Add the menus to the menubar.

Arguments#

menubar : PyQt5.QtWidgets.QMenuBar Menubar to which menus should be added.

Source code in src/dfastbe/gui/gui.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
def createMenus(menubar: PyQt5.QtWidgets.QMenuBar) -> None:
    """
    Add the menus to the menubar.

    Arguments
    ---------
    menubar : PyQt5.QtWidgets.QMenuBar
        Menubar to which menus should be added.
    """
    menu = menubar.addMenu(gui_text("File"))
    item = menu.addAction(gui_text("Load"))
    item.triggered.connect(menu_load_configuration)
    item = menu.addAction(gui_text("Save"))
    item.triggered.connect(menu_save_configuration)
    menu.addSeparator()
    item = menu.addAction(gui_text("Close"))
    item.triggered.connect(close_dialog)

    menu = menubar.addMenu(gui_text("Help"))
    item = menu.addAction(gui_text("Manual"))
    item.triggered.connect(menu_open_manual)
    menu.addSeparator()
    item = menu.addAction(gui_text("Version"))
    item.triggered.connect(menu_about_self)
    item = menu.addAction(gui_text("AboutQt"))
    item.triggered.connect(menu_about_qt)

create_dialog() -> None #

Construct the D-FAST Bank Erosion user interface.

Arguments#

None

Source code in src/dfastbe/gui/gui.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
def create_dialog() -> None:
    """
    Construct the D-FAST Bank Erosion user interface.

    Arguments
    ---------
    None
    """
    global dialog
    dialog = {}

    app = QtWidgets.QApplication(sys.argv)
    app.setStyle("fusion")
    dialog["application"] = app

    win = QtWidgets.QMainWindow()
    win.setGeometry(200, 200, 600, 300)
    win.setWindowTitle("D-FAST Bank Erosion")
    dialog["window"] = win

    menubar = win.menuBar()
    createMenus(menubar)

    centralWidget = QtWidgets.QWidget()
    layout = QtWidgets.QBoxLayout(2, centralWidget)
    win.setCentralWidget(centralWidget)

    tabs = QtWidgets.QTabWidget(win)
    dialog["tabs"] = tabs
    layout.addWidget(tabs)

    buttonBar = QtWidgets.QWidget(win)
    buttonBarLayout = QtWidgets.QBoxLayout(QtWidgets.QBoxLayout.LeftToRight, buttonBar)
    buttonBarLayout.setContentsMargins(0, 0, 0, 0)
    layout.addWidget(buttonBar)

    detect = QtWidgets.QPushButton(gui_text("action_detect"), win)
    detect.clicked.connect(run_detection)
    buttonBarLayout.addWidget(detect)

    erode = QtWidgets.QPushButton(gui_text("action_erode"), win)
    erode.clicked.connect(run_erosion)
    buttonBarLayout.addWidget(erode)

    done = QtWidgets.QPushButton(gui_text("action_close"), win)
    done.clicked.connect(close_dialog)
    buttonBarLayout.addWidget(done)

    addGeneralTab(tabs, win)
    addDetectTab(tabs, win, app)
    addErosionTab(tabs, win, app)
    addShippingTab(tabs, win)
    addBankTab(tabs, win)

editADischarge(key: str, istr: str, fileName: str = '', prob: str = '') #

Create an edit dialog for simulation file and weighing.

Arguments#

key : str Short name of the parameter. istr : str String representation of the simulation in the list. fileName : str Name of the simulation file. prob : str String representation of the weight for this simulation.

Source code in src/dfastbe/gui/gui.py 
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
def editADischarge(key: str, istr: str, fileName: str = "", prob: str = ""):
    """
    Create an edit dialog for simulation file and weighing.

    Arguments
    ---------
    key : str
        Short name of the parameter.
    istr : str
        String representation of the simulation in the list.
    fileName : str
        Name of the simulation file.
    prob : str
        String representation of the weight for this simulation.
    """
    editDialog = QtWidgets.QDialog()
    setDialogSize(editDialog, 600, 100)
    editDialog.setWindowFlags(
        PyQt5.QtCore.Qt.WindowTitleHint | PyQt5.QtCore.Qt.WindowSystemMenuHint
    )
    editDialog.setWindowTitle("Edit Discharge")
    editLayout = QtWidgets.QFormLayout(editDialog)

    label = QtWidgets.QLabel(istr)
    editLayout.addRow("Level Nr", label)

    addOpenFileRow(editLayout, "editDischarge", "Simulation File")
    dialog["editDischargeEdit"].setText(fileName)

    probability = QtWidgets.QLineEdit()
    probability.setText(prob)
    probability.setValidator(validator("positive_real"))
    editLayout.addRow("Probability [-]", probability)

    done = QtWidgets.QPushButton("Done")
    done.clicked.connect(partial(close_edit, editDialog))
    # edit_SearchDistance.setValidator(validator("positive_real"))
    editLayout.addRow(" ", done)

    editDialog.exec()

    fileName = dialog["editDischargeEdit"].text()
    prob = probability.text()
    return fileName, prob

editASearchLine(key: str, istr: str, fileName: str = '', dist: str = '50') -> Tuple[str, str] #

Create an edit dialog for the search lines list.

Arguments#

key : str Short name of the parameter. istr : str String representation of the search line in the list. fileName : str Name of the search line file. dist : str String representation of the search distance.

Returns#

fileName1 : str Updated name of the search line file. dist1 : str Updated string representation of the search distance.

Source code in src/dfastbe/gui/gui.py 
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
def editASearchLine(
    key: str, istr: str, fileName: str = "", dist: str = "50"
) -> Tuple[str, str]:
    """
    Create an edit dialog for the search lines list.

    Arguments
    ---------
    key : str
        Short name of the parameter.
    istr : str
        String representation of the search line in the list.
    fileName : str
        Name of the search line file.
    dist : str
        String representation of the search distance.

    Returns
    -------
    fileName1 : str
        Updated name of the search line file.
    dist1 : str
        Updated string representation of the search distance.
    """
    editDialog = QtWidgets.QDialog()
    setDialogSize(editDialog, 600, 100)
    editDialog.setWindowFlags(
        PyQt5.QtCore.Qt.WindowTitleHint | PyQt5.QtCore.Qt.WindowSystemMenuHint
    )
    editDialog.setWindowTitle("Edit Search Line")
    editLayout = QtWidgets.QFormLayout(editDialog)

    label = QtWidgets.QLabel(istr)
    editLayout.addRow("Search Line Nr", label)

    addOpenFileRow(editLayout, "editSearchLine", "Search Line File")
    dialog["editSearchLineEdit"].setText(fileName)

    searchDistance = QtWidgets.QLineEdit()
    searchDistance.setText(dist)
    searchDistance.setValidator(validator("positive_real"))
    editLayout.addRow("Search Distance [m]", searchDistance)

    done = QtWidgets.QPushButton("Done")
    done.clicked.connect(partial(close_edit, editDialog))
    # edit_SearchDistance.setValidator(validator("positive_real"))
    editLayout.addRow(" ", done)

    editDialog.exec()

    fileName = dialog["editSearchLineEdit"].text()
    dist = searchDistance.text()
    return fileName, dist

editAnItem(key: str) -> None #

Implements the actions for the edit item button.

Dialog implemented in separate routines.

Arguments#

key : str Short name of the parameter.

Source code in src/dfastbe/gui/gui.py 
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
def editAnItem(key: str) -> None:
    """
    Implements the actions for the edit item button.

    Dialog implemented in separate routines.

    Arguments
    ---------
    key : str
        Short name of the parameter.
    """
    selected = dialog[key].selectedItems()
    root = dialog[key].invisibleRootItem()
    if len(selected) > 0:
        istr = selected[0].text(0)
        if key == "searchLines":
            fileName = selected[0].text(1)
            dist = selected[0].text(2)
            fileName, dist = editASearchLine(key, istr, fileName=fileName, dist=dist)
            selected[0].setText(1, fileName)
            selected[0].setText(2, dist)
        elif key == "discharges":
            fileName = selected[0].text(1)
            prob = selected[0].text(2)
            fileName, prob = editADischarge(key, istr, fileName=fileName, prob=prob)
            selected[0].setText(1, fileName)
            selected[0].setText(2, prob)

generalParLayout(gridLayout: PyQt5.QtWidgets.QGridLayout, row: int, key: str, labelString: str, selectList: Optional[List[str]] = None) -> None #

Add a line of controls for editing a general parameter.

Arguments#

gridLayout : PyQt5.QtWidgets.QGridLayout Grid layout object in which to position the edit controls. row : int Grid row number to be used for this parameter. key : str Short name of the parameter. labelString : str String describing the parameter to be displayed as label. selectList : Optional[List[str]] In case the parameter can only have a limited number of values: a list of strings describing the options.

Source code in src/dfastbe/gui/gui.py 
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
def generalParLayout(
    gridLayout: PyQt5.QtWidgets.QGridLayout,
    row: int,
    key: str,
    labelString: str,
    selectList: Optional[List[str]] = None,
) -> None:
    """
    Add a line of controls for editing a general parameter.

    Arguments
    ---------
    gridLayout : PyQt5.QtWidgets.QGridLayout
        Grid layout object in which to position the edit controls.
    row : int
        Grid row number to be used for this parameter.
    key : str
        Short name of the parameter.
    labelString : str
        String describing the parameter to be displayed as label.
    selectList : Optional[List[str]]
        In case the parameter can only have a limited number of values: a list
        of strings describing the options.
    """
    Label = QtWidgets.QLabel(labelString)
    dialog[key] = Label
    gridLayout.addWidget(Label, row, 0)

    paramTypes = ("Constant", "Variable")
    Type = QtWidgets.QComboBox()
    Type.addItems(paramTypes)
    Type.currentIndexChanged.connect(partial(typeUpdatePar, key))
    dialog[key + "Type"] = Type
    gridLayout.addWidget(Type, row, 1)

    if selectList is None:
        fLayout = openFileLayout(key + "Edit", enabled=False)
        gridLayout.addWidget(fLayout, row, 2)
    else:
        Select = QtWidgets.QComboBox()
        Select.addItems(selectList)
        dialog[key + "Select"] = Select
        gridLayout.addWidget(Select, row, 2)

        fLayout = openFileLayout(key + "Edit", enabled=False)
        dialog[key + "Edit"].setEnabled(False)
        gridLayout.addWidget(fLayout, row + 1, 2)

    typeUpdatePar(key)

getIcon(filename: str) -> PyQt5.QtGui.QIcon #

Opens the icon file relative to the location of the program.

Arguments#

filename : str Name of the icon file.

Source code in src/dfastbe/gui/gui.py 
670
671
672
673
674
675
676
677
678
679
680
def getIcon(filename: str) -> PyQt5.QtGui.QIcon:
    """
    Opens the icon file relative to the location of the program.

    Arguments
    ---------
    filename : str
        Name of the icon file.
    """
    progloc = str(pathlib.Path(__file__).parent.absolute())
    return PyQt5.QtGui.QIcon(progloc + os.path.sep + filename)

get_configuration() -> configparser.ConfigParser #

Extract a configuration from the GUI.

Arguments#

None

Returns#

config : configparser.ConfigParser Configuration for the D-FAST Bank Erosion analysis.

Source code in src/dfastbe/gui/gui.py 
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
def get_configuration() -> configparser.ConfigParser:
    """
    Extract a configuration from the GUI.

    Arguments
    ---------
    None

    Returns
    -------
    config : configparser.ConfigParser
        Configuration for the D-FAST Bank Erosion analysis.
    """
    config = configparser.ConfigParser()
    config.optionxform = str  # case sensitive configuration

    config.add_section("General")
    config["General"]["Version"] = "1.0"
    config["General"]["RiverKM"] = dialog["chainFileEdit"].text()
    config["General"]["Boundaries"] = (
        dialog["startRange"].text() + ":" + dialog["endRange"].text()
    )
    config["General"]["BankDir"] = dialog["bankDirEdit"].text()
    config["General"]["BankFile"] = dialog["bankFileName"].text()
    config["General"]["Plotting"] = str(dialog["makePlotsEdit"].isChecked())
    config["General"]["SavePlots"] = str(dialog["savePlotsEdit"].isChecked())
    config["General"]["SaveZoomPlots"] = str(dialog["saveZoomPlotsEdit"].isChecked())
    config["General"]["ZoomStepKM"] = dialog["zoomPlotsRangeEdit"].text()
    config["General"]["FigureDir"] = dialog["figureDirEdit"].text()
    config["General"]["ClosePlots"] = str(dialog["closePlotsEdit"].isChecked())
    config["General"]["DebugOutput"] = str(dialog["debugOutputEdit"].isChecked())

    config.add_section("Detect")
    config["Detect"]["SimFile"] = dialog["simFileEdit"].text()
    config["Detect"]["WaterDepth"] = dialog["waterDepth"].text()
    nbank = dialog["searchLines"].topLevelItemCount()
    config["Detect"]["NBank"] = str(nbank)
    dlines = "[ "
    for i in range(nbank):
        istr = str(i + 1)
        config["Detect"]["Line" + istr] = dialog["searchLines"].topLevelItem(i).text(1)
        dlines += dialog["searchLines"].topLevelItem(i).text(2) + ", "
    dlines = dlines[:-2] + " ]"
    config["Detect"]["DLines"] = dlines

    config.add_section("Erosion")
    config["Erosion"]["TErosion"] = dialog["tErosion"].text()
    config["Erosion"]["RiverAxis"] = dialog["riverAxisEdit"].text()
    config["Erosion"]["Fairway"] = dialog["fairwayEdit"].text()
    config["Erosion"]["OutputInterval"] = dialog["chainageOutStep"].text()
    config["Erosion"]["OutputDir"] = dialog["outDirEdit"].text()
    config["Erosion"]["BankNew"] = dialog["newBankFile"].text()
    config["Erosion"]["BankEq"] = dialog["newEqBankFile"].text()
    config["Erosion"]["EroVol"] = dialog["eroVol"].text()
    config["Erosion"]["EroVolEqui"] = dialog["eroVolEqui"].text()

    if dialog["shipTypeType"].currentText() == "Constant":
        config["Erosion"]["ShipType"] = str(
            dialog["shipTypeSelect"].currentIndex() + 1
        )  # index 0 -> shipType 1
    else:
        config["Erosion"]["ShipType"] = dialog["shipTypeEdit"].text()
    config["Erosion"]["VShip"] = dialog["shipVelocEdit"].text()
    config["Erosion"]["NShip"] = dialog["nShipsEdit"].text()
    config["Erosion"]["NWaves"] = dialog["shipNWavesEdit"].text()
    config["Erosion"]["Draught"] = dialog["shipDraughtEdit"].text()
    config["Erosion"]["Wave0"] = dialog["wavePar0Edit"].text()
    config["Erosion"]["Wave1"] = dialog["wavePar1Edit"].text()

    if dialog["strengthPar"].currentText() == "Bank Type":
        config["Erosion"]["Classes"] = "true"
        if dialog["bankTypeType"].currentText() == "Constant":
            config["Erosion"]["BankType"] = dialog["bankTypeSelect"].currentIndex()
        else:
            config["Erosion"]["BankType"] = dialog["bankTypeEdit"].text()
    else:
        config["Erosion"]["Classes"] = "false"
        config["Erosion"]["BankType"] = dialog["bankShearEdit"].text()
    config["Erosion"]["ProtectionLevel"] = dialog["bankProtectEdit"].text()
    config["Erosion"]["Slope"] = dialog["bankSlopeEdit"].text()
    config["Erosion"]["Reed"] = dialog["bankReedEdit"].text()

    if dialog["velFilterActive"].isChecked():
        config["Erosion"]["VelFilterDist"] = dialog["velFilterWidth"].text()
    if dialog["bedFilterActive"].isChecked():
        config["Erosion"]["BedFilterDist"] = dialog["bedFilterWidth"].text()

    nlevel = dialog["discharges"].topLevelItemCount()
    config["Erosion"]["NLevel"] = str(nlevel)
    config["Erosion"]["RefLevel"] = dialog["refLevel"].text()
    for i in range(nlevel):
        istr = str(i + 1)
        config["Erosion"]["SimFile" + istr] = (
            dialog["discharges"].topLevelItem(i).text(1)
        )
        config["Erosion"]["PDischarge" + istr] = (
            dialog["discharges"].topLevelItem(i).text(2)
        )
        if dialog[istr + "_shipTypeType"].currentText() != "Use Default":
            if dialog[istr + "_shipTypeType"].currentText() == "Constant":
                config["Erosion"]["ShipType" + istr] = (
                    dialog[istr + "_shipTypeSelect"].currentIndex() + 1
                )  # index 0 -> shipType 1
            else:
                config["Erosion"]["ShipType" + istr] = dialog[
                    istr + "_shipTypeEdit"
                ].text()
        if dialog[istr + "_shipVelocType"].currentText() != "Use Default":
            config["Erosion"]["VShip" + istr] = dialog[istr + "_shipVelocEdit"].text()
        if dialog[istr + "_nShipsType"].currentText() != "Use Default":
            config["Erosion"]["NShip" + istr] = dialog[istr + "_nShipsEdit"].text()
        if dialog[istr + "_shipNWavesType"].currentText() != "Use Default":
            config["Erosion"]["NWaves" + istr] = dialog[istr + "_shipNWavesEdit"].text()
        if dialog[istr + "_shipDraughtType"].currentText() != "Use Default":
            config["Erosion"]["Draught" + istr] = dialog[
                istr + "_shipDraughtEdit"
            ].text()
        if dialog[istr + "_bankSlopeType"].currentText() != "Use Default":
            config["Erosion"]["Slope" + istr] = dialog[istr + "_bankSlopeEdit"].text()
        if dialog[istr + "_bankReedType"].currentText() != "Use Default":
            config["Erosion"]["Reed" + istr] = dialog[istr + "_bankReedEdit"].text()
        if dialog[istr + "_eroVolEdit"].text() != "":
            config["Erosion"]["EroVol" + istr] = dialog[istr + "_eroVolEdit"].text()
    return config

gui_text(key: str, prefix: str = 'gui_', dict: Dict[str, Any] = {}) #

Query the global dictionary of texts for a single string in the GUI.

This routine concatenates the prefix and the key to query the global dictionary of texts. It selects the first line of the text obtained and expands and placeholders in the string using the optional dictionary provided.

Arguments#

key : str The key string used to query the dictionary (extended with prefix). prefix : str The prefix used in combination with the key (default "gui_"). dict : Dict[str, Any] A dictionary used for placeholder expansions (default empty).

Returns#
The first line of the text in the dictionary expanded with the keys.
Source code in src/dfastbe/gui/gui.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def gui_text(key: str, prefix: str = "gui_", dict: Dict[str, Any] = {}):
    """
    Query the global dictionary of texts for a single string in the GUI.

    This routine concatenates the prefix and the key to query the global
    dictionary of texts. It selects the first line of the text obtained and
    expands and placeholders in the string using the optional dictionary
    provided.

    Arguments
    ---------
    key : str
        The key string used to query the dictionary (extended with prefix).
    prefix : str
        The prefix used in combination with the key (default "gui_").
    dict : Dict[str, Any]
        A dictionary used for placeholder expansions (default empty).

    Returns
    -------
        The first line of the text in the dictionary expanded with the keys.
    """
    cstr = get_text(prefix + key)
    str = cstr[0].format(**dict)
    return str

load_configuration(filename: str) -> None #

Open a configuration file and update the GUI accordingly.

This routines opens the specified configuration file and updates the GUI to reflect it contents.

Arguments#

filename : str Name of the configuration file to be opened.

Source code in src/dfastbe/gui/gui.py 
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
def load_configuration(filename: str) -> None:
    """
    Open a configuration file and update the GUI accordingly.

    This routines opens the specified configuration file and updates the GUI
    to reflect it contents.

    Arguments
    ---------
    filename : str
        Name of the configuration file to be opened.
    """
    if not os.path.exists(filename):
        if filename != "dfastbe.cfg":
            showError("The file '{}' does not exist!".format(filename))
        return
    absfilename = absolute_path(os.getcwd(), filename)
    rootdir = os.path.dirname(absfilename)
    config_file = ConfigFile.read(absfilename)

    config_file.path = absfilename

    try:
        version = config_file.version
    except KeyError:
        showError("No version information in the file!")
        return

    config = config_file.config
    if version == "1.0":
        section = config["General"]
        dialog["chainFileEdit"].setText(section["RiverKM"])
        studyRange = config_file.get_range("General", "Boundaries")
        dialog["startRange"].setText(str(studyRange[0]))
        dialog["endRange"].setText(str(studyRange[1]))
        dialog["bankDirEdit"].setText(section["BankDir"])
        bankFile = config_file.get_str("General", "BankFile", default="bankfile")
        dialog["bankFileName"].setText(bankFile)
        flag = config_file.get_bool("General", "Plotting", default=True)
        dialog["makePlotsEdit"].setChecked(flag)
        flag = config_file.get_bool("General", "SavePlots", default=True)
        dialog["savePlotsEdit"].setChecked(flag)
        flag = config_file.get_bool("General", "SaveZoomPlots", default=False)
        dialog["saveZoomPlotsEdit"].setChecked(flag)
        zoomStepKM = config_file.get_float("General", "ZoomStepKM", default=1.0)
        dialog["zoomPlotsRangeEdit"].setText(str(zoomStepKM))
        figDir = config_file.get_str(
            "General",
            "FigureDir",
            default=absolute_path(rootdir, "figures"),
        )
        dialog["figureDirEdit"].setText(figDir)
        flag = config_file.get_bool("General", "ClosePlots", default=False)
        dialog["closePlotsEdit"].setChecked(flag)
        flag = config_file.get_bool("General", "DebugOutput", default=False)
        dialog["debugOutputEdit"].setChecked(flag)

        section = config["Detect"]
        dialog["simFileEdit"].setText(section["SimFile"])
        waterDepth = config_file.get_float("Detect", "WaterDepth", default=0.0)
        dialog["waterDepth"].setText(str(waterDepth))
        NBank = config_file.get_int("Detect", "NBank", default=0, positive=True)
        DLines = config_file.get_bank_search_distances(NBank)
        dialog["searchLines"].invisibleRootItem().takeChildren()
        for i in range(NBank):
            istr = str(i + 1)
            fileName = config_file.get_str("Detect", "Line" + istr)
            c1 = QtWidgets.QTreeWidgetItem(
                dialog["searchLines"], [istr, fileName, str(DLines[i])]
            )
        if NBank > 0:
            dialog["searchLinesEdit"].setEnabled(True)
            dialog["searchLinesRemove"].setEnabled(True)

        section = config["Erosion"]
        dialog["tErosion"].setText(section["TErosion"])
        dialog["riverAxisEdit"].setText(section["RiverAxis"])
        dialog["fairwayEdit"].setText(section["Fairway"])
        dialog["chainageOutStep"].setText(section["OutputInterval"])
        dialog["outDirEdit"].setText(section["OutputDir"])
        bankNew = config_file.get_str("Erosion", "BankNew", default="banknew")
        dialog["newBankFile"].setText(bankNew)
        bankEq = config_file.get_str("Erosion", "BankEq", default="bankeq")
        dialog["newEqBankFile"].setText(bankEq)
        txt = config_file.get_str("Erosion", "EroVol", default="erovol_standard.evo")
        dialog["eroVol"].setText(txt)
        txt = config_file.get_str("Erosion", "EroVolEqui", default="erovol_eq.evo")
        dialog["eroVolEqui"].setText(txt)

        NLevel = config_file.get_int("Erosion", "NLevel", default=0, positive=True)
        dialog["discharges"].invisibleRootItem().takeChildren()
        for i in range(NLevel):
            istr = str(i + 1)
            fileName = config_file.get_str("Erosion", "SimFile" + istr)
            prob = config_file.get_str("Erosion", "PDischarge" + istr)
            c1 = QtWidgets.QTreeWidgetItem(dialog["discharges"], [istr, fileName, prob])
        if NLevel > 0:
            dialog["dischargesEdit"].setEnabled(True)
            dialog["dischargesRemove"].setEnabled(True)
        dialog["refLevel"].validator().setTop(NLevel)
        dialog["refLevel"].setText(section["RefLevel"])

        setParam("shipType", config, "Erosion", "ShipType")
        setParam("shipVeloc", config, "Erosion", "VShip")
        setParam("nShips", config, "Erosion", "NShip")
        setParam("shipNWaves", config, "Erosion", "NWave", "5")
        setParam("shipDraught", config, "Erosion", "Draught")
        setParam("wavePar0", config, "Erosion", "Wave0", "200.0")
        wave0 = config_file.get_str("Erosion", "Wave0", "200.0")
        setParam("wavePar1", config_file.config, "Erosion", "Wave1", wave0)

        useBankType = config_file.get_bool("Erosion", "Classes", default=True)
        dialog["bankType"].setEnabled(useBankType)
        dialog["bankTypeType"].setEnabled(useBankType)
        dialog["bankTypeEdit"].setEnabled(useBankType)
        dialog["bankTypeEditFile"].setEnabled(useBankType)
        dialog["bankShear"].setEnabled(not useBankType)
        dialog["bankShearType"].setEnabled(not useBankType)
        dialog["bankShearEdit"].setEnabled(not useBankType)
        dialog["bankShearEditFile"].setEnabled(not useBankType)
        if useBankType:
            dialog["strengthPar"].setCurrentText("Bank Type")
            bankStrengthSwitch()
            setParam("bankType", config_file.config, "Erosion", "BankType")
        else:
            dialog["strengthPar"].setCurrentText("Critical Shear Stress")
            bankStrengthSwitch()
            setParam("bankShear", config, "Erosion", "BankType")
        setParam("bankProtect", config, "Erosion", "ProtectionLevel", "-1000")
        setParam("bankSlope", config, "Erosion", "Slope", "20.0")
        setParam("bankReed", config, "Erosion", "Reed", "0.0")

        setFilter("velFilter", config, "Erosion", "VelFilterDist")
        setFilter("bedFilter", config, "Erosion", "BedFilterDist")

        tabs = dialog["tabs"]
        for i in range(tabs.count() - 1, 4, -1):
            tabs.removeTab(i)

        for i in range(NLevel):
            istr = str(i + 1)
            addTabForLevel(istr)
            setOptParam(istr + "_shipType", config, "Erosion", "ShipType" + istr)
            setOptParam(istr + "_shipVeloc", config, "Erosion", "VShip" + istr)
            setOptParam(istr + "_nShips", config, "Erosion", "NShip" + istr)
            setOptParam(istr + "_shipNWaves", config, "Erosion", "NWave" + istr)
            setOptParam(istr + "_shipDraught", config, "Erosion", "Draught" + istr)
            setOptParam(istr + "_bankSlope", config, "Erosion", "Slope" + istr)
            setOptParam(istr + "_bankReed", config, "Erosion", "Reed" + istr)
            txt = config_file.get_str("Erosion", "EroVol" + istr, default="")
            dialog[istr + "_eroVolEdit"].setText(txt)

    else:
        showError("Unsupported version number {} in the file!".format(version))

main(config: Optional[str] = None) -> None #

Start the user interface using default settings or optional configuration.

Arguments#

config : Optional[str] Optional name of configuration file.

Source code in src/dfastbe/gui/gui.py 
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
def main(config: Optional[str] = None) -> None:
    """
    Start the user interface using default settings or optional configuration.

    Arguments
    ---------
    config : Optional[str]
        Optional name of configuration file.
    """
    create_dialog()
    if not config is None:
        load_configuration(config)

    activate_dialog()

menu_about_qt() #

Show the about dialog for Qt.

Arguments#

None

Source code in src/dfastbe/gui/gui.py 
1827
1828
1829
1830
1831
1832
1833
1834
1835
def menu_about_qt():
    """
    Show the about dialog for Qt.

    Arguments
    ---------
    None
    """
    QtWidgets.QApplication.aboutQt()

menu_about_self() #

Show the about dialog for D-FAST Bank Erosion.

Arguments#

None

Source code in src/dfastbe/gui/gui.py 
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
def menu_about_self():
    """
    Show the about dialog for D-FAST Bank Erosion.

    Arguments
    ---------
    None
    """
    msg = QtWidgets.QMessageBox()
    msg.setIcon(QtWidgets.QMessageBox.Information)
    msg.setText(f"D-FAST Bank Erosion {__version__}")
    msg.setInformativeText("Copyright (c) 2020 Deltares.")
    msg.setDetailedText(gui_text("license"))
    msg.setWindowTitle(gui_text("about"))
    msg.setStandardButtons(QtWidgets.QMessageBox.Ok)
    msg.setStyleSheet("QDialogButtonBox{min-width: 400px;}")
    msg.exec_()

menu_load_configuration() -> None #

Select and load a configuration file.

Arguments#

None

Source code in src/dfastbe/gui/gui.py 
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
def menu_load_configuration() -> None:
    """
    Select and load a configuration file.

    Arguments
    ---------
    None
    """
    fil = QtWidgets.QFileDialog.getOpenFileName(
        caption="Select Configuration File", filter="Config Files (*.cfg)"
    )
    filename = fil[0]
    if filename != "":
        load_configuration(filename)

menu_open_manual() #

Open the user manual.

Source code in src/dfastbe/gui/gui.py 
1838
1839
1840
1841
def menu_open_manual():
    """Open the user manual."""
    filename = str(r_dir / USER_MANUAL_FILE_NAME)
    subprocess.Popen(filename, shell=True)

menu_save_configuration() -> None #

Ask for a configuration file name and save GUI selection to that file.

Arguments#

None

Source code in src/dfastbe/gui/gui.py 
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
def menu_save_configuration() -> None:
    """
    Ask for a configuration file name and save GUI selection to that file.

    Arguments
    ---------
    None
    """
    fil = QtWidgets.QFileDialog.getSaveFileName(
        caption="Save Configuration As", filter="Config Files (*.cfg)"
    )
    filename = fil[0]
    if filename != "":
        config = get_configuration()
        rootdir = os.path.dirname(filename)
        config_file = ConfigFile(config)
        config_file.relative_to(rootdir)
        config.write(filename)

openFileLayout(key, enabled=True) -> PyQt5.QtWidgets.QWidget #

Create a standard layout with a file or folder edit field and selection button.

Arguments#

key : str Short name of the parameter. enabled : bool Flag indicating whether the file selection button should be enabed by default.

Returns#

parent : PyQt5.QtWidgets.QWidget Parent QtWidget that contains the edit field and selection button.

Source code in src/dfastbe/gui/gui.py 
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
def openFileLayout(key, enabled=True) -> PyQt5.QtWidgets.QWidget:
    """
    Create a standard layout with a file or folder edit field and selection button.

    Arguments
    ---------
    key : str
        Short name of the parameter.
    enabled : bool
        Flag indicating whether the file selection button should be enabed by default.

    Returns
    ------
    parent : PyQt5.QtWidgets.QWidget
        Parent QtWidget that contains the edit field and selection button.
    """
    parent = QtWidgets.QWidget()
    gridly = QtWidgets.QGridLayout(parent)
    gridly.setContentsMargins(0, 0, 0, 0)

    myWidget = QtWidgets.QLineEdit()
    dialog[key] = myWidget
    gridly.addWidget(myWidget, 0, 0)

    openFile = QtWidgets.QPushButton(getIcon(f"{ICONS_DIR}/open.png"), "")
    openFile.clicked.connect(partial(selectFile, key))
    openFile.setEnabled(enabled)
    dialog[key + "File"] = openFile
    gridly.addWidget(openFile, 0, 2)

    return parent

optionalParLayout(gridLayout: PyQt5.QtWidgets.QGridLayout, row: int, key, labelString, selectList=None) -> None #

Add a line of controls for editing an optional parameter.

Arguments#

gridLayout : PyQt5.QtWidgets.QGridLayout Grid layout object in which to position the edit controls. row : int Grid row number to be used for this parameter. key : str Short name of the parameter. labelString : str String describing the parameter to be displayed as label. selectList : Optional[List[str]] In case the parameter can only have a limited number of values: a list of strings describing the options.

Source code in src/dfastbe/gui/gui.py 
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
def optionalParLayout(
    gridLayout: PyQt5.QtWidgets.QGridLayout, row: int, key, labelString, selectList=None
) -> None:
    """
    Add a line of controls for editing an optional parameter.

    Arguments
    ---------
    gridLayout : PyQt5.QtWidgets.QGridLayout
        Grid layout object in which to position the edit controls.
    row : int
        Grid row number to be used for this parameter.
    key : str
        Short name of the parameter.
    labelString : str
        String describing the parameter to be displayed as label.
    selectList : Optional[List[str]]
        In case the parameter can only have a limited number of values: a list
        of strings describing the options.
    """
    Label = QtWidgets.QLabel(labelString)
    dialog[key + "Label"] = Label
    gridLayout.addWidget(Label, row, 0)

    paramTypes = ("Use Default", "Constant", "Variable")
    Type = QtWidgets.QComboBox()
    Type.addItems(paramTypes)
    Type.currentIndexChanged.connect(partial(typeUpdatePar, key))
    dialog[key + "Type"] = Type
    gridLayout.addWidget(Type, row, 1)

    if selectList is None:
        fLayout = openFileLayout(key + "Edit", enabled=False)
        dialog[key + "Edit"].setEnabled(False)
        gridLayout.addWidget(fLayout, row, 2)
    else:
        Select = QtWidgets.QComboBox()
        Select.addItems(selectList)
        Select.setEnabled(False)
        dialog[key + "Select"] = Select
        gridLayout.addWidget(Select, row, 2)

        fLayout = openFileLayout(key + "Edit", enabled=False)
        dialog[key + "Edit"].setEnabled(False)
        gridLayout.addWidget(fLayout, row + 1, 2)

removeAnItem(key: str) -> None #

Implements the actions for the remove item button.

Arguments#

key : str Short name of the parameter.

Source code in src/dfastbe/gui/gui.py 
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
def removeAnItem(key: str) -> None:
    """
    Implements the actions for the remove item button.

    Arguments
    ---------
    key : str
        Short name of the parameter.
    """
    selected = dialog[key].selectedItems()
    root = dialog[key].invisibleRootItem()
    if len(selected) > 0:
        istr = selected[0].text(0)
        root.removeChild(selected[0])
        i = int(istr) - 1
        for j in range(i, root.childCount()):
            root.child(j).setText(0, str(j + 1))
    else:
        istr = ""
    if root.childCount() == 0:
        dialog[key + "Edit"].setEnabled(False)
        dialog[key + "Remove"].setEnabled(False)
    if istr == "":
        pass
    elif key == "searchLines":
        pass
    elif key == "discharges":
        tabs = dialog["tabs"]
        dialog["refLevel"].validator().setTop(root.childCount())
        dj = 0
        for j in range(tabs.count()):
            if dj > 0:
                tabs.setTabText(j - 1, "Level " + str(j + dj))
                updateTabKeys(j + dj + 1)
            elif tabs.tabText(j) == "Level " + istr:
                tabs.removeTab(j)
                dj = i - j

run_detection() -> None #

Run the bank line detection based on settings in the GUI.

Use a dummy configuration name in the current work directory to create relative paths.

Arguments#

None

Source code in src/dfastbe/gui/gui.py 
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
def run_detection() -> None:
    """
    Run the bank line detection based on settings in the GUI.

    Use a dummy configuration name in the current work directory to create
    relative paths.

    Arguments
    ---------
    None
    """
    config = get_configuration()
    rootdir = os.getcwd()
    config_file = ConfigFile(config)
    config_file.root_dir = rootdir
    config_file.relative_to(rootdir)
    dialog["application"].setOverrideCursor(QtCore.Qt.WaitCursor)
    matplotlib.pyplot.close("all")
    # should maybe use a separate thread for this ...
    msg = ""
    try:
        bank_line = BankLines(config_file, gui=True)
        bank_line.detect()
    except Exception as Ex:
        msg = str(Ex)
    dialog["application"].restoreOverrideCursor()
    if msg != "":
        print(msg)
        showError(msg)

run_erosion() -> None #

Run the D-FAST Bank Erosion analysis based on settings in the GUI.

Use a dummy configuration name in the current work directory to create relative paths.

Source code in src/dfastbe/gui/gui.py 
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
def run_erosion() -> None:
    """
    Run the D-FAST Bank Erosion analysis based on settings in the GUI.

    Use a dummy configuration name in the current work directory to create
    relative paths.
    """
    config = get_configuration()
    rootdir = os.getcwd()
    config_file = ConfigFile(config)
    config_file.root_dir = rootdir
    config_file.relative_to(rootdir)
    dialog["application"].setOverrideCursor(QtCore.Qt.WaitCursor)
    matplotlib.pyplot.close("all")
    erosion = Erosion(config_file, gui=True)
    erosion.run()
    dialog["application"].restoreOverrideCursor()

selectFile(key: str) -> None #

Select a file or directory via a selection dialog.

Arguments#

key : str Short name of the parameter.

Source code in src/dfastbe/gui/gui.py 
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
def selectFile(key: str) -> None:
    """
    Select a file or directory via a selection dialog.

    Arguments
    ---------
    key : str
        Short name of the parameter.
    """
    dnm: str
    if not dialog[key + "File"].hasFocus():
        # in the add/edit dialogs, the selectFile is triggered when the user presses enter in one of the lineEdit boxes ...
        # don't trigger the actual selectFile
        fil = ""
    elif key == "simFileEdit":
        fil, fltr = QtWidgets.QFileDialog.getOpenFileName(
            caption="Select D-Flow FM Map File", filter="D-Flow FM Map Files (*map.nc)"
        )
        # getOpenFileName returns a tuple van file name and active file filter.
    elif key == "chainFileEdit":
        fil, fltr = QtWidgets.QFileDialog.getOpenFileName(
            caption="Select Chainage File", filter="Chainage Files (*.xyc)"
        )
    elif key == "riverAxisEdit":
        fil, fltr = QtWidgets.QFileDialog.getOpenFileName(
            caption="Select River Axis File", filter="River Axis Files (*.xyc)"
        )
    elif key == "fairwayEdit":
        fil, fltr = QtWidgets.QFileDialog.getOpenFileName(
            caption="Select Fairway File", filter="Fairway Files (*.xyc)"
        )
    elif key == "editSearchLineEdit":
        fil, fltr = QtWidgets.QFileDialog.getOpenFileName(
            caption="Select Search Line File", filter="Search Line Files (*.xyc)"
        )
    elif key == "editDischargeEdit":
        fil, fltr = QtWidgets.QFileDialog.getOpenFileName(
            caption="Select Simulation File", filter="Simulation File (*map.nc)"
        )
    elif key == "bankDirEdit":
        fil = QtWidgets.QFileDialog.getExistingDirectory(
            caption="Select Bank Directory"
        )
    elif key == "figureDirEdit":
        fil = QtWidgets.QFileDialog.getExistingDirectory(
            caption="Select Figure Output Directory"
        )
    elif key == "outDirEdit":
        fil = QtWidgets.QFileDialog.getExistingDirectory(
            caption="Select Output Directory"
        )
    else:
        if key[-4:] == "Edit":
            rkey = key[:-4]
            nr = ""
            while rkey[0] in "1234567890":
                nr = nr + rkey[0]
                rkey = rkey[1:]
            if rkey[0] == "_":
                rkey = rkey[1:]
            if not nr == "":
                nr = " for Level " + nr
            if rkey == "bankType":
                ftype = "Bank Type"
                ext = ".btp"
                oneFile = False
            elif rkey == "bankShear":
                ftype = "Critical Shear"
                ext = ".btp"
                oneFile = False
            elif rkey == "bankProtect":
                ftype = "Protection Level"
                ext = ".bpl"
                oneFile = False
            elif rkey == "bankSlope":
                ftype = "Bank Slope"
                ext = ".slp"
                oneFile = False
            elif rkey == "bankReed":
                ftype = "Reed Fraction"
                ext = ".rdd"
                oneFile = False
            elif rkey == "shipType":
                ftype = "Ship Type"
                ext = ""
                oneFile = True
            elif rkey == "shipVeloc":
                ftype = "Ship Velocity"
                ext = ""
                oneFile = True
            elif rkey == "nShips":
                ftype = "Number of Ships"
                ext = ""
                oneFile = True
            elif rkey == "shipNWaves":
                ftype = "Number of Ship Waves"
                ext = ""
                oneFile = True
            elif rkey == "shipDraught":
                ftype = "Ship Draught"
                ext = ""
                oneFile = True
            elif rkey == "wavePar0":
                ftype = "Wave0"
                ext = ""
                oneFile = True
            elif rkey == "wavePar1":
                ftype = "Wave1"
                ext = ""
                oneFile = True
            else:
                ftype = "Parameter"
                ext = "*"
            ftype = ftype + " File"
            fil, fltr = QtWidgets.QFileDialog.getOpenFileName(
                caption="Select " + ftype + nr, filter=ftype + " (*" + ext + ")"
            )
            if fil != "":
                fil, fext = os.path.splitext(fil)
                if fext == ext:
                    if not oneFile:
                        # file should end on _<nr>
                        nr = ""
                        while fil[-1] in "1234567890":
                             nr = rkey[-1] + nr
                             fil = fil[:-1]
                        if nr == "" or fil[-1] != "_":
                            print("Missing bank number(s) at end of file name. Reference not updated.")
                            fil = ""
                        else:
                            fil = fil[:-1]
                else:
                    if ext == "":
                        print("Unsupported file extension {} while expecting no extension. Reference not updated.".format(fext))
                    else:
                        print("Unsupported file extension {} while expecting {}. Reference not updated.".format(fext,ext))
                    fil = ""
        else:
            print(key)
            fil = ""
    if fil != "":
        dialog[key].setText(fil)

setDialogSize(editDialog: PyQt5.QtWidgets.QDialog, width: int, height: int) -> None #

Set the width and height of a dialog and position it centered relative to the main window.

Arguments#

editDialog : QtWidgets.QDialog Dialog object to be positioned correctly. width : int Desired width of the dialog. height : int Desired height of the dialog.

Source code in src/dfastbe/gui/gui.py 
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
def setDialogSize(editDialog: PyQt5.QtWidgets.QDialog, width: int, height: int) -> None:
    """
    Set the width and height of a dialog and position it centered relative to the main window.

    Arguments
    ---------
    editDialog : QtWidgets.QDialog
        Dialog object to be positioned correctly.
    width : int
        Desired width of the dialog.
    height : int
        Desired height of the dialog.
    """
    parent = dialog["window"]
    x = parent.x()
    y = parent.y()
    pw = parent.width()
    ph = parent.height()
    editDialog.setGeometry(
        x + pw / 2 - width / 2, y + ph / 2 - height / 2, width, height
    )

setFilter(field: str, config, group: str, key: str) -> None #

Update the dialog for a filter based on configuration file.

Arguments#

field : str Short name of the parameter. config : configparser.ConfigParser Configuration for the D-FAST Bank Erosion analysis with absolute or relative paths. group : str Name of the group in the configuration. key : str Name of the key in the configuration group.

Source code in src/dfastbe/gui/gui.py 
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
def setFilter(field: str, config, group: str, key: str) -> None:
    """
    Update the dialog for a filter based on configuration file.

    Arguments
    ---------
    field : str
        Short name of the parameter.
    config : configparser.ConfigParser
        Configuration for the D-FAST Bank Erosion analysis with absolute or relative paths.
    group : str
        Name of the group in the configuration.
    key : str
        Name of the key in the configuration group.

    """
    config_file = ConfigFile(config)
    val = config_file.get_float(group, key, 0.0)
    if val > 0.0:
        dialog[field + "Active"].setChecked(True)
        dialog[field + "Width"].setText(str(val))
    else:
        dialog[field + "Active"].setChecked(False)

setOptParam(field: str, config, group: str, key: str) -> None #

Update the dialog for an optional parameter based on configuration file.

Arguments#

field : str Short name of the parameter. config : configparser.ConfigParser Configuration for the D-FAST Bank Erosion analysis with absolute or relative paths. group : str Name of the group in the configuration. key : str Name of the key in the configuration group.

Source code in src/dfastbe/gui/gui.py 
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
def setOptParam(field: str, config, group: str, key: str) -> None:
    """
    Update the dialog for an optional parameter based on configuration file.

    Arguments
    ---------
    field : str
        Short name of the parameter.
    config : configparser.ConfigParser
        Configuration for the D-FAST Bank Erosion analysis with absolute or relative paths.
    group : str
        Name of the group in the configuration.
    key : str
        Name of the key in the configuration group.
    """
    config_file = ConfigFile(config)
    str = config_file.get_str(group, key, "")
    if str == "":
        dialog[field + "Type"].setCurrentText("Use Default")
        dialog[field + "Edit"].setText("")
    else:
        try:
            val = float(str)
            dialog[field + "Type"].setCurrentText("Constant")
            if field + "Select" in dialog.keys():
                ival = int(val) - 1  # shipType 1 -> index 0
                dialog[field + "Select"].setCurrentIndex(ival)
            else:
                dialog[field + "Edit"].setText(str)
        except:
            dialog[field + "Type"].setCurrentText("Variable")
            dialog[field + "Edit"].setText(str)

setParam(field: str, config, group: str, key: str, default: str = '??') -> None #

Update the dialog for a general parameter based on configuration file.

Arguments#

field : str Short name of the parameter. config : configparser.ConfigParser Configuration for the D-FAST Bank Erosion analysis with absolute or relative paths. group : str Name of the group in the configuration. key : str Name of the key in the configuration group. default : str Default string if the group/key pair doesn't exist in the configuration.

Source code in src/dfastbe/gui/gui.py 
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
def setParam(field: str, config, group: str, key: str, default: str = "??") -> None:
    """
    Update the dialog for a general parameter based on configuration file.

    Arguments
    ---------
    field : str
        Short name of the parameter.
    config : configparser.ConfigParser
        Configuration for the D-FAST Bank Erosion analysis with absolute or relative paths.
    group : str
        Name of the group in the configuration.
    key : str
        Name of the key in the configuration group.
    default : str
        Default string if the group/key pair doesn't exist in the configuration.

    """
    config_file = ConfigFile(config)
    str = config_file.get_str(group, key, default)

    try:
        val = float(str)
        dialog[field + "Type"].setCurrentText("Constant")
        if field + "Select" in dialog.keys():
            ival = int(val)
            if field == "shipType":
                ival = ival - 1
            dialog[field + "Select"].setCurrentIndex(ival)
        else:
            dialog[field + "Edit"].setText(str)
    except:
        dialog[field + "Type"].setCurrentText("Variable")
        dialog[field + "Edit"].setText(str)

shipTypes() -> List[str] #

Return the tuple of ship types.

Arguments#

None

Returns#

types : List[str] List of three ship types.

Source code in src/dfastbe/gui/gui.py 
413
414
415
416
417
418
419
420
421
422
423
424
425
426
def shipTypes() -> List[str]:
    """
    Return the tuple of ship types.

    Arguments
    ---------
    None

    Returns
    -------
    types : List[str]
        List of three ship types.
    """
    return ["1 (multiple barge convoy set)", "2 (RHK ship / motorship)", "3 (towboat)"]

showError(message) #

Display an error message box with specified string.

Arguments#

message : str Text to be displayed in the message box.

Source code in src/dfastbe/gui/gui.py 
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
def showError(message):
    """
    Display an error message box with specified string.

    Arguments
    ---------
    message : str
        Text to be displayed in the message box.
    """
    msg = QtWidgets.QMessageBox()
    msg.setIcon(QtWidgets.QMessageBox.Critical)
    msg.setText(message)
    msg.setWindowTitle("Error")
    msg.setStandardButtons(QtWidgets.QMessageBox.Ok)
    msg.exec_()

typeUpdatePar(key: str) -> None #

Implements the dialog setting switching for both general and optional parameters.

Arguments#

key : str Short name of the parameter.

Source code in src/dfastbe/gui/gui.py 
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
def typeUpdatePar(key: str) -> None:
    """
    Implements the dialog setting switching for both general and optional parameters.

    Arguments
    ---------
    key : str
        Short name of the parameter.
    """
    type = dialog[key + "Type"].currentText()
    dialog[key + "Edit"].setText("")
    if type == "Use Default":
        dialog[key + "Edit"].setValidator(None)
        dialog[key + "Edit"].setEnabled(False)
        dialog[key + "EditFile"].setEnabled(False)
        if key + "Select" in dialog.keys():
            dialog[key + "Select"].setEnabled(False)
    elif type == "Constant":
        if key + "Select" in dialog.keys():
            dialog[key + "Select"].setEnabled(True)
            dialog[key + "Edit"].setEnabled(False)
        else:
            if key != "bankProtect":
                dialog[key + "Edit"].setValidator(validator("positive_real"))
            dialog[key + "Edit"].setEnabled(True)
        dialog[key + "EditFile"].setEnabled(False)
    elif type == "Variable":
        if key + "Select" in dialog.keys():
            dialog[key + "Select"].setEnabled(False)
        dialog[key + "Edit"].setEnabled(True)
        dialog[key + "Edit"].setValidator(None)
        dialog[key + "EditFile"].setEnabled(True)

updateFilter(key: str) -> None #

Implements the dialog setting switching for both general and optional parameters.

Arguments#

key : str Short name of the parameter.

Source code in src/dfastbe/gui/gui.py 
516
517
518
519
520
521
522
523
524
525
526
527
528
def updateFilter(key: str) -> None:
    """
    Implements the dialog setting switching for both general and optional parameters.

    Arguments
    ---------
    key : str
        Short name of the parameter.
    """
    if dialog[key + "Active"].isChecked():
        dialog[key + "Width"].setEnabled(True)
    else:
        dialog[key + "Width"].setEnabled(False)

updatePlotting() -> None #

Update the plotting flags.

Arguments#

None

Source code in src/dfastbe/gui/gui.py 
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
def updatePlotting() -> None:
    """
    Update the plotting flags.

    Arguments
    ---------
    None
    """
    plotFlag = dialog["makePlotsEdit"].isChecked()
    dialog["savePlots"].setEnabled(plotFlag)
    dialog["savePlotsEdit"].setEnabled(plotFlag)

    saveFlag = dialog["savePlotsEdit"].isChecked() and plotFlag
    dialog["saveZoomPlots"].setEnabled(saveFlag)
    dialog["saveZoomPlotsEdit"].setEnabled(saveFlag)

    saveZoomFlag = dialog["saveZoomPlotsEdit"].isChecked() and saveFlag
    dialog["zoomPlotsRangeTxt"].setEnabled(saveZoomFlag)
    dialog["zoomPlotsRangeEdit"].setEnabled(saveZoomFlag)

    dialog["figureDir"].setEnabled(saveFlag)
    dialog["figureDirEdit"].setEnabled(saveFlag)
    dialog["figureDirEditFile"].setEnabled(saveFlag)

    dialog["closePlots"].setEnabled(plotFlag)
    dialog["closePlotsEdit"].setEnabled(plotFlag)

updateTabKeys(i: int) -> None #

Renumber tab i to tab i-1.

Arguments#

i : str Number of the tab to be updated.

Source code in src/dfastbe/gui/gui.py 
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
def updateTabKeys(i: int) -> None:
    """
    Renumber tab i to tab i-1.

    Arguments
    ---------
    i : str
        Number of the tab to be updated.
    """
    iStart = str(i) + "_"
    newStart = str(i - 1) + "_"
    N = len(iStart)
    keys = [key for key in dialog.keys() if key[:N] == iStart]
    for key in keys:
        obj = dialog.pop(key)
        if key[-4:] == "Type":
            obj.currentIndexChanged.disconnect()
            obj.currentIndexChanged.connect(
                partial(typeUpdatePar, newStart + key[N:-4])
            )
        elif key[-4:] == "File":
            obj.clicked.disconnect()
            obj.clicked.connect(partial(selectFile, newStart + key[N:-4]))
        dialog[newStart + key[N:]] = obj

validator(validstr: str) -> PyQt5.QtGui.QValidator #

Wrapper to easily create a validator.

Arguments#

validstr : str Identifier for the requested validation method.

Returns#

validator : PyQt5.QtGui.QValidator Validator for the requested validation method.

Source code in src/dfastbe/gui/gui.py 
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
def validator(validstr: str) -> PyQt5.QtGui.QValidator:
    """
    Wrapper to easily create a validator.

    Arguments
    ---------
    validstr : str
        Identifier for the requested validation method.

    Returns
    -------
    validator : PyQt5.QtGui.QValidator
        Validator for the requested validation method.
    """
    if validstr == "positive_real":
        validator = PyQt5.QtGui.QDoubleValidator()
        validator.setBottom(0)
    else:
        raise Exception("Unknown validator type: {}".format(validstr))
    return validator