|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | + |
| 3 | +""" |
| 4 | +/*************************************************************************** |
| 5 | + AvaFrameRunCom1DFA |
| 6 | + A QGIS plugin |
| 7 | + Connects to AvaFrame |
| 8 | + Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/ |
| 9 | + ------------------- |
| 10 | + begin : 2021-08-26 |
| 11 | + copyright : (C) 2021 by AvaFrame Team |
| 12 | + email : felix@avaframe.org |
| 13 | + ***************************************************************************/ |
| 14 | +
|
| 15 | +/*************************************************************************** |
| 16 | + * * |
| 17 | + * This program is free software; you can redistribute it and/or modify * |
| 18 | + * it under the terms of the GNU General Public License as published by * |
| 19 | + * the Free Software Foundation; either version 2 of the License, or * |
| 20 | + * (at your option) any later version. * |
| 21 | + * * |
| 22 | + ***************************************************************************/ |
| 23 | +""" |
| 24 | + |
| 25 | +__author__ = "AvaFrame Team" |
| 26 | +__date__ = "2025" |
| 27 | +__copyright__ = "(C) 2025 by AvaFrame Team" |
| 28 | + |
| 29 | +# This will get replaced with a git SHA1 when you do a git archive |
| 30 | + |
| 31 | +__revision__ = "$Format:%H$" |
| 32 | + |
| 33 | + |
| 34 | +import pathlib |
| 35 | + |
| 36 | + |
| 37 | +from qgis.PyQt.QtCore import QCoreApplication |
| 38 | +from qgis.core import ( |
| 39 | + QgsProcessing, |
| 40 | + QgsProcessingAlgorithm, |
| 41 | + QgsProcessingParameterFile, |
| 42 | + QgsProcessingOutputVectorLayer, |
| 43 | +) |
| 44 | + |
| 45 | + |
| 46 | +class runCom7RegionalComputationAlgorithm(QgsProcessingAlgorithm): |
| 47 | + """ |
| 48 | + Runs com7Regional computation on a single folder |
| 49 | + """ |
| 50 | + |
| 51 | + OUTPUT = "OUTPUT" |
| 52 | + SIMFOLDER = "FOLDEST" |
| 53 | + |
| 54 | + def initAlgorithm(self, config): |
| 55 | + """ |
| 56 | + Here we define the inputs and output of the algorithm, along |
| 57 | + with some other properties. |
| 58 | + """ |
| 59 | + self.addParameter( |
| 60 | + QgsProcessingParameterFile( |
| 61 | + self.SIMFOLDER, |
| 62 | + self.tr("Avalanche directory"), |
| 63 | + behavior=QgsProcessingParameterFile.Folder, |
| 64 | + ) |
| 65 | + ) |
| 66 | + |
| 67 | + self.addOutput( |
| 68 | + QgsProcessingOutputVectorLayer( |
| 69 | + self.OUTPUT, |
| 70 | + self.tr("Output layer"), |
| 71 | + QgsProcessing.TypeVectorAnyGeometry, |
| 72 | + ) |
| 73 | + ) |
| 74 | + |
| 75 | + def flags(self): |
| 76 | + return super().flags() |
| 77 | + # return super().flags() | QgsProcessingAlgorithm.FlagNoThreading |
| 78 | + |
| 79 | + def processAlgorithm(self, parameters, context, feedback): |
| 80 | + """ |
| 81 | + Here is where the processing itself takes place. |
| 82 | + """ |
| 83 | + |
| 84 | + import avaframe.version as gv |
| 85 | + from . import avaframeConnector_commonFunc as cF |
| 86 | + |
| 87 | + feedback.pushInfo("AvaFrame Version: " + gv.getVersion()) |
| 88 | + |
| 89 | + sourceFOLDEST = self.parameterAsFile(parameters, self.SIMFOLDER, context) |
| 90 | + |
| 91 | + # create folder structure |
| 92 | + targetDir = pathlib.Path(sourceFOLDEST) |
| 93 | + |
| 94 | + feedback.pushInfo("Starting the simulations") |
| 95 | + feedback.pushInfo("This might take a while") |
| 96 | + feedback.pushInfo("See console for progress") |
| 97 | + |
| 98 | + # Generate command and run via subprocess.run |
| 99 | + command = [ |
| 100 | + "python", |
| 101 | + "-m", |
| 102 | + "avaframe.runCom7Regional", |
| 103 | + str(targetDir), |
| 104 | + "--run-computations", |
| 105 | + ] |
| 106 | + cF.runAndCheck(command, self, feedback) |
| 107 | + |
| 108 | + feedback.pushInfo("Done, start loading the results") |
| 109 | + |
| 110 | + feedback.pushInfo("\n---------------------------------") |
| 111 | + feedback.pushInfo("Done, find results and logs here:") |
| 112 | + feedback.pushInfo(str(targetDir.resolve())) |
| 113 | + feedback.pushInfo("---------------------------------\n") |
| 114 | + |
| 115 | + return {} |
| 116 | + |
| 117 | + def name(self): |
| 118 | + """ |
| 119 | + Returns the algorithm name, used for identifying the algorithm. This |
| 120 | + string should be fixed for the algorithm, and must not be localised. |
| 121 | + The name should be unique within each provider. Names should contain |
| 122 | + lowercase alphanumeric characters only and no spaces or other |
| 123 | + formatting characters. |
| 124 | + """ |
| 125 | + return "com7regionalcomputation" |
| 126 | + |
| 127 | + def displayName(self): |
| 128 | + """ |
| 129 | + Returns the translated algorithm name, which should be used for any |
| 130 | + user-visible display of the algorithm name. |
| 131 | + """ |
| 132 | + return self.tr("Regional modelling computation (com7)") |
| 133 | + |
| 134 | + def group(self): |
| 135 | + """ |
| 136 | + Returns the name of the group this algorithm belongs to. This string |
| 137 | + should be localised. |
| 138 | + """ |
| 139 | + return self.tr(self.groupId()) |
| 140 | + |
| 141 | + def groupId(self): |
| 142 | + """ |
| 143 | + Returns the unique ID of the group this algorithm belongs to. This |
| 144 | + string should be fixed for the algorithm, and must not be localised. |
| 145 | + The group id should be unique within each provider. Group id should |
| 146 | + contain lowercase alphanumeric characters only and no spaces or other |
| 147 | + formatting characters. |
| 148 | + """ |
| 149 | + return "Experimental" |
| 150 | + |
| 151 | + def tr(self, string): |
| 152 | + return QCoreApplication.translate("Processing", string) |
| 153 | + |
| 154 | + def shortHelpString(self) -> str: |
| 155 | + hstring = "Runs multiple avalanches as setup via regional input splitting. \n\ |
| 156 | + AvaFrame Documentation: https://docs.avaframe.org\n\ |
| 157 | + Homepage: https://avaframe.org\n\ |
| 158 | + Praxisleitfaden: https://avaframe.org/reports\n" |
| 159 | + |
| 160 | + return self.tr(hstring) |
| 161 | + |
| 162 | + def helpUrl(self): |
| 163 | + return "https://docs.avaframe.org/en/latest/connector.html" |
| 164 | + |
| 165 | + def createInstance(self): |
| 166 | + return runCom7RegionalComputationAlgorithm() |
0 commit comments