Skip to content

Linux & Mac

Pre-requisites and requirements

The KICS command line tool has the following requirements:

  • Ubuntu 18.04+ / MacOS X 10.11+ (or higher)
  • Docker 19.03.5+
  • Python 3.7+ (64bit)

If your machine already meets these requirements, you may skip the next two steps and proceed to the the virtual environment step.

Install Docker

Kelvin SDK, as part of KICS, leverages Docker to package and run applications as containers.
Kelvin SDK requires Docker 19.03+.

To install Docker on your local machine:

Users in Linux-based systems

Linux-based systems, such as Ubuntu, may require post installation steps, such as user and group permissions configuration.

Additional information can be found here.

Install Python

Kelvin SDK requires a 64bit version of Python 3.7+.

To download Python on your local machine:

In addition, several non-official (reliable) sources exist to help with OS-specific installations:

Kelvin SDK makes use of the built-in python package manager, pip, which should be installed with your Python package. If it is not, see the Python Packaging Authority guide on pip's installation.

Update pip with the latest version

python3 -m pip install pip -U

Virtualenv

Python virtual environments (per project) are strongly recommended.
This way, it is possible to avoid dependency incompatibility issues between python packages that may lead to erroneous behaviour.
The following commands will guide you through the installation and activation of a dedicated virtual environment.

Install virtualenv

pip3 install virtualenv

Create the virtual environment with virtualenv

Create a virtualenv name venv

virtualenv venv -p python3.7

Activate the virtual environment

Once created, activate the virtual environment. While the virtual environment is active, installed dependencies become isolated from other projects/system. 

source venv/bin/activate

Check virtualenv installed dependencies

(venv)$ pip3 list

Package    Version
---------- -------
pip        21.2.4
setuptools 50.3.2
wheel      0.35.1

Install KICS

The Kelvin SDK command-line tools are available as a Python package on pypi.org.

To install this package:

(venv)$ pip3 install kics==3.8.*

Check the KICS version

(venv)$ kics --version

KICS version: 3.8.0

Component versions:

    kelvin-sdk  6.2.0