8
8
9
9
# Import the needed libraries
10
10
11
- ### Uncomment the next lines if pyproj is needed for the postprocessor.
11
+ ### Uncomment the next lines if pyproj is needed
12
12
# try:
13
13
# import pyproj
14
14
#
15
15
# PYPROJ_IMPORTED = True
16
16
# except ImportError:
17
17
# PYPROJ_IMPORTED = False
18
18
19
- # Function {{ cookiecutter.plugin_name }} to create postprocessing plugins.
19
+ # Function {{ cookiecutter.plugin_name }} to create diagnostic plugins.
20
20
21
- # IMPORTANT: The name of the postprocessor should follow the "postprocessor_postprocessorType_postprocessorName"
22
- # naming convention. The "postprocessor_" prefix to the postprocessor name is MANDATORY since it is
23
- # used by the pysteps interface. "postprocessorType" refers to the category of postprocessor e.g. diagnostics, ensemblestats, etc.
24
- # "postprocessorName" refers to a unique identifier name for the postprocessor e.g. prtype, meancalc, etc.
21
+ # IMPORTANT: The name of the plugin should follow the "postprocessingType_postprocessingName"
22
+ # naming convention. "postprocessingType" refers to the category of
23
+ # postprocessing e.g. diagnostics, ensemblestats, etc. "postprocessingName"
24
+ # refers to a unique identifier name for the postprocessing e.g. prtype,
25
+ # meancalc, etc.
25
26
#
26
- # Check the pysteps documentation for examples of postprocessor names that follow this
27
+ # Check the pysteps documentation for examples of postprocessing names that follow this
27
28
# convention:
28
29
# https://pysteps.readthedocs.io/en/latest/pysteps_reference/io.html#available-diagnostics
29
30
#
30
- # The function prototype for the postprocessor 's declaration should have the following form:
31
+ # The function prototype for the postprocessing 's declaration should have the following form:
31
32
#
32
- # def postprocessor_type_xyz (filename, **kwargs):
33
+ # def postprocessingtype_xyz (filename, **kwargs):
33
34
#
34
35
#
35
36
# Function arguments
38
39
# The function arguments should have the following form:
39
40
# (filename, keyword1="some_keyword", keyword2=10,...,keywordN="something", **kwargs)
40
41
# The `filename` and `**kwargs` arguments are mandatory to comply with the pysteps
41
- # interface. To fine-control the behaviour of the postprocessor , additional keywords can be
42
+ # interface. To fine-control the behaviour of the postprocessing , additional keywords can be
42
43
# added to the function.
43
44
# For example: keyword1="some_keyword", keyword2=10, ..., keywordN="something"
44
45
# It is recommended to declare the keywords explicitly in the function to improve the
48
49
# Return arguments
49
50
# ~~~~~~~~~~~~~~~~
50
51
#
51
- # The postprocessor can return whatever argument is needed.
52
+ # The postprocessing can return whatever argument is needed.
52
53
#
53
54
#
54
55
55
56
def {{cookiecutter .plugin_name }}(filename , ** kwargs ):
56
57
"""
57
- A detailed description of the postprocessor . A minimal documentation is
58
- strictly needed since the pysteps postprocessor interface expects docstrings.
58
+ A detailed description of the postprocessing plugin . A minimal documentation is
59
+ strictly needed since the pysteps postprocessing interface expects docstrings.
59
60
60
61
For example, the documentation may look like this:
61
62
@@ -67,19 +68,19 @@ def {{cookiecutter.plugin_name}}(filename, **kwargs):
67
68
Name of the file to be processed.
68
69
69
70
keyword1 : str
70
- Some keyword used to fine control the diagnostic postprocessor behaviour.
71
+ Some keyword used to fine control the behaviour.
71
72
72
73
keyword2 : int
73
- Another keyword used to fine control the diagnostic postprocessor behaviour.
74
+ Another keyword used to fine control the behaviour.
74
75
75
76
{extra_kwargs_doc}
76
77
77
78
Returns
78
79
-------.
79
80
"""
80
81
####################################################################################
81
- # Add the code required to run the postprocessor here.
82
+ # Add the code required to run the postprocessing here.
82
83
file = open (filename , "w" )
83
84
file .write ("hello world" )
84
85
file .close ()
85
- return file
86
+ return file
0 commit comments