API

The following details the major classes and functions used in swxg, organized by the corresponding script in the GitHub repository. Nested functions can be referenced in the GitHub repository as well. Note that you will only ever need to interface with SWXGModel, however this page is an attempt at transparency about how exactly the fits are being performed, how the generation is accomplished, and how validation is assessed.

• model.py
  • SWXGModel
• fit.py
  • fit_copulae()
  • fit_data()
  • fit_precip()
• synthesize.py
  • synthesize_data()
  • synthesize_precip()
  • synthesize_pt_pairs()
• make_figures.py
  • compare_synth_to_obs()
  • squarest_subplots()
  • validate_copulae_statistics()
  • validate_explore_pt_dependence()
  • validate_gmhmm_states()
  • validate_gmhmm_statistics()
  • validate_obs_spatial_temporal_correlations()
  • validate_pt_acf()
  • validate_pt_dependence_structure()
  • validate_pt_fits()
  • validate_pt_stationarity()