Geostatistics Task API

Version: 0.0.2

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

Reference to the Geoscience Object containing the source points used for conditioning the simulation.

source_attributestring

Required

Examples: "example string", "another example"

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

neighborhoodNeighborhood

Required

Search neighborhood for conditioning.

anisotropyEllipsoid

Required

The ellipsoid, to search for points within

ellipsoid_rangesEllipsoid Ranges

Required

The ranges of the ellipsoid

majornumber

Required

Examples: 23.42893768505807, 24.798395530970964, 29.367797014890364, 35.86712007904666, 59.04798961774967

The major axis length of the ellipsoid

semi_majornumber

Required

Examples: 3.1664405537027984, 24.133902894558645, 66.01607411644424, 90.32421743131444, 98.13468858620787

The semi major axis length of the ellipsoid

minornumber

Required

Examples: 29.957537905170174, 43.06791371476946, 56.472145452632496, 87.60303317239814, 89.50283420464866

The minor axis length of the ellipsoid

rotationRotation

Required

The rotation of the ellipsoid

dip_azimuthnumber

Examples: 49.57025166304916, 84.02309081677619, 168.1438948949981, 219.09204944393724, 231.61528441477378

first rotation, about the z-axis, in degrees

dipnumber

Examples: 9.145763231395543, 19.95481552469866, 45.49151143660519, 60.13622813271782, 110.90742475619062

second rotation, about the x-axis, in degrees

pitchnumber

Examples: 113.52756349066578, 140.2778528927207, 287.9705244681351, 304.9260122034788, 318.07187067492356

third rotation, about the z-axis, in degrees

max-samplesinteger

Required

Examples: 27, 40, 64, 79, 99

The maximum number of samples to use for each evaluation point.

min-samplesinteger

Examples: 9, 72, 78, 83, 96

Default: 1

The minimum number of samples to use for each evaluation point.

distributionContinuousDistributionParameters | null

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.

kriging_method"simple" | "ordinary"

Default: "simple"

The kriging method to use for the conditioning step.

block_discretizationBlockDiscretization

Required

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

nxinteger

Required

Examples: 5, 6, 7, 8, 9

Number of subdivisions in the x direction

nyinteger

Required

Examples: 1, 4, 5, 6

Number of subdivisions in the y direction

nzinteger

Required

Examples: 2, 5, 6, 8, 9

Number of subdivisions in the z direction

number_of_linesinteger

Examples: 84, 272, 293, 487, 689

Default: 500

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

number_of_simulationsinteger

Examples: 13, 72, 75, 82, 89

Default: 1

Number of simulations to run.

random_seedinteger

Examples: 5, 25, 49, 75, 83

Default: 38239342

Random seed for simulation and tie-breaking.

number_of_simulations_to_saveinteger

Examples: 52, 78, 87, 88, 97

Default: 5

Number of simulations to publish to the output object.

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.

loss_calculationLossCalculationsSettings | null

location_wise_quantilesQuantile[]

Examples: [0.23025038605835924,0.6227867275060051,0.8744617416055689], [0.3543187004122633,0.7669955931382098,0.837590837748225]

List of quantiles to compute for each location.

perform_validationboolean

Examples: true, false

Whether to run validation and generate a validation report.

report_contextValidationReportContext | null

Context for the validation report.

Example body

{
  "source_object": "https://example.com",
  "source_attribute": "string",
  "neighborhood": {
    "anisotropy": {
      "ellipsoid_ranges": {
        "major": 0,
        "semi_major": 0,
        "minor": 0
      },
      "rotation": {
        "dip_azimuth": 0,
        "dip": 0,
        "pitch": 0
      }
    },
    "max-samples": 0,
    "min-samples": 1
  },
  "distribution": {
    "weights": "string",
    "tail_extrapolation": {
      "upper": {
        "power": 0,
        "max": 0
      },
      "lower": {
        "power": 0,
        "min": 0
      }
    }
  },
  "variogram_model": "https://example.com",
  "kriging_method": "simple",
  "block_discretization": {
    "nx": 0,
    "ny": 0,
    "nz": 0
  },
  "number_of_lines": 500,
  "number_of_simulations": 1,
  "random_seed": 38239342,
  "number_of_simulations_to_save": 5,
  "target_object": "https://example.com",
  "loss_calculation": {
    "material_categories": [
      {
        "cutoff_grade": 0,
        "metal_price": 0,
        "label": "string"
      }
    ],
    "processing_cost": 0,
    "mining_waste_cost": 0,
    "mining_ore_cost": 0,
    "metal_recovery_fraction": 0,
    "target_attribute": {
      "operation": "string",
      "name": "string"
    }
  },
  "location_wise_quantiles": [
    0
  ],
  "perform_validation": false,
  "report_context": {
    "title": "string",
    "details": [
      {
        "label": "string",
        "value": "string"
      }
    ]
  }
}

Responses

200

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

Response schema

targetTarget grid

The target grid with simulation results.

referenceuri

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

Reference to a geoscience object.

namestring

Examples: "Sample Name", "A name for the thing"

The name of the geoscience object.

descriptionstring | null

Examples: "This is a sample description. It describes a thing for which we need a description", "An example description, which could be quite long and detailed."

The description of the geoscience object.

schema_idstring

Examples: "123e4567-e89b-12d3-a456-426614174000", "987e6543-e21b-12d3-a456-426614174999"

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

Examples: "example string", "another example"

Reference to the attribute in the geoscience object.

namestring

Examples: "Sample Name", "A name for the thing"

The name of the output attribute.

varianceVariance

Attribute containing the variance of the simulations.

referencestring

Examples: "example string", "another example"

Reference to the attribute in the geoscience object.

namestring

Examples: "Sample Name", "A name for the thing"

The name of the output attribute.

minMinimum

Attribute containing the minimum of the simulations.

referencestring

Examples: "example string", "another example"

Reference to the attribute in the geoscience object.

namestring

Examples: "Sample Name", "A name for the thing"

The name of the output attribute.

maxMaximum

Attribute containing the maximum of the simulations.

referencestring

Examples: "example string", "another example"

Reference to the attribute in the geoscience object.

namestring

Examples: "Sample Name", "A name for the thing"

The name of the output attribute.

quantile_attributesQuantile[]

List of attributes containing quantiles of the simulation results.

referencestring

Examples: "example string", "another example"

Reference to the attribute in the geoscience object.

namestring

Examples: "Sample Name", "A name for the thing"

The name of the output attribute.

quantilenumber

Examples: 0.31385451453713464, 0.3961237930318512, 0.741294584164473, 0.8781839717708347, 0.997895768823258

Quantile of the simulations, that this attribute represents.

simulationsAttributeOutput_ContinuousEnsemble_V1_1_0_ | null

Attribute containing the simulation results.

simulations_normal_scoreAttributeOutput_ContinuousEnsemble_V1_1_0_ | null

Attribute containing the simulation results in normal score space.

point_simulationsAttributeOutput_ContinuousEnsemble_V1_1_0_ | null

Attribute containing the point simulation results.

point_simulations_normal_scoreAttributeOutput_ContinuousEnsemble_V1_1_0_ | null

Attribute containing the point simulation results in normal score space.

loss_calculation_attributeAttributeOutput_CategoryAttribute_V1_1_0_ | null

Attribute containing the loss calculation results.

validation_summaryValidationSummary | null

validation_reportFileOutput | null

Link to the validation report file.

linksLinks

Links related to the simulation task.

dashboarduri | null

(1, 2,083) chars

Link to the validation dashboard.

Example response

{
  "target": {
    "reference": "https://example.com",
    "name": "string",
    "description": "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
      }
    ],
    "simulations": {
      "reference": "string",
      "name": "string"
    },
    "simulations_normal_score": {
      "reference": "string",
      "name": "string"
    },
    "point_simulations": {
      "reference": "string",
      "name": "string"
    },
    "point_simulations_normal_score": {
      "reference": "string",
      "name": "string"
    },
    "loss_calculation_attribute": {
      "reference": "string",
      "name": "string"
    }
  },
  "validation_summary": {
    "reference_mean": 0,
    "mean": 0
  },
  "validation_report": {
    "reference": "https://example.com",
    "name": "string"
  },
  "links": {
    "dashboard": "https://example.com"
  }
}

303

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