eva package

Subpackages

• eva.data package
  • Submodules
  • eva.data.cubed_sphere_restart module
    • CubedSphereRestart
      • CubedSphereRestart.execute()
      • CubedSphereRestart.generate_default_config()
    • read_fms_tiles()
  • eva.data.data_collections module
    • DataCollections
      • DataCollections.add_variable_to_collection()
      • DataCollections.adjust_channel_dimension_name()
      • DataCollections.adjust_location_dimension_name()
      • DataCollections.create_or_add_to_collection()
      • DataCollections.display_collections()
      • DataCollections.get_variable_data()
      • DataCollections.get_variable_data_array()
      • DataCollections.nan_float_values_outside_threshold()
      • DataCollections.validate_names()
  • eva.data.data_driver module
    • data_driver()
  • eva.data.eva_dataset_base module
    • EvaDatasetBase
      • EvaDatasetBase.execute()
      • EvaDatasetBase.generate_default_config()
    • EvaDatasetFactory
      • EvaDatasetFactory.create_eva_object()
  • eva.data.gsi_obs_space module
    • GsiObsSpace
      • GsiObsSpace.execute()
      • GsiObsSpace.generate_default_config()
    • all_equal()
    • satellite_dataset()
    • subset_channels()
    • uv()
  • eva.data.ioda_obs_space module
    • IodaObsSpace
      • IodaObsSpace.execute()
      • IodaObsSpace.generate_default_config()
      • IodaObsSpace.execute()
      • IodaObsSpace.generate_default_config()
    • subset_channels()
  • eva.data.jedi_log module
    • JediLog
      • JediLog.execute()
      • JediLog.generate_default_config()
      • JediLog.get_from_log()
      • JediLog.get_matching_chunks()
      • JediLog.parse_convergence()
    • get_data_from_line()
  • eva.data.lat_lon module
    • LatLon
      • LatLon.execute()
      • LatLon.generate_default_config()
  • eva.data.mon_data_space module
    • MonDataSpace
      • MonDataSpace.execute()
      • MonDataSpace.generate_default_config()
      • MonDataSpace.get_ctl_dict()
      • MonDataSpace.get_dim_ranges()
      • MonDataSpace.get_ndims_used()
      • MonDataSpace.loadConditionalItems()
      • MonDataSpace.load_dset()
      • MonDataSpace.read_ieee()
      • MonDataSpace.subset_coordinate()
      • MonDataSpace.var_to_np_array()
  • eva.data.soca_restart module
    • SocaRestart
      • SocaRestart.execute()
      • SocaRestart.generate_default_config()
      • SocaRestart.execute()
      • SocaRestart.generate_default_config()
    • read_soca()
  • Module contents
• eva.plotting package
  • Subpackages
    • eva.plotting.emcpy package
      • Subpackages
      • Module contents
    • eva.plotting.hvplot package
      • Submodules
      • eva.plotting.hvplot.interactive_plot_tools module
      • Module contents
  • Module contents
• eva.tests package
  • Module contents
• eva.transforms package
  • Submodules
  • eva.transforms.accept_where module
    • accept_where()
    • generate_accept_where_config()
  • eva.transforms.arithmetic module
    • arithmetic()
    • generate_arithmetic_config()
    • isfloat()
  • eva.transforms.channel_stats module
    • channel_stats()
  • eva.transforms.select_time module
    • select_time()
  • eva.transforms.transform_driver module
    • transform_driver()
  • eva.transforms.transform_utils module
    • parse_for_dict()
    • replace_cgv()
    • split_collectiongroupvariable()
  • Module contents
• eva.utilities package
  • Submodules
  • eva.utilities.config module
    • Config
      • Config.get()
    • get()
  • eva.utilities.ioda_definitions module
    • find_instrument_from_string()
    • ioda_group_dict()
    • ioda_platform_dict()
    • ioda_platform_to_full_name()
  • eva.utilities.ioda_netcdf_api module
    • read_ioda_variable()
  • eva.utilities.logger module
    • Logger
      • Logger.abort()
      • Logger.debug()
      • Logger.info()
      • Logger.send_message()
      • Logger.trace()
    • textcolors
      • textcolors.blue
      • textcolors.cyan
      • textcolors.end
      • textcolors.green
  • eva.utilities.stats module
    • get_field_data()
    • stats_helper()
  • eva.utilities.timing module
    • Timing
      • Timing.finalize()
      • Timing.start()
      • Timing.stop()
  • eva.utilities.utils module
    • camelcase_to_underscore()
    • fontColors
      • fontColors.bold
      • fontColors.end
      • fontColors.underline
    • get_schema()
    • is_number()
    • load_yaml_file()
    • parse_channel_list()
    • remove_empty_from_list_of_strings()
    • remove_list_duplicates()
    • replace_vars_dict()
    • replace_vars_notebook()
    • replace_vars_str()
    • slice_var_from_str()
    • string_does_not_contain()
    • update_object()
  • Module contents

Submodules

eva.eva_driver module

eva.eva_driver.eva(eva_config, eva_logger=None)

Execute the Evaluation and Visualization Analysis (EVA) process based on the provided configuration.

Parameters:

• eva_config (dict or str) – Configuration data for the EVA process. It can be a dictionary or

• file. (the path to a YAML configuration) –

• eva_logger (Logger, optional) – An instance of the logger for logging messages. Default is

• None. –

Returns:

None

eva.eva_driver.main()

Entry point for main eva program. Reads configuration from a YAML file and executes eva based on what is described in the configuration file.

Parameters:

config_file (str) – The path to the configuration YAML file.

Returns:

None

eva.eva_interactive module

class eva.eva_interactive.EvaInteractive

Bases: object

A class for interactive data manipulation and visualization using the EVA framework.

This class provides methods to load data collections, perform data transformations, and generate various types of plots.

logger

An instance of the Logger class for logging messages.

Type:

Logger

timer

An instance of the Timing class for measuring execution time.

Type:

Timing

dc_dict

A dictionary containing data collections indexed by collection names.

Type:

dict

fn_dict

A dictionary containing filenames associated with data collections.

Type:

dict

ch_required_dict

A dictionary indicating whether channel requirements are needed for

Type:

dict

each data collection.

var_cache

A list to cache variable names.

Type:

list

Initialize the EvaInteractive instance with necessary attributes.

accept_where(new_name, starting_field, where, collection, var_list=[])

Apply an ‘accept_where’ transformation to the data collection based on specified conditions.

Parameters:

• new_name (str) – Name of the new variable to be created.

• starting_field (str) – Field to which the ‘where’ conditions are applied.

• where (list) – List of expressions specifying conditions for accepting data.

• collection (str) – Name of the data collection.

• var_list (list, optional) – List of variable names to be used in the expressions. Default

• list. (is an empty) –

arithmetic(new_name, expression, collection, var_list=[])

Apply an arithmetic transformation to the data collection.

Parameters:

• new_name (str) – Name of the new variable to be created.

• expression (str) – Arithmetic expression to be evaluated.

• collection (str) – Name of the data collection.

• var_list (list, optional) – List of variable names to be used in the expression. Default

• list. (is an empty) –

density_plot(plot_list)

Generate a density plot using specified data collections and variables.

Parameters:

plot_list (list) – List of dictionaries specifying the plot configuration.

Returns:

The generated density plot.

Return type:

holoviews.plotting.ElementPlot

get_data_collection(collection_name)

Retrieve a data collection by its name.

Parameters:

collection_name (str) – Name of the data collection to retrieve.

Returns:

The retrieved data collection instance.

Return type:

DataCollections

Raises:

Exception – If the specified collection does not exist.

histogram(plot_list)

Generate a histogram plot using specified data collections and variables.

Parameters:

plot_list (list) – List of dictionaries specifying the plot configuration.

Returns:

The generated histogram plot.

Return type:

holoviews.plotting.ElementPlot

line_plot(plot_list)

Generate a line plot using specified data collections and variables.

Parameters:

plot_list (list) – List of dictionaries specifying the plot configuration.

Returns:

The generated line plot.

Return type:

holoviews.plotting.ElementPlot

load_collection(collection_name, filenames, eva_class_name, control_file=None)

Load a data collection into the EvaInteractive instance.

Parameters:

• collection_name (str) – Name for the loaded data collection.

• filenames (str or list) – Filename(s) containing the data.

• eva_class_name (str) – Name of the EVA class for creating the data collection.

• control_file (str, optional) – Path to the control file for configuring data collection.

• None. (Default is) –

map_gridded()

Placeholder method for generating a gridded map plot.

map_scatter(plot_entry)

Generate a scatter plot on a map using specified data collection and variables.

Parameters:

plot_entry (dict) – Dictionary specifying the plot configuration.

Returns:

The generated scatter plot on a map.

Return type:

holoviews.plotting.ElementPlot

print_data_collection(collection_name)

Print the content of a data collection.

Parameters:

collection_name (str) – Name of the data collection to print.

print_statistics(df)

Print statistics for each column in the given DataFrame.

Parameters:

df (DataFrame) – The DataFrame containing data.

retrieve_var_list(collection, group)

Retrieve a list of variable names from a data collection’s group.

Parameters:

• collection (str) – Name of the data collection.

• group (str) – Name of the group within the data collection.

Returns:

List of variable names within the specified group.

Return type:

list

scatter(x, y)

Generate a scatter plot using specified data collections, variables, and coordinates.

Parameters:

• x (str) – Name of the variable for the x-coordinate.

• y (str) – Name of the variable for the y-coordinate.

Returns:

The generated scatter plot.

Return type:

holoviews.plotting.ElementPlot

eva.eva_path module

eva.eva_path.return_eva_path()

Return the directory path of the current script file.

Returns:

Directory path of the current script file.

Return type:

str

eva.eva_tests module

eva.eva_tests.application_tests(logger)

Run Eva application tests using specified configurations.

Parameters:

logger (Logger) – An instance of the Logger class for logging messages.

eva.eva_tests.main()

Main function for running Eva test suite.

eva.eva_tests.notebook_tests(logger)

Run Eva notebook tests by executing specified notebooks.

Parameters:

logger (Logger) – An instance of the Logger class for logging messages.

Module contents