Installation Guide

This page explains the installation of the Python 3 package kgw and its optional dependencies.

Required: kgw

The package kgw is available on the Python Package Index (PyPI) and therefore can be easily installed with Python’s default package manager pip by using the following command in a shell:

$ pip install kgw

Additional remarks:

  • kgw is compatible with Python 3.6 upwards.

  • Using an environment manager like virtualenv or conda is a good idea in almost any case. These tools allow to create a virtual environment into which pip can install the package in an isolated fashion instead of globally on your system. Thereby it does not interfere with the installation of other projects, which may require a different version of some shared dependency.

Optional: docker

Currently the project “Clinical Knowledge Graph (CKG)” requires a Docker installation, because its data comes in a format that requires a particular Neo4j installation with some quite specific addons and configurations that can be best handled with a reproducible system setup inside a Docker image.

Two installations steps are required:

  1. Install the Docker program according to the official instructions for your operating system.

  2. Install the Docker SDK for Python with Python’s default package manager pip:

    $ pip install docker