You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+11-7Lines changed: 11 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -47,19 +47,23 @@ a skeleton for the plugin package:
47
47
- **full_name**: Your full name.
48
48
- **email**: Your email address.
49
49
- **plugin_type**: The type of plugin you would like to create.
50
-
Options: [1. importer, 2. postprocessor]
51
-
- **plugin_subtype**: The subtype of plugin which you would like to create. e.g for postprocessors, options: [1. diagnostics, 2. ensemblestats]
52
-
- **project_name**: The name of your new Pysteps plugin.
53
-
- **project_slug**: The namespace of your Python package.
54
-
The slug should be Python import friendly (no spaces, no hyphens, and no
55
-
special characters).
50
+
Options: [1. importer, 2. diagnostic]
51
+
- **plugin_subtype**: Any string is allowed. The importer type can use the institution as as subtype, while an empty string is the default for a diagnostic.
52
+
- **project_name**: The repository name. This is also the name of the plugin root directory used to install the Python package. Recommended: *pysteps-[plugin_type][-plugin_subtype]-[name] where *name* is the main funtionality
53
+
- **project_slug**: The namespace of your Python package. The slug should be Python import friendly (no spaces, no hyphens, and no special characters).
54
+
- **plugin_name**: Name of the module implementing the plugin. Importer modules should start with *importer_*. Diagnostic modules should start with *diagnostic_*.
55
+
- **plugin_function**: Name of the function that is set as primary pysteps entry point for the plugin. Importer functions should start with *import_*. Diagnostic functions should start with *diagnostic_*.
56
56
- **project_short_description**: Short description of the plugin.
57
-
- **plugin_name**: Name of the module implementing the plugin.
58
57
- **version**: The starting version number for your project.
59
58
- **open_source_license**. Choose a license for your project.
2.0, 5. GNU General Public License v3, 6. Not open source]
62
61
62
+
This creates a local directory ``[project_name]`` as the template for your plugin.
63
+
64
+
- modify the function ``[plugin_function]`` in ``[project_name]/[project_slug]/[plugin_type]/[plugin_name].py`` to your needs
65
+
- if you add more functions in ``[project_name]/[project_slug]/[plugin_type]/[plugin_name].py`` make sure to create the additional entry points in ``[project_name]/setup.py``
0 commit comments