Clients Overview
There are two main ways to use GeneBe tools:
- A Python library called
pygenebe
- A Java command-line app called
genebe-cli
Both are open source and available on GitHub:
pygenebe (Python library)
pygenebe
is a Python package available on PyPI — you can install it using:
pip install pygenebe
It is designed to be used as a library inside Python scripts or notebooks.
Key features:
- Works well with
pandas
DataFrames - Can annotate genetic variants in many formats
- Supports variant conversion between multiple representations
- Ideal for programmatic access and integration into data analysis pipelines
genebe-cli (Java command-line tool)
genebe-cli
is a standalone command-line application written in Java.
You can use it to:
- Annotate VCF files
- It is the main client of the GeneBe Hub: create and work with variant annotation databases
To get started, download it from the GitHub releases page.
Both tools are under active development and designed to help you annotate and manage variant data easily and flexibly.
Find out information about installation and features of the clients in this chapter or go straight to Tutorials to find usage examples.