Mondaic
This API reference is not for the latest stable Salvus version.

salvus.project.configuration.bathymetry

Classes

BathymetryConfiguration

class BathymetryConfiguration(
    salvus.flow.utils.serialization_helpers.SerializationMixin
):
    def __init__(self, bathymetry_models: Union[List[str], str]) -> None:
        ...

Create a bathymetry configuration.

A bathymetry configuration is a collection of bathymetry models which will be applied to a given mesh via a simulation configuration. The order in which bathymetry models are applied to a mesh is the order in which they appear in this configuration.

Parameters
  • bathymetry_models Union[List[str], str] — List of bathymetry models to be used.
Attributes
bathymetry_models List[str]

Get a list of the bathymetry models in this configuration.

Methods
from_json()
def from_json(d: Dict) -> Any:
    ...

Recreate the object from a dictionary serialization of its initialization parameters.

Parameters
  • d Dict — Dictionary containing its init parameters and a few other things.
Returns Any
to_json()
def to_json(self, external_file_hash: Optional[str] = None) -> Dict:
    ...

Serialize the object to dictionary that can be written to JSON.

Parameters
  • external_file_hash Optional[str] — Hash of any external files associated with this object. Can be passed here in which case it will be stored in a centralized location in the JSON file.
Returns Dict

Submodules