API Reference

Subpackages

• surface_apps.iso_surfaces package
  • Submodules
  • surface_apps.iso_surfaces.driver module
    • Driver
      • Driver.iso_surface()
      • Driver.make_surfaces()
  • surface_apps.iso_surfaces.params module
    • IsoSurfaceDetectionParameters
      • IsoSurfaceDetectionParameters.contours
      • IsoSurfaceDetectionParameters.fixed_contour_input_to_list_of_floats()
      • IsoSurfaceDetectionParameters.fixed_contours
      • IsoSurfaceDetectionParameters.interval_max
      • IsoSurfaceDetectionParameters.interval_min
      • IsoSurfaceDetectionParameters.intervals
      • IsoSurfaceDetectionParameters.max_distance
      • IsoSurfaceDetectionParameters.resolution
    • IsoSurfaceParameters
      • IsoSurfaceParameters.conda_environment
      • IsoSurfaceParameters.default_ui_json
      • IsoSurfaceParameters.detection
      • IsoSurfaceParameters.name
      • IsoSurfaceParameters.out_group
      • IsoSurfaceParameters.run_command
      • IsoSurfaceParameters.source
      • IsoSurfaceParameters.title
    • IsoSurfaceSourceParameters
      • IsoSurfaceSourceParameters.data
      • IsoSurfaceSourceParameters.horizon
      • IsoSurfaceSourceParameters.no_single_layer_grids()
      • IsoSurfaceSourceParameters.objects
  • surface_apps.iso_surfaces.utils module
    • block_model_to_grid()
    • entity_to_grid()
    • extract_iso_surfaces()
    • interp_to_grid()
    • remove_nan()
  • Module contents

Submodules

surface_apps.driver module

class surface_apps.driver.BaseSurfaceDriver(*args: Any, **kwargs: Any)

Bases: Driver

Driver for the surface application.

Parameters:

parameters – Application parameters.

add_ui_json(entity: ObjectBase | UIJsonGroup) → None

Add ui.json file to entity.

Parameters:

entity – Object to add ui.json file to.

abstractmethod make_surfaces()

property out_group: UIJsonGroup | None

Output container group.

property params: geoapps_utils.base.Options

Application parameters.

run()

Run the surface application driver.

store()

Update container group and monitoring directory.

Parameters:

surface – Surface to store.

Module contents

surface_apps.assets_path() → Path

Return the path to the assets folder.