Cognite Seismic Python SDK Documentation

This is the Cognite Seismic Python SDK for developers and data scientists working with Cognite Seismic APIs.

Installation

To install this package:

pip install cognite-seismic-sdk

Contents

• Quickstart
  • Client setup and authentication
• API v0 (beta)
  • Client
  • Surveys
    • Register a survey
    • Edit a survey
    • Retrieve an survey by id or name
    • List all the surveys
    • Search for surveys
  • Types for bin grid to projected coordinates transformation
  • Files
    • Register a file
    • Ingest a file
    • Edit a file
    • Delete a file
    • Get a file
    • Get binary header
    • Get text header
    • Get file coverage
    • Get full SEGY file
    • Get SEGY file by inline and crossline ranges
    • Get SEGY file by an polygon
    • Get the line range of a file
    • Get the range of crosslines by a specific inline
    • Get the range of inlines by a specific crossline
  • Ingestion job status
    • Get the status of an ingestion job
  • Slice
    • Get slice by arbitrary line
  • Time/depth slice
    • Get a seismic slab along a horizon or constant depth bounded by inline and xline ranges
    • Get a horizontal slice for a given depth or time and constrained by an arbitrary 2D polygon
  • Trace
    • Get a trace from a specified inline and crossline position
    • Get a trace from a specified coordinate position
  • Volume
    • Get a volume of traces from a file
    • Get a cube of trace data from a specified geometry
    • Store a single trace to a temporary file
  • Deprecated Methods
    • Slice
      • Get slice by inline
      • Get slice by crossline
    • Volume
      • Get a cube of trace data from a specified inline and crossline square
• API v1 (beta)
  • Client
    • Creating a client
    • Generating OIDC tokens
  • Seismic Surveys
    • List surveys
    • Search surveys
    • Get one survey
    • Register a new survey
    • Edit a survey
    • Delete a survey
  • Seismic Query Objects
    • Create seismic objects
    • List seismic objects
    • Search seismic objects
    • Get seismic object
    • Edit seismic objects
    • Delete seismic objects
  • Seismic trace data access
    • Get traces in a seismic volume
    • Store traces into a numpy array
  • Seismic Store Objects
    • List seismic stores
    • Search seismic stores
    • Get seismic store
    • Edit seismic stores
  • Data Partitions
    • List data partitions
    • Search data partitions
    • Get data partition
    • Create a new data partition
    • Edit a data partition
    • Delete a data partition
  • SEG-Y download
    • Download seismic as SEG-Y
    • Download subvolume of seismic by line numbers as SEG-Y
    • Download partial seismic from geometry cutout as SEG-Y
  • File management
    • Register file
    • Get file
    • List files
    • Search files
  • API Data Types
    • Coordinate
    • RangeInclusive
    • Trace
    • IngestionSource
    • VolumeDef
    • File
    • Survey
    • SourceSegyFile
    • SegyOverrides
    • Geometry
    • BinaryHeader
    • TextHeader
    • SeismicStore
    • Seismic
    • Partition
• Error types
  • SeismicServiceError
  • NotFoundError
  • TransientError
  • InternalError
  • AuthenticationError
  • InvalidArgumentError
  • PermissionError
• Examples
  • API overview
    • Create Seismic API client
    • Register a survey
    • Retrieve a survey
      • Retrieve a survey by name
      • List all available surveys
    • Register a file
    • Retrieve a file
    • Ingest a file
    • Check ingest job status
    • Analyse file information
      • Get metadata / header information about a file
      • Download Segy file
      • Download Segy file by inline / crossline range
      • Download Segy file by Polygon coverage
      • Find minimum and maximum inline and crossline values for a file
      • Get all crosslines for an inline in a file
      • Get all inlines for a crossline in a file
    • Slices
      • Seismic slice by arbitrary line
    • Time / Depth Slice
      • Horizontal slice for given depth or time constrained by inline / crossline range
      • Horizontal slice for given depth or time constrained by Polygon coverage
    • Traces
      • Get a trace from specific inline and crossline position
      • Get a trace from specific coordinate position
    • Volume
      • Get entire volume
      • Get volume slice by inline range
      • Get volume slice by crossline
      • Get time slice volume
      • Get subvolume
      • Cube of trace data from a specified geometry
  • V1 API overview
    • Create Seismic API client
    • Surveys
      • Register a survey
      • Retrieve a survey
      • Retrieve a survey by name
      • List all available surveys
    • Files
      • Register a file
      • Retrieve a file
      • Ingest a file
      • Check ingest job status
    • SeismicStores
      • Listing
      • Get metadata/header information about a seismic store
      • Download Segy file
      • Download Segy file by inline / crossline range
      • Download Segy file by Polygon coverage
      • Find minimum and maximum inline and crossline values for a seismic store
      • Get all crosslines for an inline in a seismic store
      • Get all inlines for a crossline in a seismic store
    • Slices
      • Seismic slice by volume
      • Seismic slice by arbitrary line
      • Get a trace from specific coordinate position
    • Partitions
      • Creating a partition
      • Search partitions
      • Delete partitions
    • Seismics
      • Creating seismics
      • Searching seismics
      • Retrieving data from seismics
  • Migration guide
    • Concepts
      • v0 File -> v1 SeismicStore
      • v0 Survey -> v1 Survey
      • Seismic
      • Partition
      • Files
    • Querying
• Return types
• VolumeDef schema
  • Format of a VolumeDef object
    • JSON format
  • Descriptors
    • Range
    • List
  • Complete example
  • Using VolumeDefs
• The coverage algorithm
  • Coverage of seismic objects
  • How to retrieve coverage
  • Details on the coverage computation
    • Simplification
    • 3D Coverage algorithm
      • Tuning parameters
• Ingestion logs
  • Example output
• Storage tiers
  • Tier one
  • Tier two
  • Examples
• Changelog
  • [0.2.103] - 2022-07-07
  • [0.2.102] - 2022-05-13
    • Added
  • [0.2.101] - 2022-05-12
    • Changed
  • [0.2.100] - 2022-05-04
    • Fixed
  • [0.2.99] - 2022-05-03
    • Added
  • [0.2.98] - 2022-04-19
    • Changed
  • [0.2.97] - 2022-04-11
    • Fixed
  • [0.2.96] - 2022-03-18
    • Deprecated
  • [0.2.95] - 2022-03-29
    • Added
    • Changed
  • [0.2.94] - 2022-03-24
    • Fixed
  • [0.2.93] - 2022-03-16
    • Added
  • [0.2.92] - 2022-03-15
    • Added
  • [0.2.91] - 2022-03-14
    • Changed
  • [0.2.90] - 2022-02-07
    • Changed
  • [0.2.89] - 2022-02-04
    • Fixed
  • [0.2.88] - 2022-01-24
    • Changed
  • [0.2.87] - 2021-11-18
    • Added
    • Changed
  • [0.2.86] - 2021-11-29
    • Changed
  • [0.2.85] - 2021-10-28
    • Added
  • [0.2.84] - 2021-10-26
    • Fixed
  • [0.2.83] - 2021-10-01
    • Fixed
  • [0.2.82] - 2021-09-22
    • Fixed
  • [0.2.81] - 2021-09-07
    • Added
  • [0.2.80] - 2021-09-01
    • Added
  • [0.2.79] - 2021-08-23
    • Added
  • [0.2.78] - 2021-08-11
    • Changed
  • [0.2.77] - 2021-08-02
    • Added
  • [0.2.76] - 2021-07-13
    • Added
  • [0.2.75] - 2021-07-12
    • Fixed
  • [0.2.74] - 2021-07-12
    • Fixed
  • [0.2.73] - 2021-07-09
    • Changed
  • [0.2.72] - 2021-06-30
    • Added
  • [0.2.71] - 2021-06-29
    • Changed
  • [0.2.70] - 2021-06-22
    • Changed
  • [0.2.69] - 2021-05-28
    • Changed
  • [0.2.68] - 2021-06-04
    • Added
  • [0.2.67] - 2021-05-31
    • Changed
    • Fixed
  • [0.2.66] - 2021-05-25
    • Changed
    • Deprecated
  • [0.2.65] - 2021-05-20
    • Fixed
  • [0.2.64] - 2021-05-10
    • Fixed
  • [0.2.63] - 2021-05-06
    • Deprecated
  • [0.2.62] - 2021-05-04
    • Added
  • [0.2.61] - 2021-05-03
    • Fixed
  • [0.2.60] - 2021-04-29
    • Added
  • [0.2.59] - 2021-04-27
    • Added
  • [0.2.58] - 2021-04-19
    • Added
  • [0.2.57] - 2021-03-26
    • Fixed
  • [0.2.56] - 2021-03-24
    • Fixed
  • [0.2.55] - 2021-03-24
    • Changed
  • [0.2.54] - 2021-03-24
    • Changed
  • [0.2.53] - 2021-03-22
    • Added
  • [0.2.52] - 2021-03-12
    • Added
  • [0.2.51] - 2021-03-12
    • Changed
  • [0.2.43] - 2021-03-04
    • Fixed:
  • [0.2.41] - 2021-03-02
    • Changed
  • [0.2.40] - 2021-02-24
    • Removed
    • Added
    • Fixed
  • [0.2.39] - 2021-02-15
    • Changed
    • Fixed
  • [0.2.38] - 2021-02-05
    • Added
  • [0.2.37] - 2021-02-03
    • Added
    • Changed
  • [0.2.36] - 2021-01-21
    • Fixed
  • [0.2.35] - 2021-01-21
    • Added
  • [0.2.34] - 2020-01-20
    • Changed
    • Fixed
  • [0.2.33] - 2021-01-14
    • Fixed
  • [0.2.32] - 2021-01-15
    • Fixed
  • [0.2.31] - 2021-01-15
    • Added
  • [0.2.30] - 2021-01-14
    • Fixed
  • [0.2.29] - 2021-01-11
    • Added
  • [0.2.28] - 2021-01-04
    • Added
  • [0.2.27] - 2021-01-04
    • Changed
  • [0.2.26] - 2020-12-16
    • Added
  • [0.2.24] - 2020-12-08
    • Changed
  • [0.2.23] - 2020-12-07
    • Added
    • Changed
  • [0.2.18] - 2020-11-25
    • Added
  • [0.2.21] - 2020-11-25
    • Added: Tenant/project name
  • [0.2.4] - 2020-10-26
    • Changed
  • [0.2] - 2020-10-14
  • [0.1.26] - 2020-05-22
    • Changed
  • [0.1.18] - 2020-05-05
    • Changed
  • [0.1.17] - 2020-04-08
    • Changed
    • Added
  • [0.0.1] - 2019-02-15
    • Added