Mondaic DocumentationRequired
name| Type: | str |
| Description: | Name of the topography. |
Version:
2026.5.0
Salvus documentation version
2026.5.0
2025.1.3
2024.1.3
0.12.16
No results found.
salvus.project.configuration.topography.spherical
salvus.project.configuration.topography.spherical salvus project configuration topography sphericalSpherical topography.
Classes
MohoTopography
Spherical topography.
SIGNATURE
class MohoTopography(
salvus.project.configuration.topography.spherical._SphericalBase
):
def __init__(
self, name: str, data: pathlib.Path | str, use_symlink: bool = False
): ...ARGUMENTS
Required
data| Type: | pathlib.Path | str |
| Description: | Filename with the data. |
Optional
use_symlink| Type: | bool |
| Default value: | False |
| Description: | Don't copy the data to the project but only symlink it. The downside of symlinking is that the project is no longer fully self-contained. The upside is that very large external files that could be used for multiple projects don't get copied. |
Properties
- coordinates(
np.ndarray | tuple[np.ndarray, np.ndarray])-Coordinates of the data values. - ds(
xr.Dataset)-The actual dataset representing the model. - name(
str)-Name of the topography configuration. - no_deformation_below(
float | None)-Don't deform below this value. - reference_elevation(
float)-Reference elevation height. - relative_elevation_model(
np.ndarray)-Relative elevation model.
Class Methods
MohoTopography.from_json()
Recreate the object from a dictionary serialization of its
initialization parameters.
SIGNATURE
def from_json(parent_folder: pathlib.Path, d: dict) -> _ModelBase: ...ARGUMENTS
Required
parent_folder| Type: | pathlib.Path |
| Description: | Path to which the serialized model is relative to. |
Required
d| Type: | dict |
| Description: | Dictionary containing its init parameters and a few other things. |
Methods
MohoTopography.to_json()
Serialize the model to JSON (and an associated NetCDF file).
SIGNATURE
def to_json(self, parent_folder: pathlib.Path | str) -> dict: ...ARGUMENTS
Required
parent_folder| Type: | pathlib.Path | str |
| Description: | Parent folder where the JSON + NetCDF files should be stored. |
SurfaceTopography
Spherical topography.
SIGNATURE
class SurfaceTopography(
salvus.project.configuration.topography.spherical._SphericalBase
):
def __init__(
self, name: str, data: pathlib.Path | str, use_symlink: bool = False
): ...ARGUMENTS
Required
name| Type: | str |
| Description: | Name of the topography. |
Required
data| Type: | pathlib.Path | str |
| Description: | Filename with the data. |
Optional
use_symlink| Type: | bool |
| Default value: | False |
| Description: | Don't copy the data to the project but only symlink it. The downside of symlinking is that the project is no longer fully self-contained. The upside is that very large external files that could be used for multiple projects don't get copied. |
Properties
- coordinates(
np.ndarray | tuple[np.ndarray, np.ndarray])-Coordinates of the data values. - ds(
xr.Dataset)-The actual dataset representing the model. - name(
str)-Name of the topography configuration. - no_deformation_below(
float | None)-Don't deform below this value. - reference_elevation(
float)-Reference elevation height. - relative_elevation_model(
np.ndarray)-Relative elevation model.
Class Methods
SurfaceTopography.from_json()
Recreate the object from a dictionary serialization of its
initialization parameters.
SIGNATURE
def from_json(parent_folder: pathlib.Path, d: dict) -> _ModelBase: ...ARGUMENTS
Required
parent_folder| Type: | pathlib.Path |
| Description: | Path to which the serialized model is relative to. |
Required
d| Type: | dict |
| Description: | Dictionary containing its init parameters and a few other things. |
Methods
SurfaceTopography.to_json()
Serialize the model to JSON (and an associated NetCDF file).
SIGNATURE
def to_json(self, parent_folder: pathlib.Path | str) -> dict: ...ARGUMENTS
Required
parent_folder| Type: | pathlib.Path | str |
| Description: | Parent folder where the JSON + NetCDF files should be stored. |
Used in tutorials
Functionality from this module is used in the following tutorials.
We use cookies to analyze our traffic, but won't track you until explicit consent is given. Using our contact form will create relevant cookies and transmit data to third party services to keep track of your request. Read more about how we use personal information in our Privacy Policy.
PAGE CONTENTS