HDP Documentation

Contents

• Overview
  • What is the HDP?
  • Statement of Need
  • Quick Start
• Installation
  • Dependencies
• Examples
  • Example: Quick Start Walkthrough
  • Example: Analyzing CESM2 Dataset hosted in the Cloud
• Developer Guide
  • Docker (preferred)
  • Conda Environment
  • Existing Environment
• Unit Testing
  • test_utils.py
  • test_workflow.py
  • test_heatwave*.py
  • test_index_heatwaves.py
• API
  • Measure Functions
    • apply_heat_index()
    • celsius_to_fahrenheit()
    • convert_temp_units()
    • fahrenheit_to_celsius()
    • format_standard_measures()
    • kelvin_to_celsius()
  • Threshold Functions
    • compute_threshold()
    • compute_threshold_io()
    • compute_thresholds()
    • datetimes_to_windows()
  • Metric Functions
    • build_doy_map()
    • compute_heatwave_metrics()
    • compute_hemisphere_ranges()
    • compute_individual_metrics()
    • compute_metrics_io()
    • get_range_indices()
    • heatwave_average()
    • heatwave_duration()
    • heatwave_frequency()
    • heatwave_number()
    • index_heatwaves()
    • indicate_hot_days()
  • Plotting/Graphics Functions
    • get_color_for_value()
    • plot_metric_decadal_maps()
    • plot_metric_parameter_comparison()
    • plot_metric_timeseries()
    • plot_multi_measure_metric_comparisons()
    • WinkelTripel