ashdisperse package

Subpackages

• ashdisperse.config package
  • Submodules
  • ashdisperse.config.config module
    • get_chunk_size()
    • get_max_threads()
    • get_num_threads()
    • get_threading_layer()
    • set_chunk_size()
    • set_default_threads()
    • set_num_threads()
    • set_threading_layer()
  • Module contents
• ashdisperse.containers package
  • Submodules
  • ashdisperse.containers.cheb module
    • ChebContainer
      • ChebContainer.class_type
  • ashdisperse.containers.velocities module
    • VelocityContainer
      • VelocityContainer.class_type
  • Module contents
• ashdisperse.core package
  • Submodules
  • ashdisperse.core.core module
    • LowerODE()
    • UpperODE()
  • ashdisperse.core.getters module
    • Source_z()
    • Source_z_dimless()
    • Source_z_dimless_value()
    • Source_z_value()
    • Ws_surface()
    • lower_U()
    • lower_V()
    • lower_Ws()
    • lower_dWsdz()
    • lower_z()
    • upper_U()
    • upper_V()
    • upper_Ws()
    • upper_dWsdz()
    • upper_z()
  • ashdisperse.core.results module
    • AshDisperseResult
      • AshDisperseResult.C0
      • AshDisperseResult.C0_FT
      • AshDisperseResult.C0_dimless
      • AshDisperseResult.Cz
      • AshDisperseResult.Cz_FT
      • AshDisperseResult.Cz_dimless
      • AshDisperseResult.POI_ashload()
      • AshDisperseResult.POI_ashload_for_grain_class()
      • AshDisperseResult.POI_groundconc()
      • AshDisperseResult.POI_groundconc_for_grain_class()
      • AshDisperseResult.POI_settlingflux()
      • AshDisperseResult.POI_settlingflux_for_grain_class()
      • AshDisperseResult.SettlingFlux
      • AshDisperseResult.change_MER()
      • AshDisperseResult.change_duration()
      • AshDisperseResult.change_grain_proportions()
      • AshDisperseResult.contour_ashload_for_grain_class()
      • AshDisperseResult.contour_settling_flux()
      • AshDisperseResult.create()
      • AshDisperseResult.folium_ashloads()
      • AshDisperseResult.from_netcdf()
      • AshDisperseResult.get_ashload()
      • AshDisperseResult.get_ashload_for_grain_class()
      • AshDisperseResult.get_groundconc_for_grain_class()
      • AshDisperseResult.get_settlingflux_for_grain_class()
      • AshDisperseResult.get_total_ashload()
      • AshDisperseResult.grain_classes
      • AshDisperseResult.interpolated
      • AshDisperseResult.kx
      • AshDisperseResult.ky
      • AshDisperseResult.linear_interp()
      • AshDisperseResult.max_ashload_for_grain_class()
      • AshDisperseResult.params
      • AshDisperseResult.plot_ashload()
      • AshDisperseResult.plot_ashload_for_grain_class()
      • AshDisperseResult.plot_conc_for_grain_class()
      • AshDisperseResult.plot_iso_conc_for_grain_class()
      • AshDisperseResult.plot_settling_flux_for_grain_class()
      • AshDisperseResult.plot_spectrum_for_grainsize()
      • AshDisperseResult.raster_ashload_for_grain_class()
      • AshDisperseResult.raster_groundconc_for_grain_class()
      • AshDisperseResult.raster_settlingflux_for_grain_class()
      • AshDisperseResult.raster_total_ashload()
      • AshDisperseResult.source_marker
      • AshDisperseResult.to_netcdf()
      • AshDisperseResult.utm
      • AshDisperseResult.utmepsg
      • AshDisperseResult.write_ashload_for_grain_class()
      • AshDisperseResult.write_gtiff()
      • AshDisperseResult.write_settling_flux_for_grain_class()
      • AshDisperseResult.x
      • AshDisperseResult.x_dimless
      • AshDisperseResult.y
      • AshDisperseResult.y_dimless
    • compat_warning()
  • Module contents
• ashdisperse.data package
  • Module contents
• ashdisperse.interface package
  • Submodules
  • ashdisperse.interface.interface module
    • advected_settling_trajectories()
    • dispersal_distance_vs_grain_sizes()
    • estimate_dispersal_distance()
    • load_inputs()
    • print_emission_parameters()
    • print_grain_parameters()
    • print_model_parameters()
    • print_output_parameters()
    • print_physical_parameters()
    • print_solver_parameters()
    • print_source_parameters()
    • save_inputs()
    • set_emission_parameters()
    • set_grain_parameters()
    • set_met()
    • set_met_parameters()
    • set_model_parameters()
    • set_output_parameters()
    • set_parameters()
    • set_physical_parameters()
    • set_solver_parameters()
    • set_source_parameters()
  • Module contents
• ashdisperse.mapping package
  • Submodules
  • ashdisperse.mapping.epsg_defs module
  • ashdisperse.mapping.mapping module
    • add_POI_marker()
    • add_basemap()
    • add_esri_basemap()
    • add_north_arrow()
    • add_opentopo_basemap()
    • add_osm()
    • add_scale_bar()
    • add_stamen_basemap()
    • ax_ticks()
    • expand_axes()
    • latlon_to_utm_epsg()
    • set_figure_size()
    • set_min_axes()
    • stamen_zoom_level()
  • ashdisperse.mapping.webmap module
    • BindColormap
  • Module contents
• ashdisperse.met package
  • Submodules
  • ashdisperse.met.met module
    • MetData
      • MetData.class_type
    • MetProfile_to_Met()
    • gfs_archive_to_Met()
    • gfs_to_Met()
    • load_met()
    • load_met_from_repodf()
    • netCDF_to_Met()
    • read_wyoming_legacy_radiosonde()
    • read_wyoming_radiosonde()
    • save_met()
    • wind_plot()
    • wind_scale()
  • Module contents
• ashdisperse.params package
  • Submodules
  • ashdisperse.params.grain_params module
    • GrainParameters
      • GrainParameters.class_type
  • ashdisperse.params.met_params module
    • MetParameters
      • MetParameters.class_type
  • ashdisperse.params.model_params module
    • ModelParameters
      • ModelParameters.class_type
  • ashdisperse.params.output_params module
    • OutputParameters
      • OutputParameters.class_type
  • ashdisperse.params.params module
    • Parameters
      • Parameters.class_type
    • copy_parameters()
    • load_parameters()
    • parameters_from_dict()
    • save_parameters()
    • update_parameters()
  • ashdisperse.params.physical_params module
    • PhysicalParameters
      • PhysicalParameters.class_type
  • ashdisperse.params.solver_params module
    • SolverParameters
      • SolverParameters.class_type
  • ashdisperse.params.source_params module
    • SourceParameters
      • SourceParameters.class_type
  • Module contents
• ashdisperse.solver package
  • Submodules
  • ashdisperse.solver.solver module
  • ashdisperse.solver.sources module
  • Module contents
• ashdisperse.spectral package
  • Submodules
  • ashdisperse.spectral.cheb module
    • ChebMat()
    • cheb()
    • cheb_dif_m1()
    • cheb_dif_p1()
    • cheb_tail_test()
    • cheb_val_m1()
    • cheb_val_p1()
    • linear_fit_coeffs()
    • truncateCoeffs()
  • ashdisperse.spectral.fourier module
    • grid_freq()
  • Module contents
• ashdisperse.utilities package
  • Submodules
  • ashdisperse.utilities.datetime_strings module
    • is_valid_datetime()
    • string_to_datetime()
  • ashdisperse.utilities.geo module
    • latlon_point_to_utm_code()
  • ashdisperse.utilities.number_utils module
    • lin_levels()
    • log_levels()
    • log_steps()
    • nice_round_down()
    • nice_round_up()
  • ashdisperse.utilities.plotting module
    • pad_window()
    • plot_rowscols()
  • ashdisperse.utilities.utilities module
    • SA_Density_array()
    • SA_Density_value()
    • SA_Pressure_array()
    • SA_Pressure_value()
    • SA_Temperature_array()
    • SA_Temperature_value()
    • interp_ex_array()
    • interp_ex_value()
  • Module contents

Submodules

ashdisperse.ashdisperse module

ashdisperse.queryreport module

class ashdisperse.queryreport.NameLatLonValidator

Bases: Validator

validate(document)

Validate the input. If invalid, this should raise a ValidationError.

Parameters:

document – Document instance.

ashdisperse.queryreport.detect_shell_name() → str

ashdisperse.queryreport.get_latlon_from_gvp_name(name: str) → tuple[str | None, float | None, float | None]

ashdisperse.queryreport.has_comma(text)

ashdisperse.queryreport.is_valid_float(num)

ashdisperse.queryreport.is_valid_lat(lat)

ashdisperse.queryreport.is_valid_latlon(latlon: str) → tuple[float | None, float | None]

ashdisperse.queryreport.is_valid_lon(lon)

ashdisperse.queryreport.isnotebook() → bool

ashdisperse.queryreport.print_text(text: str) → None

ashdisperse.queryreport.print_title(title_text: str) → None

ashdisperse.queryreport.print_warning(text: str) → None

ashdisperse.queryreport.query_change_value(question: str, default: ~ashdisperse.queryreport.T | None = None, lower: ~ashdisperse.queryreport.T | None = None, upper: ~ashdisperse.queryreport.T | None = None, answer_type: type[~ashdisperse.queryreport.T] = <class 'float'>) → T

Ask a question via input() and return their answer.

“question” is a string that is presented to the user. “default” is the presumed answer if the user just hits <Enter>.

It must be a value

“answer_type” is the type of the answer expected.

ashdisperse.queryreport.query_choices(question: str, choices: list[str] = ['y', 'n'], default: str | None = None) → str

Asks a question via input() with answer in choices.

Args:

question: a string that is presented to the user. choices: a list of allowed responses **default: Optional; the presumed answer if the user just hits <Enter>.

Returns:

The “answer” return value is True for “yes” or False for “no”.

ashdisperse.queryreport.query_datetime(question)

ashdisperse.queryreport.query_latlon() → tuple[str | None, float | None, float | None]

ashdisperse.queryreport.query_met_file() → str

ashdisperse.queryreport.query_set_value(question, answer_type=<class 'float'>, lower=None, upper=None)

Ask a question via input() and return their answer.

“question” is a string that is presented to the user. “answer_type” is the type of the answer expected.

ashdisperse.queryreport.query_yes_no(question: str, default: str = 'yes') → bool

ashdisperse.version module

Module contents