Information for the BKB Administrator

Getting started with BKB IT admin tasks

Access and IP address

Biomedical KB-HD is distributed through: https://my.qiagendigitalinsights.com/bbp/

For access, please contact BKB support: ts-bioinformatics@qiagen.com (IP address is needed for secured access)

Tools and DB types

Biomedical KB-HD includes:

  • R and Python packages for accessing Biomedical KB-HD
  • QIAGEN-hosted BKB-HD API backend

Depending on your license, it may also include:

  • Tab-separated values (TSV) files for relationships, entity descriptions, ontologies and hierarchies, source information and additional information like molecular functions
  • A prebuilt SQLite database file containing the above tables
  • A prebuilt Neo4j database
  • Scripts for importing the tables into a PostgreSQL or SQLite database

Environment

BKB-HD API is a QIAGEN-hosted SQL query service that provides access to BKB-HD through Python or R BKB-HD packages or directly through REST API.

BKB-HD API connection: The simplest way to get started is by using BKB-HD API. There are three ways to start your session. Python-based:
  1. Device code login kb = bkb.BKb.from_api()
  2. Browser-based login kb = bkb.BKb.from_api(device_code_flow=False)
  3. Direct username and password login (This option is not available for SSO-enabled accounts) kb = bkb.BKb.from_api(username='your_username', password='your_password')
R-based:
  1. Device code login bkb <- bkb::from_api()
  2. Browser-based login bkb <- bkb::from_api(device_code_flow=FALSE)
  3. Direct username and password login (This option is not available for SSO-enabled accounts) bkb <- bkb::from_api(username='your_username', password='your_password')

More resources:

System requirements

In general, memory and system requirements depends on the type of analysis performed. For standard queries using SQL or the R/Python packages, 16GB is sufficient, but some types of analysis (ex. using a full-graph, in-memory NetworkX export) may require more than 32GB of memory.

Python:

Python 3.9 or later is required. The system must have an SQLite version 3.8.3 or later.

The Python package provides wrapper functionality for the Biomedical KB-HD. The Python package can be downloaded to a local folder and installed as: pip3 install bkb-2025.1-py3-none-any.whl

To start using the package, you will need to connect to either BKB-HD API, an SQLite database or SQL DBMS (such as PostgreSQL).

R package:

R 4.1.0 or later is required. Additionally, the following packages must be present: 'dplyr', 'dbplyr', 'DBI', 'R6', 'assertthat', 'RSQLite', 'tibble', 'igraph', 'websocket', 'future.apply', 'readr', 'httr', 'fs', 'shiny', 'htmlwidgets' and 'uuid'

The 'bkb' R package provides convenience functions for working with the Biomedical KB-HD. To get started with the bkb R package, download the 'bkb_2025.1.tar.gz' file to your local machine.

Neo4j:

For the Neo4j export, Neo4j version 5.5 is the recommended version. We do not test earlier versions but expect them to be compatible (the Python graph export scripts support both Neo4j version 4 and version 5). The decompressed Neo4j files will take up ~5 GB, and after installation ~7 GB will be used.

SQLite:

The SQLite file is ~10GB compressed, and will decompress to ~50GB, which means at least 60 GB of disk space must be available for the decompression to succeed. SQLite for Causal Reasoning: For the causal reasoning functionality and notebooks, SQLite version 3.35.3 or later is required.

PostgreSQL:

The PostgreSQL import script has been tested on PostgreSQL 14.1 on Linux. It will take up at least 50 GB of disk space.

Key Resources

Our support team: ts-bioinformatics@qiagen.com

Contact them for scientific and technical support, including license activation questions and BKB access.

Sample to Insight
linkedin facebook pinterest youtube rss twitter instagram facebook-blank rss-blank linkedin-blank pinterest youtube twitter instagram
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.