Welcome to mjoindices’s documentation!

Contents:

• Quickstart
  • mjoindices - A python package for calculating the Madden-Julian-Oscillation OMI index
    • Overview
    • Citation
    • Contributors
    • Requirements
    • Installation
    • Getting started / examples
    • Documentation
    • Automated testing
• API documentation (for running calculations)
  • Module mjoindices.omi.omi_calculator
    • calc_eofs_for_doy()
    • calc_eofs_for_doy_using_eofs_package()
    • calc_eofs_from_olr()
    • calc_eofs_from_preprocessed_olr()
    • calculate_pcs_from_olr()
    • calculate_pcs_from_olr_original_conditions()
    • initiate_eof_post_processing()
    • preprocess_olr()
    • regress_3dim_data_onto_eofs()
    • regress_vector_onto_eofs()
  • Module mjoindices.olr_handling
    • OLRData
    • interpolate_spatial_grid()
    • interpolate_spatial_grid_to_original()
    • load_noaa_interpolated_olr()
    • load_noaa_interpolated_olr_netcdf4()
    • plot_olr_map_for_date()
    • remove_leap_years()
    • restore_from_npzfile()
    • restrict_time_coverage()
  • Module mjoindices.omi.postprocessing_original_kiladis2014
    • correct_spontaneous_sign_changes_in_eof_series()
    • interpolate_eofs_between_doys()
    • post_process_eofs_original_kiladis_approach()
  • Module mjoindices.omi.postprocessing_rotation_approach
    • angle_between_eofs()
    • angle_btwn_vectors()
    • calculate_angle_from_discontinuity()
    • normalize_eofs()
    • post_process_eofs_rotation()
    • rotate_each_eof_by_delta()
    • rotate_eofs()
    • rotation_matrix()
• API documentation (for working with results)
  • Module mjoindices.principal_components
    • PCData
    • load_original_pcs_from_txt_file()
    • load_pcs_from_txt_file()
  • Module mjoindices.empirical_orthogonal_functions
    • EOFData
    • EOFDataForAllDOYs
    • load_all_eofs_from_directory()
    • load_all_original_eofs_from_directory()
    • load_original_eofs_for_doy()
    • load_single_eofs_from_txt_file()
    • plot_eigenvalues_for_all_doys()
    • plot_explained_variance_for_all_doys()
    • plot_individual_eof_map()
    • plot_individual_eof_map_from_file()
    • plot_individual_explained_variance_all_eofs()
    • plot_original_individual_eof_map()
    • restore_all_eofs_from_npzfile()
• API documentation (minor relevance for users)
  • Module mjoindices.omi.wheeler_kiladis_mjo_filter
    • WKFilter
    • detrend_vector()
    • filter_olr_for_mjo_eof_calculation()
    • filter_olr_for_mjo_pc_calculation()
    • filter_olr_temporally()
    • filter_olr_temporally_and_longitudinally()
    • taper_vector_to_zero()
  • Module mjoindices.omi.quick_temporal_filter
    • filter_olr_for_mjo_pc_calculation_1d_spectral_smoothing()
    • filter_olr_temporally_1d_spectral_smoothing()
  • Module mjoindices.tools
    • calc_day_of_year()
    • doy_list()
    • find_doy_ranges_in_dates()
  • Module mjoindices.evaluation_tools
    • calc_comparison_stats_for_eofs_all_doys()
    • calc_comparison_stats_for_explained_variance()
    • calc_timeseries_agreement()
    • calc_vector_agreement()
    • compute_vector_difference_quantity()
    • load_omi_explained_variance()
    • plot_comparison_orig_calc_pcs()
    • plot_comparison_stats_for_eofs_all_doys()
    • plot_comparison_stats_for_explained_variance()
    • plot_correlation_for_eofs_all_doys()
    • plot_individual_eof_map_comparison()
    • plot_timeseries_agreement()
    • plot_vector_agreement()
• References and citation hints
  • Peer-reviewed
    • Hoffmann et al. (2021)
    • Kiladis et al. (2014)
    • Weidman et al. (2022)
  • Others
    • Hoffmann (2020a)
    • Hoffmann et al. (2020b)
    • Kiladis et al. (2020)
• Indices and tables

Important abbreviations

• DOY: Day of the Year

• EOF: Empirical Orthogonal Function

• MJO: Madden-Julian Oscillation

• OLR: Outgoing long-wave radiation

• OMI: OLR-based MJO index.

• PC: Principal Component