Quickstart

Step 1: Install Python 3

Follow the instructions in this file to setup your device.

macOS

Begin with installing Python3. If you're using a Mac, the easiest way to do this is by using Homebrew. Homebrew is a package manager for macOS that makes it easy to install software that you need.

  1. Open Terminal. You can do this by searching Terminal in Spotlight Search (Cmd+Space)
  2. Type brew -v. If you see the following pop up, skip to Step 6: Homebrew x.x.x. If you don't see this, continue to the next step.
  3. To install Homebrew, go to https://brew.sh/.
  4. Copy the first line under Install Homebrew. Paste it into Terminal, and hit Enter.
  5. Enter your password when prompted and wait for Homebrew to finish installing.
  6. Type brew install python3 in Terminal to install Python 3.
  7. Once installation is complete, run python --version. If you see Python 3.x.x, you're all set! If instead you see Python 2.x.x, run python3 --version – you will need to use the command python3 to run Python3 from now on.

Ubuntu

sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
sudo apt-get install python3.6 python3.6-dev
1
2
3

Upgrade pip

python3.6 -m pip install --upgrade pip`
1

Windows

Download and install the latest release from here: https://www.python.org/downloads/windows/

Step 2: Install the Cognite Python SDK

Now that you have Python 3 installed you can install the Cognite Python SDK. To do this type pip install cognite-sdk. You may need to use pip3 install cognite-sdk if you installed python3 with homebrew.

You can find the documentation for the SDK here.

Step 3: Generate API Key

To access the Cognite Data Platform you must get an API key. API keys will differ by project.

For now, let's obtain the API key for the publicdata project that is the basis of the first Jupyter tutorial.

To do this go to openindustrialdata.com. Click Access Platform and fill out the registration form. Once you're redirected to your page you can click Generate your API key. You should copy and store this key somewhere safe (such as LastPass).

Now, to run the the notebook go to Terminal and again navigate to the directory where the README file is. To run the Jupyter notebook with the relevant API Key, enter COGNITE_API_KEY=<your key here> jupyter notebook.

Software Development Kit

To make your experience working with the Cognite Data Platform easier, we offer several software development kits, or SDKs:

Last Updated: 11/12/2018, 9:22:06 AM