Extend the interface to contain exporter methods

Author: pulkkins

pysteps/io/interface.py

@@ -1,24 +1,42 @@
 
 from . import importers
 
-def get_method(name):
-    """Return a callable function for the importer method corresponding to
-    the given name. The available options are:\n\
-
-    +-------------------+---------------------------------------------------------+
-    |     Name          |              Description                                |
-    +===================+=========================================================+
-    |     bom_rf3       |  NetCDF files in the Bureau of Meterology (BoM) archive |
-    |                   |  containing precipitation intensity composites          |
-    +-------------------+---------------------------------------------------------+
-    |     fmi_pgm       |  PGM files in the Finnish Meteorological Institute      |
-    |                   |  (FMI) archive containing reflectivity composites (dBZ) |
-    +-------------------+---------------------------------------------------------+
-    |     mch_gif       |  GIF files in the MeteoSwiss archive containing         |
-    |                   |  precipitation intensity composites (mm/h)              |
-    +-------------------+---------------------------------------------------------+
-    |     odim_hdf5     |  ODIM HDF5 file format used by Eumetnet/OPERA           |
-    +-------------------+---------------------------------------------------------+
+def get_method(name, type):
+    """Return a callable function for the method corresponding to the given name.
+    
+    Parameters
+    ----------
+    name : str
+        Name of the method. The available options are:\n\
+        
+        Importers:
+        
+        +-------------------+---------------------------------------------------------+
+        |     Name          |              Description                                |
+        +===================+=========================================================+
+        |     bom_rf3       |  NetCDF files in the Bureau of Meterology (BoM) archive |
+        |                   |  containing precipitation intensity composites          |
+        +-------------------+---------------------------------------------------------+
+        |     fmi_pgm       |  PGM files in the Finnish Meteorological Institute      |
+        |                   |  (FMI) archive containing reflectivity composites (dBZ) |
+        +-------------------+---------------------------------------------------------+
+        |     mch_gif       |  GIF files in the MeteoSwiss archive containing         |
+        |                   |  precipitation intensity composites (mm/h)              |
+        +-------------------+---------------------------------------------------------+
+        |     odim_hdf5     |  ODIM HDF5 file format used by Eumetnet/OPERA           |
+        +-------------------+---------------------------------------------------------+
+        
+        Exporters:
+        
+        +-------------+--------------------------------------------------------+
+        |     Name    |              Description                               |
+        +=============+========================================================+
+        | netcdf      | NetCDF files conforming to the CF 1.7 specification    |
+        +-------------+--------------------------------------------------------+
+    
+    type : str
+        Type of the method. The available options are 'importer' and 'exporter'.
+    
     """
     if name.lower() == "bom_rf3":
         return importers.import_bom_rf3