lib.adf_base module

Base class for the Atmospheric Diagnostics Framework (ADF). All other ADF classes inherit from this class.

Currently this class only does two things:

  1. Creates a debug logger, if requested.

  2. Defines an ADF-specific function to end the diagnostics program, if need be.

class lib.adf_base.AdfBase(debug=False)[source]

Bases: object

Base class for the ADF

property debug_fname

Return the “debug_fname” string to the user.

debug_log(msg)[source]

Write message to debug log, if enabled.

end_diag_fail(msg)[source]

Prints message to log and screen, and then exits program with an ADF-specific error.

exception lib.adf_base.AdfError[source]

Bases: RuntimeError

Class used to handle ADF value errors (e.g., log user errors without backtrace)