Geostatistics Task API

Version: 0.1.9

Conditional simulation workflow

POST

/compute/orgs/{org_id}/geostatistics/consim

For more information, please read the guide

Request

Path parameters

org_iduuid

Required

The organisation identifier

Body parameters

source_objecturi

Required

Example: "/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/{object_id}"

Reference to the Geoscience Object containing the source points used for conditioning the simulation. Supported schemas: pointset/[>=1.2,<2]

source_attributestring

Required

Examples: "name_of_an_attribute", "an_attribute", "an_example_attribute_name"

Reference to the attribute containing the source values. The values are transformed to normal-score space using the provided distribution.

target_objecturi

Required

Example: "/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/{object_id}"

Reference to the Geoscience Object containing the grid to evaluate the simulation onto. A new attribute will be created on this object. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2]

neighborhoodNeighborhood

Required

Examples: {"key":"value"}, {"another_key":123}

Search neighborhood for conditioning.

ellipsoidEllipsoid

Required

The ellipsoid, to search for points within Alias: anisotropy

ellipsoid_rangesEllipsoid Ranges

Required

The ranges of the ellipsoid

majornumber

Required

The major axis length of the ellipsoid

semi_majornumber

Required

The semi major axis length of the ellipsoid

minornumber

Required

The minor axis length of the ellipsoid

rotationRotation

Required

The rotation of the ellipsoid

dip_azimuthnumber

first rotation, about the z-axis, in degrees

dipnumber

second rotation, about the x-axis, in degrees

pitchnumber

third rotation, about the z-axis, in degrees

max_samplesinteger

Required

The maximum number of samples to use for each evaluation point. Alias: max-samples

min_samplesinteger

Default: 1

The minimum number of samples to use for each evaluation point. Alias: min-samples

distributionobject | null

Parameters for a continuous distribution used for normal-score transformation.

weightsstring | null

Optional weights attribute for weighted distribution

tail_extrapolationobject | null

Required

Tail extrapolation

upperUpper tail extrapolation

Required

Power model for extrapolating the upper tail of the distribution.

powernumber

Required

Denominator of the exponent for the power model (between 0 exclusive and 1 inclusive).

maxnumber

Required

Maximum extent of tail, must be greater than the maximum value in the data.

lowerobject | null

Required

Power model for extrapolating the lower tail of the distribution. Optional.

powernumber

Required

Denominator of the exponent for the power model (between 0 exclusive and 1 inclusive).

minnumber

Required

Minimum extent of tail, must be less than the minimum value in the data.

variogram_modeluri

Required

Example: "/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/{object_id}"

Reference to the variogram model used to model the covariance within the domain. Supported schemas: variogram/[>=1.1,<2]

kriging_method"simple" | "ordinary"

Default: "simple"

The kriging method to use for the conditioning step.

block_discretizationBlockDiscretization

Required

Examples: {"key":"value"}, {"another_key":123}

Sub-block discretization used for support correction within each grid block.

nxinteger

Default: 1

Number of subdivisions in the x direction

nyinteger

Default: 1

Number of subdivisions in the y direction

nzinteger

Default: 1

Number of subdivisions in the z direction

number_of_linesinteger

Examples: 274, 550, 699, 769, 907

Default: 500

Number of lines to use for the turning-band simulation.

number_of_simulationsinteger

Examples: 15, 38, 44, 83, 99

Default: 1

Number of simulations to run.

random_seedinteger

Examples: 0, 20, 55, 58, 92

Default: 38239342

Random seed for simulation and tie-breaking.

number_of_simulations_to_saveinteger

Examples: 22, 33, 64, 92, 97

Default: 5

Number of simulations to publish to the output object. If perform_validation is true, the minimum value must be at least 1.

loss_calculationobject | null

Settings for loss calculations.

material_categoriesConSimMaterialCategory[]

Required

Ordered list of material categories, from lowest to highest cutoff grade

cutoff_gradenumber

Cutoff grade for the category

metal_pricenumber

Price of the metal per unit

labelstring

Label for the material category

processing_costnumber

Required

Processing cost per unit of material

mining_waste_costnumber

Required

Mining cost per unit of waste material

mining_ore_costnumber

Required

Mining cost per unit of ore material

metal_recovery_fractionnumber

Required

Fraction of metal expected to be recovered during processing

target_attribute |

Required

The target attribute that will be created or updated with loss calculation results.

One of:

object

operationunknown

Required

The operation to perform on the attribute.

namestring

Required

The name of the attribute to create.

object

operationunknown

Required

The operation to perform on the attribute.

referencestring

Required

Reference to an existing attribute to update.

location_wise_quantilesQuantile[]

Examples: [0.10641082279770497,0.5076816746043252,0.6253001935664175], [0.19891110176473303,0.5076628819776342,0.8416693481724671]

List of quantiles to compute for each location.

perform_validationboolean

Examples: true, false

Whether to run validation and generate a validation report.

report_contextobject | null

Context for the validation report.

titlestring

Required

Title that will appear on the report.

detailsValidationReportContextItem[]

Required

Key-value pairs of details to appear on the report.

labelstring

Label of the context item, which will appear on the report.

valuestring

Value of the context item.

report_mean_thresholdsobject | null

Thresholds for the mean comparison in the validation report.

acceptablenumber

Required

Threshold for the percentage difference between the reference and simulated means that is considered acceptable.

marginalnumber

Required

Threshold for the percentage difference between the reference and simulated means that is considered marginal.

Example body

{
  "source_object": "https://example.com",
  "source_attribute": "string",
  "target_object": "https://example.com",
  "neighborhood": {
    "ellipsoid": {
      "ellipsoid_ranges": {
        "major": 0,
        "semi_major": 0,
        "minor": 0
      },
      "rotation": {
        "dip_azimuth": 0,
        "dip": 0,
        "pitch": 0
      }
    },
    "max_samples": 0,
    "min_samples": 1
  },
  "variogram_model": "https://example.com",
  "block_discretization": {
    "nx": 1,
    "ny": 1,
    "nz": 1
  },
  "number_of_lines": 500,
  "number_of_simulations": 1,
  "random_seed": 38239342,
  "number_of_simulations_to_save": 5,
  "location_wise_quantiles": [
    0
  ],
  "perform_validation": false
}

Responses

200

The task result returned by the Compute API Result endpoint when the task is done

Response schema

targetTarget grid

Examples: {"key":"value"}, {"another_key":123}

The target grid with simulation results.

referenceuri

Reference to a geoscience object. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2]

namestring

The name of the geoscience object.

descriptionstring | null

The description of the geoscience object.

schema_idstring

The ID of the Geoscience Object schema.

summary_attributesSummary statistics

Attribute containing summary statistics of the simulation results.

meanMean

Attribute containing the mean of the simulations.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

varianceVariance

Attribute containing the variance of the simulations.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

minMinimum

Attribute containing the minimum of the simulations.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

maxMaximum

Attribute containing the maximum of the simulations.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

quantile_attributesQuantile[]

List of attributes containing quantiles of the simulation results.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

quantilenumber

Quantile of the simulations, that this attribute represents.

simulationsobject | null

Attribute containing the simulation results.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

simulations_normal_scoreobject | null

Attribute containing the simulation results in normal score space.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

point_simulationsobject | null

Attribute containing the point simulation results.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

point_simulations_normal_scoreobject | null

Attribute containing the point simulation results in normal score space.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

loss_calculation_attributeobject | null

Attribute containing the loss calculation results.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

validation_summaryobject | null

Summary of the validation results.

reference_meannumber

Mean of the input values.

meannumber

Mean of the simulated values.

validation_reportobject | null

Link to the validation report file.

referenceuri

Reference to a file.

namestring

The name of the file, typically the terminal segment of the path.

linksLinks

Examples: {"key":"value"}, {"another_key":123}

Links related to the simulation task.

dashboarduri

(1, 2,083) chars

Link to the validation dashboard.

Example response

{
  "target": {
    "reference": "https://example.com",
    "name": "string",
    "schema_id": "string",
    "summary_attributes": {
      "mean": {
        "reference": "string",
        "name": "string"
      },
      "variance": {
        "reference": "string",
        "name": "string"
      },
      "min": {
        "reference": "string",
        "name": "string"
      },
      "max": {
        "reference": "string",
        "name": "string"
      }
    },
    "quantile_attributes": [
      {
        "reference": "string",
        "name": "string",
        "quantile": 0
      }
    ]
  },
  "links": {}
}

303

303 response, see Compute API Execute Task documentation for more details