ashdisperse.interface package

Submodules

ashdisperse.interface.interface module

ashdisperse.interface.interface.advected_settling_trajectories(params, met) -> (*list[dict[str, numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[~_ScalarT]]]],)

ashdisperse.interface.interface.dispersal_distance_vs_grain_sizes(params, met) → ndarray[tuple[Any, ...], dtype[_ScalarT]]

ashdisperse.interface.interface.estimate_dispersal_distance(params, met) → ndarray[tuple[Any, ...], dtype[_ScalarT]]

ashdisperse.interface.interface.load_inputs(filename)

ashdisperse.interface.interface.print_emission_parameters(emission_params)

Prints the emission profiles in EmissionParameters object.

This function prints a nicely formatted description of a EmissionParameters object.

Args:

emission_params: a EmissionParameters instance.

Raises:

ValueError: if emission_params in not a EmissionParameters instance.

ashdisperse.interface.interface.print_grain_parameters(grain_params)

Prints the grain classes in GrainParameters object.

This function prints a nicely formatted description of a GrainParameters object.

Args:

grain_params: a GrainParameters instance.

Raises:

ValueError: if grain_params in not a GrainParameters instance.

ashdisperse.interface.interface.print_model_parameters(model_params)

Prints the model parameters in the ModelParameters object.

This function prints a nicely formatted description of a ModelsParameters object.

Args:

model_params: a ModelParameters instance.

Raises:

ValueError: if grain_params in not a GrainParameters instance.

ashdisperse.interface.interface.print_output_parameters(output_params)

ashdisperse.interface.interface.print_physical_parameters(physical_params)

ashdisperse.interface.interface.print_solver_parameters(solver_params)

ashdisperse.interface.interface.print_source_parameters(source_params)

Print source parameters.

Args:

source_params (SourceParameters): A SourceParameters object

ashdisperse.interface.interface.save_inputs(params, met, filename='AshDisperse')

ashdisperse.interface.interface.set_emission_parameters(params_set, printout=True)

Set emission parameters for AshDisperse.

The Parameters class object stores the parameters required for the model. set_emission_parameters runs a series of command line inputs to initialize the EmissionParameters element of the Parameters object.

set_emission_parameters should be called after set_grain_parameters

Args:

params_set (Parameters): The Parameters object to initialize. printout (bool, optional): Print EmissionParameters after setup.

Returns:

params_set (Parameters): An updated Parameters object.

Raises:

ValueError: If ‘params_set’ is not a Parameters object.

If ‘params_set’ does not have a GrainParameters element. If user inputs a negative lower altitude. If user inputs a negative upper altitude. If user inputs a upper altitude < lower altitude. If user inputs a negative Suzuki_k. If user inputs a negative Suzuki_peak. If user inputs a Suzuki_peak < lower altitude. If user inputs a Suzuki_peak > upper altitude.

ashdisperse.interface.interface.set_grain_parameters(params_set, printout=True)

Set grain parameters for AshDisperse.

The Parameters class object stores the parameters required for the model. set_grain_parameters runs a series of command line inputs to initialize the GrainParameters element of the Parameters object.

Args:

params_set (Parameters): The Parameters object to initialize. printout (bool, optional): Print GrainParameters after setup.

Returns:

params_set (Parameters): An updated Parameters object.

Raises:

ValueError: If ‘params_set’ is not a Parameters object.

If user inputs a negative diameter. If user inputs a negative density. If user inputs a proportion outside of [0,1). If user inputs a proportion that is too large. If grain parameters are not valid according to validate()

method of GrainParameters.

ashdisperse.interface.interface.set_met(params_set, source='interface', **kwargs)

ashdisperse.interface.interface.set_met_parameters(params_set, met_set)

ashdisperse.interface.interface.set_model_parameters(params, met, square=False)

ashdisperse.interface.interface.set_output_parameters(params_set, printout=False)

Set output parameters for AshDisperse.

The Parameters class object stores the parameters required for the model. set_output_parameters runs a series of command line inputs to initialize the OutputParameters element of the Parameters object.

Args:

params_set (Parameters): The Parameters object to initialize. printout (bool, optional): Print GrainParameters after setup.

Returns:

params_set (Parameters): An updated Parameters object.

Raises:

ValueError: If ‘params_set’ is not a Parameters object

TODO (Mark): Add validation of parameters.

ashdisperse.interface.interface.set_parameters()

Interface to set Parameters for AshDisperse.

The Parameters class object stores the parameters required for the model. set_parameters runs a series of command line inputs to initialize the Parameters object.

Args:

None

Returns:

params_set (Parameters): A Parameters object.

ashdisperse.interface.interface.set_physical_parameters(params_set, printout=False)

Set physical parameters for AshDisperse.

The Parameters class object stores the parameters required for the model. set_physical_parameters runs a series of command line inputs to initialize the PhysicalParameters element of the Parameters object.

Args:

params_set (Parameters): The Parameters object to initialize. printout (bool, optional): Print GrainParameters after setup.

Returns:

params_set (Parameters): An updated Parameters object.

Raises:

ValueError: If ‘params_set’ is not a Parameters object

TODO (Mark): Add validation of parameters.

ashdisperse.interface.interface.set_solver_parameters(params_set, printout=False)

Set solver parameters for AshDisperse.

The Parameters class object stores the parameters required for the model. set_solver_parameters runs a series of command line inputs to initialize the SolverParameters element of the Parameters object.

Args:

params_set (Parameters): The Parameters object to initialize. printout (bool, optional): Print GrainParameters after setup.

Returns:

params_set (Parameters): An updated Parameters object.

Raises:

ValueError: If ‘params_set’ is not a Parameters object

TODO (Mark): Add validation of parameters.

ashdisperse.interface.interface.set_source_parameters(params_set)

Set source parameters for AshDisperse.

The Parameters class object stores the parameters required for the model. set_source_parameters runs a series of command line inputs to initialize the SourceParameters element of the Parameters object.

Args:

params_set (Parameters): The Parameters object to initialize.

Returns:

params_set (Parameters): An updated Parameters object.

Raises:

ValueError: If ‘params_set’ is not a Parameters object

Module contents