Virtual Environment

Before you get started, it is important to set up your environment.

Pre-requisites

In order to use the SDLabs and Nexus SDK the following pre-requisites are recommended:

• Python 3.9 or above installed
• Knowledge about standard Python types and libraries. See some tutorials below:
  • learnpython.org
  • docs.python-guide.org
• Knowledge about pip
• Knowledge about virtual environments. See some tutorials below:
  • virtualenv tutorial
  • conda tutorial

Virtual Environment Creation

It is recommended to always use a virtual environment to install the Scientia and Nexus SDKs, since it will isolate your installation and ensure there is no dependency conflicts with third party packages and versions. The following alternatives show two ways of creating and activating a virtual environment called atinary_sdk:

Warning

These are only compatible with Linux/Mac OS. For Windows, please refer to virtualenv tutorial

Using venv

# Create a virtual environment 
python3 -m venv atinary_sdk
# where the last argument is the environment name, which is often "venv" by convention: `python3 -m venv venv`

# Activate the environment
source atinary_sdk/bin/activate 
# or: `source venv/bin/activate` depending on the chosen venv name.

Using conda

Download, install conda (docs) and create a new environment.

conda create --name atinary_sdk

conda activate atinary_sdk

Ensure that you see (atinary_sdk) in your terminal, which signals that the virtual environment with name atinary_sdk has been created and is active.