Distribution Statement
# # # This source code is subject to the license referenced at
# # # NRLMMD-GEOIPS.

Filename Formatters in GeoIPS#

A filename formatter is a module-based GeoIPS plugin that defines how an output file is named. Filename formatters generally produce a unique filename based on the metadata of the xarray dataset, but this plugin type is flexible. The output of this plugin is a string, so it can be formatted however the user desires.

For a simple example of a filename formatter, see the basic filename formatter.

A more advanced example is the standard GeoIPS filename formatter.

Filename formatters can be applied in two ways:

1. Specification at the Command Line: Filename formatters are specified as arguments at the command line. For example:

--filename_formatter geoips_fname

For an example of calling a filename formatter from a test script, see the ABI Infrared test script.

2. Direct Invocation: If you have your own output formatter, the filename formatter can be called directly:

from geoips.interfaces import filename_formatters
fname_fmt = "geoips_fname"
output_filename = filename_formatters.get_plugin(fname_fmt)

The output of the plugin can then be used when saving the file.

This Page