ESMValCore API Reference

ESMValCore is mostly used as a commandline tool. However, it is also possibly to use (parts of) ESMValTool as a library. This section documents the public API of ESMValCore.

• CMOR functions
  • Checking compliance
    • CMORCheck
      • CMORCheck.frequency
      • CMORCheck.ALTERNATIVE_GENERIC_LEV_COORDS
      • CMORCheck.check_data()
      • CMORCheck.check_metadata()
      • CMORCheck.has_debug_messages()
      • CMORCheck.has_errors()
      • CMORCheck.has_warnings()
      • CMORCheck.report()
      • CMORCheck.report_critical()
      • CMORCheck.report_debug_message()
      • CMORCheck.report_debug_messages()
      • CMORCheck.report_error()
      • CMORCheck.report_errors()
      • CMORCheck.report_warning()
      • CMORCheck.report_warnings()
    • CMORCheckError
      • CMORCheckError.args
      • CMORCheckError.with_traceback()
    • CheckLevels
      • CheckLevels.DEBUG
      • CheckLevels.DEFAULT
      • CheckLevels.IGNORE
      • CheckLevels.RELAXED
      • CheckLevels.STRICT
    • cmor_check()
    • cmor_check_data()
    • cmor_check_metadata()
  • Automatically fixing issues
    • fix_data()
    • fix_file()
    • fix_metadata()
  • Functions for fixing issues
    • add_altitude_from_plev()
    • add_plev_from_altitude()
  • Using CMOR tables
    • CMIP3Info
      • CMIP3Info.get_table()
      • CMIP3Info.get_variable()
    • CMIP5Info
      • CMIP5Info.get_table()
      • CMIP5Info.get_variable()
    • CMIP6Info
      • CMIP6Info.get_table()
      • CMIP6Info.get_variable()
    • CMOR_TABLES
    • CoordinateInfo
      • CoordinateInfo.axis
      • CoordinateInfo.generic_lev_name
      • CoordinateInfo.long_name
      • CoordinateInfo.must_have_bounds
      • CoordinateInfo.out_name
      • CoordinateInfo.read_json()
      • CoordinateInfo.requested
      • CoordinateInfo.standard_name
      • CoordinateInfo.stored_direction
      • CoordinateInfo.units
      • CoordinateInfo.valid_max
      • CoordinateInfo.valid_min
      • CoordinateInfo.value
      • CoordinateInfo.var_name
    • CustomInfo
      • CustomInfo.get_table()
      • CustomInfo.get_variable()
    • InfoBase
      • InfoBase.get_table()
      • InfoBase.get_variable()
    • JsonInfo
    • TableInfo
      • TableInfo.clear()
      • TableInfo.copy()
      • TableInfo.fromkeys()
      • TableInfo.get()
      • TableInfo.items()
      • TableInfo.keys()
      • TableInfo.pop()
      • TableInfo.popitem()
      • TableInfo.setdefault()
      • TableInfo.update()
      • TableInfo.values()
    • VariableInfo
      • VariableInfo.coordinates
      • VariableInfo.copy()
      • VariableInfo.dimensions
      • VariableInfo.frequency
      • VariableInfo.long_name
      • VariableInfo.modeling_realm
      • VariableInfo.positive
      • VariableInfo.read_json()
      • VariableInfo.short_name
      • VariableInfo.standard_name
      • VariableInfo.units
      • VariableInfo.valid_max
      • VariableInfo.valid_min
    • get_var_info()
    • read_cmor_tables()
• Find and download files from ESGF
  • esmvalcore.esgf
    • find_files()
    • download()
    • ESGFFile
      • ESGFFile.urls
      • ESGFFile.dataset
      • ESGFFile.name
      • ESGFFile.size
      • ESGFFile.download()
      • ESGFFile.local_file()
  • esmvalcore.esgf.facets
    • DATASET_MAP
    • FACETS
    • create_dataset_map()
• Exceptions
  • ESMValCoreDeprecationWarning
  • InputFilesNotFound
  • RecipeError
• Iris helper functions
  • add_leading_dim_to_cube()
  • date2num()
  • var_name_constraint()
• Preprocessor functions
  • DEFAULT_ORDER
  • accumulate_coordinate()
  • add_fx_variables()
  • amplitude()
  • annual_statistics()
  • anomalies()
  • area_statistics()
  • axis_statistics()
  • bias()
  • cleanup()
  • climate_statistics()
  • clip()
  • clip_timerange()
  • cmor_check_data()
  • cmor_check_metadata()
  • concatenate()
  • convert_units()
  • daily_statistics()
  • decadal_statistics()
  • depth_integration()
  • derive()
  • detrend()
  • ensemble_statistics()
  • extract_coordinate_points()
  • extract_levels()
  • extract_location()
  • extract_month()
  • extract_named_regions()
  • extract_point()
  • extract_region()
  • extract_season()
  • extract_shape()
  • extract_time()
  • extract_trajectory()
  • extract_transect()
  • extract_volume()
  • fix_data()
  • fix_file()
  • fix_metadata()
  • hourly_statistics()
  • linear_trend()
  • linear_trend_stderr()
  • load()
  • mask_above_threshold()
  • mask_below_threshold()
  • mask_fillvalues()
  • mask_glaciated()
  • mask_inside_range()
  • mask_landsea()
  • mask_landseaice()
  • mask_multimodel()
  • mask_outside_range()
  • meridional_statistics()
  • monthly_statistics()
  • multi_model_statistics()
  • regrid()
  • regrid_time()
  • remove_fx_variables()
  • resample_hours()
  • resample_time()
  • rolling_window_statistics()
  • save()
  • seasonal_statistics()
  • timeseries_filter()
  • volume_statistics()
  • weighting_landsea_fraction()
  • zonal_statistics()
• Experimental API
  • Configuration
    • Config
    • Session
    • API reference
      • CFG
      • Config
        • Config.load_from_file()
        • Config.reload()
        • Config.start_session()
      • Session
        • Session.config_dir
        • Session.from_config_user()
        • Session.main_log
        • Session.main_log_debug
        • Session.plot_dir
        • Session.preproc_dir
        • Session.relative_main_log
        • Session.relative_main_log_debug
        • Session.relative_plot_dir
        • Session.relative_preproc_dir
        • Session.relative_run_dir
        • Session.relative_work_dir
        • Session.run_dir
        • Session.session_dir
        • Session.session_name
        • Session.set_session_name()
        • Session.to_config_user()
        • Session.work_dir
  • Recipes
    • Recipe metadata
    • Running a recipe
    • Running a single diagnostic or preprocessor task
    • API reference
      • Recipe
        • Recipe.data
        • Recipe.get_output()
        • Recipe.name
        • Recipe.render()
        • Recipe.run()
  • Recipe output
    • Working with output files
    • Working with image files
    • Working with data files
    • API reference
      • DataFile
        • DataFile.authors
        • DataFile.caption
        • DataFile.citation_file
        • DataFile.create()
        • DataFile.data_citation_file
        • DataFile.kind
        • DataFile.load_iris()
        • DataFile.load_xarray()
        • DataFile.provenance_xml_file
        • DataFile.references
      • DiagnosticOutput
      • ImageFile
        • ImageFile.authors
        • ImageFile.caption
        • ImageFile.citation_file
        • ImageFile.create()
        • ImageFile.data_citation_file
        • ImageFile.kind
        • ImageFile.provenance_xml_file
        • ImageFile.references
        • ImageFile.to_base64()
      • OutputFile
        • OutputFile.authors
        • OutputFile.caption
        • OutputFile.citation_file
        • OutputFile.create()
        • OutputFile.data_citation_file
        • OutputFile.kind
        • OutputFile.provenance_xml_file
        • OutputFile.references
      • RecipeOutput
        • RecipeOutput.diagnostics
        • RecipeOutput.info
        • RecipeOutput.session
        • RecipeOutput.from_core_recipe_output()
        • RecipeOutput.get()
        • RecipeOutput.items()
        • RecipeOutput.keys()
        • RecipeOutput.read_main_log()
        • RecipeOutput.read_main_log_debug()
        • RecipeOutput.render()
        • RecipeOutput.values()
        • RecipeOutput.write_html()
      • TaskOutput
        • TaskOutput.data_files
        • TaskOutput.from_task()
        • TaskOutput.image_files
  • Recipe Metadata
    • API reference
      • Contributor
        • Contributor.from_dict()
        • Contributor.from_tag()
      • Project
        • Project.from_tag()
      • Reference
        • Reference.from_tag()
        • Reference.render()
      • RenderError
        • RenderError.args
        • RenderError.with_traceback()
  • Utils
    • Finding recipes
    • API reference
      • RecipeList
        • RecipeList.find()
      • get_all_recipes()
      • get_recipe()