semvec/pypi-packages huggingface dataset:
cognite-seismic-sdk 0.1.1
A wrapper for the Seismic Datastore API offered by Cognite
License: Apache
Requires Python: >=3.6

<a href="https://cognite.com/">
    <img src="https://cognite.com/css/Images/CogniteLogo.svg" alt="Cognite logo" title="Cognite" align="right" height="80" />
</a>


# Cognite Seismic Python SDK

[![build](https://webhooks.dev.cognite.ai/build/buildStatus/icon?job=github-builds/cognite-seismic-sdk/master)](https://jenkins.cognite.ai/job/github-builds/job/cognite-seismic-sdk/job/master/)
[![codecov](https://codecov.io/gh/cognitedata/cognite-seismic-sdk/branch/master/graph/badge.svg?token=X4MwYkeMuW)](https://codecov.io/gh/cognitedata/cognite-seismic-sdk)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

A Python SDK for the Seismic data store API.

## Prerequisites
In order to start using the Python SDK, you need
- Python3 (>= 3.6) and `pip`
- An API key. Never include the API key directly in the code or upload the key to github. Instead, set the API key as an environment variable. See the usage example for how to authenticate with the API key.

This is how you set the API key as an environment variable on Mac OS and Linux:
```bash
$ export COGNITE_API_KEY=<your API key>
```

On Windows, you can follows [these instructions](https://www.computerhope.com/issues/ch000549.htm) to set the API key as an environment variable.

## Installation
To install this package:

```bash
$ pip install cognite-seismic-sdk
```