resdk 22.2.0

Resolwe SDK for Python

Resolwe SDK for Python supports interaction with Resolwe server and its extension Resolwe Bioinformatics. You can use it to upload and inspect biomedical data sets, contribute annotations, run analysis, and write pipelines.

Docs & Help

Read the detailed description in documentation.

Install

Install from PyPI:

pip install resdk

If you would like to contribute to the SDK codebase, follow the installation steps for developers.

Note

If you are using Apple silicon you should use Python version 3.10 or higher.

Quick Start

In this showcase we will download the aligned reads and their index (BAM and BAI) from the server:

import resdk

# Create a Resolwe object to interact with the server
res = resdk.Resolwe(url='https://app.genialis.com')

# Enable verbose logging to standard output
resdk.start_logging()

# Get sample meta-data from the server
sample = res.sample.get('resdk-example')

# Download files associated with the sample
sample.download()

Both files (BAM and BAI) have downloaded to the working directory. Check them out. To learn more about the Resolwe SDK continue with Getting started.

If you do not have access to the Resolwe server, contact us at [e-mail].