Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update help and prepare for release #17

Merged
merged 3 commits into from
Oct 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions avaframeConnector_algorithm.py
Original file line number Diff line number Diff line change
Expand Up @@ -351,14 +351,14 @@ def name(self):
lowercase alphanumeric characters only and no spaces or other
formatting characters.
"""
return 'FullOperationalRun'
return 'fulloperationalrun'

def displayName(self):
"""
Returns the translated algorithm name, which should be used for any
user-visible display of the algorithm name.
"""
return self.tr(self.name())
return self.tr('Full Operational Run')

def group(self):
"""
Expand All @@ -385,9 +385,12 @@ def shortHelpString(self) -> str:
For more information go to: \n\
AvaFrame Documentation: https://docs.avaframe.org\n\
Homepage: https://avaframe.org\n\
Praxisleitfaden: https://info.bml.gv.at/dam/jcr:edebd872-2a86-4edf-ac5e-635ef11e35fe/Praxisleitfaden%20LawSim%20WLV%202022%20Gr%C3%BCn.pdf\n'
Praxisleitfaden: https://avaframe.org/reports\n'

return self.tr(hstring)

def helpUrl(self):
return "https://docs.avaframe.org/en/latest/connector.html"

def createInstance(self):
return AvaFrameConnectorAlgorithm()
4 changes: 4 additions & 0 deletions avaframeGetVersion_algorithm.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,10 @@ def shortHelpString(self) -> str:
No need to add anything.'

return self.tr(hstring)

def helpUrl(self):
return "https://docs.avaframe.org/en/latest/connector.html"


def createInstance(self):
return AvaFrameGetVersionAlgorithm()
12 changes: 12 additions & 0 deletions avaframeLayerRename_algorithm.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,18 @@ def groupId(self):

def tr(self, string):
return QCoreApplication.translate('Processing', string)

def shortHelpString(self) -> str:
hstring = 'Renames com1DFA result layers by adding the values of the\
given variable (from the configuration file). \n\
For more information go to (or use the help button below): \n\
AvaFrame Documentation: https://docs.avaframe.org\n\
'

return self.tr(hstring)

def helpUrl(self):
return "https://docs.avaframe.org/en/latest/connector.html"

def createInstance(self):
return AvaFrameLayerRenameAlgorithm()
14 changes: 9 additions & 5 deletions avaframeRunCom1DFA_algorithm.py
Original file line number Diff line number Diff line change
Expand Up @@ -271,14 +271,14 @@ def name(self):
lowercase alphanumeric characters only and no spaces or other
formatting characters.
"""
return 'RunCom1DFA'
return 'denseflowstandard'

def displayName(self):
"""
Returns the translated algorithm name, which should be used for any
user-visible display of the algorithm name.
"""
return self.tr(self.name())
return self.tr('Dense Flow Standard (com1DFA)')

def group(self):
"""
Expand All @@ -301,13 +301,17 @@ def tr(self, string):
return QCoreApplication.translate('Processing', string)

def shortHelpString(self) -> str:
hstring = 'Runs dense flow simulations via com1DFA. \n\
For more information go to: \n\
hstring = 'Runs dense flow simulations via module com1DFA. \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://info.bml.gv.at/dam/jcr:edebd872-2a86-4edf-ac5e-635ef11e35fe/Praxisleitfaden%20LawSim%20WLV%202022%20Gr%C3%BCn.pdf\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 AvaFrameRunCom1DFAAlgorithm()
3 changes: 3 additions & 0 deletions avaframeUpdate_algorithm.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,9 @@ def shortHelpString(self) -> str:
No need to add anything.'

return self.tr(hstring)

def helpUrl(self):
return "https://docs.avaframe.org/en/latest/connector.html"

def createInstance(self):
return AvaFrameUpdateAlgorithm()
10 changes: 6 additions & 4 deletions metadata.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

[general]
name=AvaFrameConnector
qgisMinimumVersion=3.12
qgisMinimumVersion=3.18
description=Connects to AvaFrame
version=1.1
version=1.3
author=AvaFrame Team
email=felix@avaframe.org

about=Connecting AvaFrame and QGis. NOTE: you need to install avaframe according to the installation instructions at http://docs.avaframe.org.
about=Connecting AvaFrame and QGis. NOTE: see installation instructions at http://docs.avaframe.org/installation.html.

tracker=https://github.com/avaframe/QGisAF
repository=https://github.com/avaframe/QGisAF
Expand All @@ -20,7 +20,9 @@ repository=https://github.com/avaframe/QGisAF

hasProcessingProvider=yes
# Uncomment the following line and add your changelog:
changelog= 1.1 Follow variable renaming of AvaFrame
changelog= 1.3 Add secondary release, rename and update functions,
automatic AvaFrame python package installation
1.1 Follow variable renaming of AvaFrame

# Tags are comma separated with spaces allowed
tags=python, avalanche
Expand Down