-
Notifications
You must be signed in to change notification settings - Fork 0
/
runCom1DFA_algorithm.py
314 lines (251 loc) · 11.7 KB
/
runCom1DFA_algorithm.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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
83
84
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
138
139
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
166
167
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
245
246
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
274
275
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
313
314
# -*- coding: utf-8 -*-
"""
/***************************************************************************
AvaFrameRunCom1DFA
A QGIS plugin
Connects to AvaFrame
Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
-------------------
begin : 2021-08-26
copyright : (C) 2021 by AvaFrame Team
email : felix@avaframe.org
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
"""
__author__ = 'AvaFrame Team'
__date__ = '2022'
__copyright__ = '(C) 2022 by AvaFrame Team'
# This will get replaced with a git SHA1 when you do a git archive
__revision__ = '$Format:%H$'
import pathlib
import subprocess
import shutil
from pathlib import Path
from qgis.PyQt.QtCore import QCoreApplication
from qgis.core import (QgsProcessing,
QgsRasterLayer,
QgsProcessingException,
QgsProcessingAlgorithm,
QgsProcessingContext,
QgsProcessingParameterFeatureSource,
QgsProcessingParameterRasterLayer,
QgsProcessingParameterEnum,
QgsProcessingParameterMultipleLayers,
QgsProcessingParameterFolderDestination,
QgsProcessingOutputVectorLayer,
QgsProcessingParameterDefinition,
QgsProcessingOutputMultipleLayers)
class runCom1DFAAlgorithm(QgsProcessingAlgorithm):
"""
This is the AvaFrame Connection, i.e. the part running with QGis. For this
connector to work, more installation is needed. See instructions at docs.avaframe.org
"""
DEM = 'DEM'
REL = 'REL'
RELTH = 'RELTH'
SECREL = 'SECREL'
ENT = 'ENT'
RES = 'RES'
FRICTSIZE = 'FRICTSIZE'
OUTPUT = 'OUTPUT'
OUTPPR = 'OUTPPR'
FOLDEST = 'FOLDEST'
ADDTONAME = "ADDTONAME"
SMALLAVA = 'SMALLAVA'
DATA_TYPE = 'DATA_TYPE'
def initAlgorithm(self, config):
"""
Here we define the inputs and output of the algorithm, along
with some other properties.
"""
self.addParameter(QgsProcessingParameterRasterLayer(
self.DEM,
self.tr("DEM layer")))
self.addParameter(QgsProcessingParameterMultipleLayers(
self.REL,
self.tr('Release layer(s)'),
layerType=QgsProcessing.TypeVectorAnyGeometry
))
# self.addParameter(QgsProcessingParameterRasterLayer(
# self.RELTH,
# self.tr("Release thickness layer")))
# self.addParameter(QgsProcessingParameterString(
# self.ADDTONAME,
# self.tr('Add to simName (default empty)'),
# '',
# optional=True,
# ))
# self.addParameter(QgsProcessingParameterMultipleLayers(
self.addParameter(QgsProcessingParameterFeatureSource(
self.SECREL,
self.tr('Secondary release layer (only one is allowed)'),
optional=True,
defaultValue = "",
types=[QgsProcessing.TypeVectorAnyGeometry]
))
self.addParameter(QgsProcessingParameterFeatureSource(
self.ENT,
self.tr('Entrainment layer (only one is allowed)'),
optional=True,
defaultValue = "",
types=[QgsProcessing.TypeVectorAnyGeometry]
))
self.addParameter(QgsProcessingParameterFeatureSource(
self.RES,
self.tr('Resistance layer (only one is allowed)'),
optional=True,
defaultValue = "",
types=[QgsProcessing.TypeVectorAnyGeometry]
))
self.addParameter(QgsProcessingParameterEnum(
self.FRICTSIZE,
self.tr('Avalanche size'),
options=[self.tr('Default (auto)'),
self.tr('Large; Release >= 60.000m3'),
self.tr('Medium; 25.000m3 <= Release < 60.000m3'),
self.tr('Small; Release < 25.000m3'),
self.tr('Use setting from cfg.ini')
],
defaultValue=0,
allowMultiple=False
))
# dataType_param = QgsProcessingParameterEnum(self.DATA_TYPE,
# self.tr('Output data type'),
# allowMultiple=False,
# defaultValue=0)
# dataType_param.setFlags(dataType_param.flags() | QgsProcessingParameterDefinition.FlagAdvanced)
# self.addParameter(dataType_param)
self.addParameter(QgsProcessingParameterFolderDestination(
self.FOLDEST,
self.tr('Destination folder')
))
self.addOutput(QgsProcessingOutputVectorLayer(
self.OUTPUT,
self.tr("Output layer"),
QgsProcessing.TypeVectorAnyGeometry))
self.addOutput(QgsProcessingOutputMultipleLayers(
self.OUTPPR,
))
def flags(self):
return super().flags()
# return super().flags() | QgsProcessingAlgorithm.FlagNoThreading
def processAlgorithm(self, parameters, context, feedback):
"""
Here is where the processing itself takes place.
"""
import avaframe.version as gv
from . import avaframeConnector_commonFunc as cF
feedback.pushInfo('AvaFrame Version: ' + gv.getVersion())
# targetADDTONAME = self.parameterAsString(parameters, self.ADDTONAME, context)
targetADDTONAME = ''
sourceDEM = self.parameterAsRasterLayer(parameters, self.DEM, context)
if sourceDEM is None:
raise QgsProcessingException(self.invalidSourceError(parameters, self.DEM))
# Release files
allREL = self.parameterAsLayerList(parameters, self.REL, context)
if allREL is None:
raise QgsProcessingException(self.invalidSourceError(parameters, self.REL))
relDict = {}
if allREL:
relDict = {lyr.source(): lyr for lyr in allREL}
# Secondary release files
sourceSecREL = self.parameterAsVectorLayer(parameters, self.SECREL, context)
if sourceSecREL is not None:
srInfo = '_sec' + Path(sourceSecREL.source()).stem
targetADDTONAME = targetADDTONAME + srInfo
sourceENT = self.parameterAsVectorLayer(parameters, self.ENT, context)
sourceRES = self.parameterAsVectorLayer(parameters, self.RES, context)
sourceFOLDEST = self.parameterAsFile(parameters, self.FOLDEST, context)
# get the friction size
frictSIZE = self.parameterAsInt(parameters, self.FRICTSIZE, context)
frictOptions = ['auto', 'large', 'medium', 'small', 'ini']
frictString = frictOptions[frictSIZE]
# create folder structure (targetDir is the tmp one)
finalTargetDir, targetDir = cF.createFolderStructure(sourceFOLDEST)
feedback.pushInfo(sourceDEM.source())
# copy DEM
cF.copyDEM(sourceDEM, targetDir)
# copy all release shapefile parts
cF.copyMultipleShp(relDict, targetDir / 'Inputs' / 'REL', targetADDTONAME)
# copy all secondary release shapefile parts
if sourceSecREL is not None:
cF.copyShp(sourceSecREL.source(), targetDir / 'Inputs' / 'SECREL')
# copy all entrainment shapefile parts
if sourceENT is not None:
cF.copyShp(sourceENT.source(), targetDir / 'Inputs' / 'ENT')
# copy all resistance shapefile parts
if sourceRES is not None:
cF.copyShp(sourceRES.source(), targetDir / 'Inputs' / 'RES')
feedback.pushInfo('Starting the simulations')
feedback.pushInfo('This might take a while')
feedback.pushInfo('See console for progress')
# Generate command and run via subprocess.run
command = ['python', '-m', 'avaframe.runCom1DFA', str(targetDir), '-fc', str(frictString)]
cF.runAndCheck(command, self, feedback)
feedback.pushInfo('Done, start loading the results')
# Move input, log and output folders to finalTargetDir
cF.moveInputAndOutputFoldersToFinal(targetDir, finalTargetDir)
# Get peakfiles to return to QGIS
try:
rasterResults = cF.getLatestPeak(finalTargetDir)
except:
raise QgsProcessingException(self.tr('Something went wrong with com1DFA, please check log files'))
allRasterLayers = cF.addStyleToCom1DFAResults(rasterResults)
context = cF.addLayersToContext(context, allRasterLayers, self.OUTPPR)
feedback.pushInfo('\n---------------------------------')
feedback.pushInfo('Done, find results and logs here:')
feedback.pushInfo(str(finalTargetDir.resolve()))
feedback.pushInfo('---------------------------------\n')
return {self.OUTPPR: allRasterLayers}
def name(self):
"""
Returns the algorithm name, used for identifying the algorithm. This
string should be fixed for the algorithm, and must not be localised.
The name should be unique within each provider. Names should contain
lowercase alphanumeric characters only and no spaces or other
formatting characters.
"""
return 'com1denseflow'
def displayName(self):
"""
Returns the translated algorithm name, which should be used for any
user-visible display of the algorithm name.
"""
return self.tr('Dense Flow (com1)')
def group(self):
"""
Returns the name of the group this algorithm belongs to. This string
should be localised.
"""
return self.tr(self.groupId())
def groupId(self):
"""
Returns the unique ID of the group this algorithm belongs to. This
string should be fixed for the algorithm, and must not be localised.
The group id should be unique within each provider. Group id should
contain lowercase alphanumeric characters only and no spaces or other
formatting characters.
"""
return 'Operational'
def tr(self, string):
return QCoreApplication.translate('Processing', string)
def shortHelpString(self) -> str:
hstring = 'Runs dense flow simulations via module com1DFA. \n\
IMPORTANT: change avalanche size (=friction relation) to "Large" if runout is above 1600msl. \n\
For more information go to (or use the help button below): \n\
AvaFrame Documentation: https://docs.avaframe.org\n\
Homepage: https://avaframe.org\n\
Praxisleitfaden: https://avaframe.org/reports\n'
return self.tr(hstring)
# Praxisleitfaden: https://info.bml.gv.at/dam/jcr:edebd872-2a86-4edf-ac5e-635ef11e35fe/Praxisleitfaden%20LawSim%20WLV%202022%20Gr%C3%BCn.pdf\n'
def helpUrl(self):
return "https://docs.avaframe.org/en/latest/connector.html"
def createInstance(self):
return runCom1DFAAlgorithm()