Simulation report

Preview API

This endpoint is marked as a preview API. Preview APIs may be unstable within the preview period: they may change without notice. You must set the header API-Preview: opt-in to opt into using this endpoint.

The simulation report task is designed to run right after the conditional simulation task. It looks at your simulation results and writes a file with charts and tables that help you interpret them. This task also gives you a link to the simulation validation dashboard, where you can visualize the report.

Parameters

• simulation_parameters (object)
  • All the parameters you sent to the conditional-simulation task.

  •   {
          "composites": {
              "type": "geoscience-object-reference",
              "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-pointset.json",
              "object_element": [
                  {
                      "type": "element",
                      "path": "/locations/attributes/@name=my-data",
                  },
              ],
          },
          "target": {
              "type": "geoscience-object-reference",
              "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-grid.json",
              "object_element": [
                  {
                      "type": "element",
                      "path": "/cell_attributes/@name=my-simulation",
                  },
              ],
          },
          "distribution": {
              "type": "geoscience-object-reference",
              "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-distribution.json",
          },
          "variogram_model": {
              "type": "geoscience-object-reference",
              "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-variogram.json",
          },
          "search_neighborhood": {
              "max-samples": 40,
              "anisotropy": {
                  "ellipsoid_ranges": {
                      "major": 70,
                      "semi_major": 70,
                      "minor": 5,
                  },
                  "rotation": {
                      "dip_azimuth": 0,
                      "dip": 0,
                      "pitch": 0,
                  },
              },
          },
          "block_discretization": {
              "nx": 1,
              "ny": 1,
              "nz": 1,
          },
          "number_of_lines": 500,
          "random_seed": 123,
          "n_sim": 10,
          "kriging_method": "simple",
          "variogram_reproduction": true,
          "normalize_variogram_model": true,
      }
• target (URL)
  • A File URL. The task will save your report here. This isn't a file that already exists. The task will make it.

Example

Request

requests.post(
    "https://{hub}.api.seequent.com/compute/orgs/{org_id}/geostat/simulation-report",
    headers={"Authorization": "Bearer {token}"},
    json={
        "parameters": {
            "simulation_parameters": {
                "composites": {
                    "type": "geoscience-object-reference",
                    "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-pointset.json",
                    "object_element": [
                        {
                            "type": "element",
                            "path": "/locations/attributes/@name=my-data",
                        },
                    ],
                },
                "target": {
                    "type": "geoscience-object-reference",
                    "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-grid.json",
                    "object_element": [
                        {
                            "type": "element",
                            "path": "/cell_attributes/@name=my-simulation",
                        },
                    ],
                },
                "distribution": {
                    "type": "geoscience-object-reference",
                    "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-distribution.json",
                },
                "variogram_model": {
                    "type": "geoscience-object-reference",
                    "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-variogram.json",
                },
                "search_neighborhood": {
                    "max-samples": 40,
                    "anisotropy": {
                        "ellipsoid_ranges": {
                            "major": 70,
                            "semi_major": 70,
                            "minor": 5,
                        },
                        "rotation": {
                            "dip_azimuth": 0,
                            "dip": 0,
                            "pitch": 0,
                        },
                    },
                },
                "block_discretization": {
                    "nx": 1,
                    "ny": 1,
                    "nz": 1,
                },
                "number_of_lines": 500,
                "random_seed": 123,
                "n_sim": 10,
                "kriging_method": "simple",
                "variogram_reproduction": True,
                "normalize_variogram_model": True,
            },
            "target": "https://{hub}.api.seequent.com/file/v2/orgs/{org_id}/workspaces/{workspace_id}/files/path/my-report.json",
        },
    },
)

Result

{
    "message": "Success",
    "links": {
        "report": "https://{hub}.api.seequent.com/file/v2/orgs/{org_id}/workspaces/{workspace_id}/files/path/my-report.json",
        "dashboard": "https://simval.seequent.com/orgs/{org_id}/workspaces/{hub}/{workspace_id}/reports/{report_id}/original",
    }
}