climind package

Subpackages

• climind.config package
  • Submodules
  • climind.config.config module
    • check_setup()
  • Module contents
• climind.data_manager package
  • Submodules
  • climind.data_manager.metadata module
    • BaseMetadata
      • BaseMetadata.metadata
      • BaseMetadata.fill_string()
      • BaseMetadata.match_metadata()
    • CollectionMetadata
    • CombinedMetadata
      • CombinedMetadata.creation_message()
      • CombinedMetadata.match_metadata()
      • CombinedMetadata.write_metadata()
    • DatasetMetadata
      • DatasetMetadata.creation_message()
    • list_match()
  • climind.data_manager.processing module
    • DataArchive
      • DataArchive.collections
      • DataArchive.add_collection()
      • DataArchive.download()
      • DataArchive.from_directory()
      • DataArchive.read_datasets()
      • DataArchive.select()
    • DataCollection
      • DataCollection.global_attributes
      • DataCollection.datasets
      • DataCollection.add_dataset()
      • DataCollection.download()
      • DataCollection.from_file()
      • DataCollection.get_collection_dir()
      • DataCollection.match_metadata()
      • DataCollection.read_datasets()
      • DataCollection.to_file()
    • DataSet
      • DataSet.name
      • DataSet.metadata
      • DataSet.global_metadata
      • DataSet.download()
      • DataSet.match_metadata()
      • DataSet.read_dataset()
    • get_function()
  • Module contents
• climind.data_types package
  • Submodules
  • climind.data_types.grid module
    • GridAnnual
      • GridAnnual.get_end_year()
      • GridAnnual.get_start_year()
      • GridAnnual.get_year_range()
      • GridAnnual.rank()
      • GridAnnual.running_average()
      • GridAnnual.select_year_range()
      • GridAnnual.update_history()
      • GridAnnual.write_grid()
    • GridMonthly
      • GridMonthly.calculate_regional_average()
      • GridMonthly.calculate_regional_average_missing()
      • GridMonthly.calculate_time_mean()
      • GridMonthly.get_end_year()
      • GridMonthly.get_last_month()
      • GridMonthly.get_start_year()
      • GridMonthly.make_annual()
      • GridMonthly.rebaseline()
      • GridMonthly.select_period()
      • GridMonthly.select_year_and_month()
      • GridMonthly.update_history()
    • get_1d_transfer()
    • get_start_and_end_year()
    • make_standard_grid()
    • make_xarray()
    • median_of_datasets()
    • process_datasets()
    • range_of_datasets()
    • rank_array()
    • simple_regrid()
  • climind.data_types.timeseries module
    • AveragesCollection
      • AveragesCollection.best_estimate()
      • AveragesCollection.count()
      • AveragesCollection.lower_range()
      • AveragesCollection.range()
      • AveragesCollection.upper_range()
    • TimeSeries
      • TimeSeries.add_offset()
      • TimeSeries.get_first_and_last_year()
      • TimeSeries.get_string_date_range()
      • TimeSeries.manually_set_baseline()
      • TimeSeries.select_year_range()
      • TimeSeries.update_history()
      • TimeSeries.write_generic_csv()
    • TimeSeriesAnnual
      • TimeSeriesAnnual.df
      • TimeSeriesAnnual.metadata
      • TimeSeriesAnnual.add_year()
      • TimeSeriesAnnual.generate_dates()
      • TimeSeriesAnnual.get_rank_from_year()
      • TimeSeriesAnnual.get_string_date_range()
      • TimeSeriesAnnual.get_uncertainty_from_year()
      • TimeSeriesAnnual.get_value_from_year()
      • TimeSeriesAnnual.get_year_axis()
      • TimeSeriesAnnual.get_year_from_rank()
      • TimeSeriesAnnual.lowess()
      • TimeSeriesAnnual.make_from_df()
      • TimeSeriesAnnual.rebaseline()
      • TimeSeriesAnnual.record_margins()
      • TimeSeriesAnnual.running_lowess()
      • TimeSeriesAnnual.running_mean()
      • TimeSeriesAnnual.running_stdev()
      • TimeSeriesAnnual.running_trend()
      • TimeSeriesAnnual.select_decade()
      • TimeSeriesAnnual.time_average()
      • TimeSeriesAnnual.write_csv()
      • TimeSeriesAnnual.write_simple_csv()
    • TimeSeriesIrregular
      • TimeSeriesIrregular.fill_daily()
      • TimeSeriesIrregular.generate_dates()
      • TimeSeriesIrregular.get_climatology()
      • TimeSeriesIrregular.get_start_and_end_dates()
      • TimeSeriesIrregular.get_string_date_range()
      • TimeSeriesIrregular.get_year_axis()
      • TimeSeriesIrregular.lowess()
      • TimeSeriesIrregular.make_monthly()
      • TimeSeriesIrregular.rebaseline()
      • TimeSeriesIrregular.write_csv()
      • TimeSeriesIrregular.zero_on_year()
    • TimeSeriesMonthly
      • TimeSeriesMonthly.df
      • TimeSeriesMonthly.metadata
      • TimeSeriesMonthly.calculate_climatology()
      • TimeSeriesMonthly.change_end_month()
      • TimeSeriesMonthly.generate_dates()
      • TimeSeriesMonthly.get_rank_from_year_and_month()
      • TimeSeriesMonthly.get_start_and_end_dates()
      • TimeSeriesMonthly.get_string_date_range()
      • TimeSeriesMonthly.get_uncertainty()
      • TimeSeriesMonthly.get_value()
      • TimeSeriesMonthly.get_year_axis()
      • TimeSeriesMonthly.lowess()
      • TimeSeriesMonthly.make_annual()
      • TimeSeriesMonthly.make_annual_by_selecting_month()
      • TimeSeriesMonthly.make_from_df()
      • TimeSeriesMonthly.rebaseline()
      • TimeSeriesMonthly.running_mean()
      • TimeSeriesMonthly.write_csv()
      • TimeSeriesMonthly.zero_on_month()
    • create_common_dataframe()
    • equalise_datasets()
    • get_list_of_unique_variables()
    • get_start_and_end_year()
    • log_activity()
    • make_combined_series()
    • superset_dataset_list()
    • write_dataset_summary_file()
    • write_dataset_summary_file_with_metadata()
  • Module contents
• climind.fetchers package
  • Submodules
  • climind.fetchers.fetcher_cds module
    • fetch()
    • fetch_to_year()
    • pick_months()
  • climind.fetchers.fetcher_cds_ensemble module
    • fetch()
    • fetch_year()
  • climind.fetchers.fetcher_cmems_ftp module
    • fetch()
  • climind.fetchers.fetcher_ersst module
    • fetch()
  • climind.fetchers.fetcher_ftp module
    • fetch()
  • climind.fetchers.fetcher_gpcc module
    • fetch()
    • fetch_year()
  • climind.fetchers.fetcher_gpcc_quantile module
    • fetch()
    • get_file()
    • get_time_span()
  • climind.fetchers.fetcher_grace module
    • fetch()
  • climind.fetchers.fetcher_grace_aws module
  • climind.fetchers.fetcher_jaxa module
    • fetch()
  • climind.fetchers.fetcher_jra3q_grid module
    • download_file()
    • fetch()
    • get_files()
    • make_file_list()
    • make_realtime_file_list()
    • process_file()
  • climind.fetchers.fetcher_jra55_grid module
    • download_file()
    • fetch()
    • get_files()
    • make_file_list()
    • make_realtime_file_list()
  • climind.fetchers.fetcher_no_url module
    • fetch()
  • climind.fetchers.fetcher_noaaglobaltemp module
    • fetch()
  • climind.fetchers.fetcher_promice module
    • fetch()
  • climind.fetchers.fetcher_standard_url module
    • fetch()
  • climind.fetchers.fetcher_standard_url_with_rename module
    • fetch()
  • climind.fetchers.fetcher_url_with_backsearch module
    • fetch()
    • filename_from_url()
  • climind.fetchers.fetcher_utils module
    • dir_and_filename_from_url()
    • filename_from_url()
    • fill_year_month()
    • get_ftp_host_and_directory_from_url()
    • get_n_months_back()
    • time_tag_string()
    • url_from_filename()
  • Module contents
• climind.plotters package
  • Submodules
  • climind.plotters.plot_types module
    • accumulate()
    • add_data_sets()
    • add_labels()
    • after_plot()
    • animated_plot()
    • antarctic_sea_ice_plot()
    • arctic_sea_ice_plot()
    • cherry_plot()
    • daily_sea_ice_plot()
    • dark_plot()
    • dashboard_map()
    • dashboard_map_generic()
    • dashboard_map_pastel()
    • dashboard_map_simplified()
    • dashboard_map_single()
    • dashboard_rank_map()
    • dashboard_uncertainty_map()
    • decade_plot()
    • equivalence()
    • get_levels_and_palette()
    • interactive_widget()
    • interactive_widget_uncertainty()
    • marine_heatwave_plot()
    • monthly_plot()
    • neat_plot()
    • nice_map()
    • plot_map_by_year_and_month()
    • preindustrial_summary_plot()
    • quick_and_dirty_map()
    • rank_by_dataset()
    • records_plot()
    • regional_dashboard_map()
    • regional_dashboard_map_single()
    • regional_dashboard_uncertainty_map()
    • rising_tide_multiple_plot()
    • rising_tide_plot()
    • set_xaxis()
    • set_yaxis()
    • show_premade_image()
    • simplified_line()
    • spark_line()
    • trends_plot()
    • wave_multiple_plot()
    • wave_plot()
    • wmo_monthly_plot()
    • wmo_plot()
  • climind.plotters.plot_utils module
    • calculate_highest_year_and_values()
    • calculate_ranks()
    • calculate_trends()
    • calculate_values()
    • calculate_values_ipcc_style()
    • caption_builder()
    • get_first_and_last_years()
    • map_caption_builder()
    • set_lo_hi_ticks()
  • Module contents
• climind.readers package
  • Submodules
  • climind.readers.generic_reader module
    • get_last_modified_time()
    • get_module()
    • get_reader_script_name()
    • read_ts()
  • climind.readers.generic_reader_utils module
    • find_latest()
    • get_latest_filename_and_url()
  • climind.readers.reader_aviso module
    • read_monthly_ts()
  • climind.readers.reader_aviso_ftp module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_aviso_ll module
    • read_monthly_ts()
  • climind.readers.reader_badc_csv module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_berkeley module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_berkeley_hires module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_berkeley_ts module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_blair_berkeley module
    • read_monthly_ts()
  • climind.readers.reader_calvert module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_cds_sea_level module
    • read_grid()
    • read_monthly_grid()
    • read_ts()
  • climind.readers.reader_cheng module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_cheng_update module
    • read_annual_ts()
  • climind.readers.reader_cherry module
    • read_annual_ts()
  • climind.readers.reader_climate_reanalyzer module
    • read_irregular_ts()
  • climind.readers.reader_climtrace_ts module
    • read_annual_ts()
  • climind.readers.reader_clsat module
    • read_annual_ts()
    • read_monthly_grid()
  • climind.readers.reader_cmems_ph module
    • read_annual_ts()
    • read_ts()
  • climind.readers.reader_cmems_sealevel module
    • read_monthly_ts()
  • climind.readers.reader_cmems_trend module
    • gread_ts()
    • read_grid()
    • read_monthly_grid()
  • climind.readers.reader_cmst module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_cobe_stemp_ts module
    • read_monthly_ts()
  • climind.readers.reader_collab_ts module
    • read_monthly_ts()
  • climind.readers.reader_colorado_sealevel module
    • convert_partial_year()
    • read_monthly_ts()
  • climind.readers.reader_cowtan_and_way_ts module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_cpc module
    • read_monthly_ts()
  • climind.readers.reader_csiro_sealevel module
    • convert_partial_year()
    • read_monthly_ts()
  • climind.readers.reader_dcent_ts module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_era5 module
    • back_search()
    • find_latest()
    • get_latest_filename_and_url()
    • read_annual_ts()
    • read_grid()
    • read_irregular_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
    • read_ts()
  • climind.readers.reader_era5_ensemble module
    • find_latest()
    • get_latest_filename_and_url()
    • read_annual_ts()
    • read_grid()
    • read_irregular_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
    • read_ts()
  • climind.readers.reader_gcos module
    • read_annual_ts()
    • read_ts()
  • climind.readers.reader_gcos_temp module
    • read_annual_ts()
    • read_annual_ts_2024()
    • read_ts()
  • climind.readers.reader_getquocs_ts module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
  • climind.readers.reader_giss_aod module
    • read_monthly_ts()
  • climind.readers.reader_gistemp_ts module
    • build_transfer()
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_gml module
    • read_monthly_ts()
  • climind.readers.reader_gpcc module
    • read_monthly_1x1_grid()
    • read_ts()
  • climind.readers.reader_gpcc_quantile module
    • read_monthly_1x1_grid()
    • read_ts()
  • climind.readers.reader_grace module
    • find_latest()
    • read_annual_ts()
    • read_monthly_ts()
    • read_ts()
  • climind.readers.reader_gsfc module
    • read_monthly_ts()
  • climind.readers.reader_hadcrut4_ts module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_hadcrut_ts module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_hadsst_ts module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_imbie module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_imbie_2021_antarctica module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_imbie_antarctica module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_ipcc_ts module
    • read_annual_ts()
  • climind.readers.reader_ishii module
    • read_annual_ts()
  • climind.readers.reader_jaxa module
    • read_irregular_ts()
    • read_monthly_ts()
  • climind.readers.reader_jra3q module
    • read_annual_ts()
    • read_grid()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_jra55 module
    • read_annual_ts()
    • read_grid()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_kadow_ts module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
    • read_ts()
  • climind.readers.reader_kennaook module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_knmi_gmt module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_law_dome module
    • read_annual_ts()
    • read_chunk()
  • climind.readers.reader_levitus module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_mauna_loa module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_mcculloch module
    • read_annual_ts()
  • climind.readers.reader_mhw_ts module
    • read_annual_ts()
  • climind.readers.reader_nasa_sealevel module
    • convert_partial_year()
    • read_monthly_ts()
    • read_new_monthly_ts()
  • climind.readers.reader_noaa_index module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_noaa_interim_ts module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_one_month()
  • climind.readers.reader_noaa_sealevel module
    • convert_partial_year()
    • read_monthly_ts()
  • climind.readers.reader_noaa_ts module
    • find_latest()
    • read_annual_ts()
    • read_monthly_ts()
    • read_ts()
  • climind.readers.reader_noaaglobaltemp module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_grid()
    • read_monthly_ts()
    • read_ts()
  • climind.readers.reader_nsidc module
    • read_irregular_ts()
    • read_monthly_ts()
  • climind.readers.reader_osisaf module
    • read_irregular_ts()
    • read_monthly_ts()
  • climind.readers.reader_osmc module
    • read_irregular_ts()
    • read_monthly_ts()
    • read_ts()
  • climind.readers.reader_ozone_watch module
    • read_annual_ts()
  • climind.readers.reader_promice module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_psl module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_roni module
    • read_monthly_ts()
  • climind.readers.reader_rss module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_rutgers module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_standard_grid module
    • read_annual_grid()
  • climind.readers.reader_star module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_test module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_uah module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_vaccaro_ts module
    • read_annual_ts()
    • read_monthly_1x1_grid()
    • read_monthly_5x5_grid()
    • read_monthly_grid()
    • read_monthly_ts()
  • climind.readers.reader_velicogna module
    • read_monthly_ts()
  • climind.readers.reader_wdcgg_rate_ts module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_wdcgg_ts module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_wdcgg_ts_update module
    • read_annual_ts()
    • read_monthly_ts()
  • climind.readers.reader_wgms module
    • read_annual_ts()
  • Module contents
• climind.stats package
  • Submodules
  • climind.stats.paragraphs module
    • anomaly_and_rank()
    • anomaly_and_rank_plus_new_base()
    • antarctic_ice_paragraph()
    • arctic_ice_paragraph()
    • basic_anomaly_and_rank()
    • co2_paragraph()
    • co2_paragraph_update()
    • compare_to_highest_anomaly_and_rank()
    • convert_to_percentages()
    • dataset_name_list()
    • fancy_html_units()
    • get_last_month()
    • glacier_paragraph()
    • global_anomaly_and_rank()
    • greenland_ice_sheet()
    • greenland_ice_sheet_monthly()
    • ice_sheet_monthly_sm_grace_version()
    • long_term_trend_paragraph()
    • marine_heatwave_and_cold_spell_paragraph()
    • max_monthly_value()
    • nice_list()
    • ordinal()
    • pre_industrial_estimate()
    • precip_paragraph()
    • rank_ranges()
    • superlative()
    • svg_background()
  • climind.stats.utils module
    • get_latitudes()
    • get_n_years_from_n_months()
    • get_ranks()
    • get_values()
    • monthly_to_annual_array()
    • record_margin_table_by_year()
    • record_margins()
    • rolling_average()
    • run_the_numbers()
    • table_by_year()
  • Module contents
• climind.web package
  • Submodules
  • climind.web.dashboard module
    • Card
      • Card.make_csv_files()
      • Card.make_zip_file()
      • Card.plot()
      • Card.process_card()
      • Card.process_datasets()
    • Dashboard
      • Dashboard.build()
      • Dashboard.from_json()
    • Page
      • Page.build()
    • Paragraph
      • Paragraph.process_datasets()
      • Paragraph.process_paragraph()
      • Paragraph.render()
    • WebComponent
      • WebComponent.process_datasets()
      • WebComponent.select_and_read_data()
    • process_single_dataset()
  • climind.web.extract_from_word module
    • GetParagraphText()
    • clean_awkward_characters()
    • split_document()
  • Module contents

Submodules

climind.definitions module

Module contents