README.md

Cognite Python Documentation

Overview

Here you can find documentation and examples for anything Python related on top of Cognite Data Fusion.

• Python Documentation

You may also want to take a look at the documentation for the the API

• API Reference
• API Guide

Examples

Basics

A collection of simple examples to get you started with CDF.

Model Hosting

A collection of Jupyter notebooks showing how to use the model hosting environment.

Prerequisites

In order to start using these examples, you need to set up the following

Install Python

Here are instructions for installing Python on your system:

• macOs

Set Environment Variables

An API key in the COGNITE_API_KEY environment variable.

You can set the environment variable on macOs or Linux like this

$ export COGNITE_API_KEY=<YOUR-API-KEY>

On Windows, you can follows these instructions.

Install Dependencies

You need to install the dependencies required to run through the examples. You can do this using pip (requirements.txt) or pipenv.

Using requirements.txt

$ pip install -r requirements.txt

Using Pipenv

$ pipenv shell
$ pipenv sync --dev