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
  • Key concepts
• API
  • Client
    • Creating a client
    • Generating OIDC tokens
  • Seismic Surveys
    • Create a new survey
    • List all surveys
    • Search for surveys
    • Get one survey
    • Edit a survey
    • Delete a survey
  • File management
    • Register file
    • Ingest file
    • Get file
    • List all files
    • Search for files
    • Edit file
    • Unregister file
  • Ingestion job status
    • Get the status of an ingestion job
  • Seismic Store Objects
    • List all seismic stores
    • Search for seismic stores
    • Get seismic store
    • Edit seismic stores
    • Delete seismic stores
  • Data Partitions
    • List all data partitions
    • Search for data partitions
    • Get data partition
    • Create a new data partition
    • Edit a data partition
    • Delete a data partition
  • Seismic Query Objects
    • Create seismic objects
    • List all seismic objects
    • Search for seismic objects
    • Get seismic object
    • Edit seismic objects
    • Delete seismic objects
  • Seismic trace data access
    • Stream traces from a seismic object
    • Download seismic objects as a segy file
    • Estimate how much data would be downloaded
    • Store traces into a numpy array
  • API Data Types
    • Coordinate
    • Trace
    • IngestionSource
    • Seismic data type
    • Trace Extents
      • 2D extents
      • 3D extents
      • Pre-stack extents
    • Cutout specifications
    • Types for bin grid to projected coordinates transformation
    • SourceSegyFile
    • SegyOverrides
    • Survey
    • Geometry
    • BinaryHeader
    • TextHeader
    • SeismicStore
    • Seismic
    • Partition
    • IngestionJob
    • SearchSpecBase
    • SearchSpecSurvey
    • SearchSpecSeismicStore
    • SearchSpecFile
    • SearchSeismic
    • SearchSpecPartition
    • SearchSpecGetAll
    • SearchSpecLastModified
• Error types
  • SeismicServiceError
  • NotFoundError
  • TransientError
  • InternalError
  • AuthenticationError
  • InvalidArgumentError
  • PermissionError
• Examples
  • API overview
    • Create Seismic API client
    • Surveys
      • Create a survey
      • Retrieve a survey
      • Retrieve a survey by name
      • List all available surveys
    • Files
      • Register a file
      • Retrieve a file
      • Ingest a file
      • Ingestion job status
    • Seismic Stores
      • Listing
      • Searching for seismic stores
      • Get metadata/header information about a seismic store
      • Seismicstore Coverage
      • Describe the range of traces contained in the seismic store
      • Download Segy file
      • Download Segy file by inline / crossline range
      • Download a 2D Segy file by CDP filter
      • Download Segy file by Polygon filter
    • Slices
      • Seismic slice by volume
    • Partitions
      • Creating a partition
      • Search partitions
      • Delete partitions
    • Seismics
      • Creating seismics
      • Searching seismics
      • Retrieving data from seismics
  • v0 to v1 migration guide
    • Concepts
      • v0 File -> v1 SeismicStore
      • v0 Survey -> v1 Survey
      • Seismic
      • Partition
    • Migrating
      • Register and retrieve a survey
      • Files
    • Querying
    • Deprecation
      • File query APIs
  • SDK 0.2 to 0.3 migration guide
    • Overview
      • Search changes
      • Identifier changes
      • Seismic 2D support
      • VolumeDef retired
    • Endpoint-by-endpoint guide
      • Client setup
      • Survey
      • Files
      • Partitions
      • Seismic stores
      • Seismics
      • Trace data
• Return types
• The coverage algorithm
  • Coverage of seismic objects
  • How to retrieve coverage
  • Details on the coverage computation
    • Simplification
    • 2D Coverage algorithm
    • 3D Coverage algorithm
      • Tuning parameters
• Ingestion
  • Source Format
  • Prerequisites
  • Configuration
    • Offsets
    • Scalars
  • Ingestion Errors
  • Troubleshooting
    • Incorrect Geometry Coordinates
    • Incorrect Geometry Scale
    • Duplicate Inline/Crossline/CDP values
    • CDP X/Y coordinates out of range
    • No Traces/Samples found
    • Incorrect Sample Data
  • Ingestion logs
    • Example output
• Storage tiers
  • Tier one
  • Tier two
  • Examples
• FAQ
  • Where is the data moved to when a file is ingested?
  • Do updates to a registered file change the ingested file?
  • How do permissions work?
  • How is access to blob storage handled?
  • How are storage tiers configured?
  • How do I search for objects?
• Changelog
  • [0.3.21] - 2023-07-13
    • Fixed
  • [0.3.20] - 2023-08-22
    • Fixed
  • [0.3.19] - 2023-04-21
    • Added
  • [0.3.18] - 2023-03-22
    • Fixed
  • [0.3.17] - 2023-03-20
    • Changed
  • [0.3.16] - 2023-03-01
    • Changed
  • [0.3.15] - 2023-02-27
    • Added
  • [0.3.14] - 2023-01-25
    • Added
  • [0.3.13] - 2022-11-11
    • Added
  • [0.3.12] - 2022-11-04
    • Changed
  • [0.3.11] - 2022-10-14
    • Changed
  • [0.3.10] - 2022-09-30
    • Changed
  • [0.3.9] - 2022-09-08
    • Fixed
  • [0.3.8] - 2022-09-05
    • Fixed
  • [0.3.7] - 2022-08-11
    • Added
  • [0.3.6] - 2022-08-05
    • Added
  • [0.3.5] - 2022-08-01
    • Added
  • [0.3.4] - 2022-07-29
    • Fixed
  • [0.3.3] - 2022-07-22
    • Added
  • [0.3.2] - 2022-07-18
    • Added
  • [0.3.1] - 2022-07-11
    • Added
  • [0.3.0] - 2022-07-07
    • Added
    • Changed
    • Removed
  • [0.2.103] - 2022-07-07
    • Added
  • [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