Skip to content

Commit

Permalink
cf_writer improve algorithm property documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
burlen committed Dec 2, 2020
1 parent d9eb24b commit 8cb841a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
13 changes: 9 additions & 4 deletions io/teca_cf_writer.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,14 @@ void teca_cf_writer::get_properties_description(

opts.add_options()
TECA_POPTS_GET(std::string, prefix, file_name,
"path/name to write series to")
"A path and file name pattern to write data to. For time varying output"
" spanning more than one file the string %t% is replaced with the date"
" and/or time of the first time step in the file. The formatting of the"
" date/time encoding is specified using --date_format.")
TECA_POPTS_GET(std::string, prefix, date_format,
"strftime format string for date string in output filename (%F-%H)")
"A strftime format used when encoding dates into the output"
" file names (%F-%HZ). %t% in the file name is replaced with date/time"
" of the first time step in the file using this format specifier.")
TECA_POPTS_GET(long, prefix, first_step,
"set the first time step to process (0)")
TECA_POPTS_GET(long, prefix, last_step,
Expand All @@ -79,10 +84,10 @@ void teca_cf_writer::get_properties_description(
"mode flags to pass to NetCDF when creating the file (NC_CLOBBER)")
TECA_POPTS_GET(int, prefix, use_unlimited_dim,
"if set the slowest varying dimension is specified to be "
"NC_UNLIMITED. (1)")
"NC_UNLIMITED. (0)")
TECA_POPTS_GET(int, prefix, compression_level,
"sets the zlib compression level used for each variable;"
"does nothing if the value is less than or equal to 0. (-1)")
" does nothing if the value is less than or equal to 0. (-1)")
TECA_POPTS_GET(int, prefix, flush_files,
"if set files are flushed before they are closed. (0)")
TECA_POPTS_MULTI_GET(std::vector<std::string>, prefix, point_arrays,
Expand Down
4 changes: 2 additions & 2 deletions io/teca_cf_writer.h
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ class teca_cf_writer : public teca_threaded_algorithm
// for info about date formatting.
TECA_ALGORITHM_PROPERTY(std::string, file_name)

// set the format for the date to write in the filename this requires the
// set the format for the date to write in the filename. this requires the
// input dataset to have unit/calendar information if none are available,
// the time index is used instead. (%F-%H)
// the time index is used instead. (%F-%HZ)
TECA_ALGORITHM_PROPERTY(std::string, date_format)

// set the range of time step to process.
Expand Down

0 comments on commit 8cb841a

Please sign in to comment.