Fast visualization of genomic data
Project description
Genomeshader is a Rust-backed Python library for rapid visualization of read-level data spanning variants across huge numbers of samples. It is intended for use within Jupyter notebooks.
Documentation for the API can be found on the documentation page.
Prerequisites
Genomeshader is designed to access local files or data in Google Cloud Storage (GCS). Within certain cloud-computing environments (i.e. Terra, All of Us Researcher Workbench), access to GCS is already configured. For accessing files in GCS on your local machine, you will also need to install the Google Cloud CLI. Then, configure your Application Default Credentials (ADC).
Installation
pip is recommended for installation.
pip install genomeshader
Building from source
To build from source (particularly for those interested in contributing to the code), follow the procedure below.
# Clone repository.
git clone https://github.com/broadinstitute/genomeshader.git
cd genomeshader
# Create a Python virtual environment and install Maturin, the tool that
# will compile the Rust and Python code into a complete library.
# For more information on Maturin, visit https://github.com/PyO3/maturin .
python -mvenv venv
. venv/bin/activate
pip install maturin
# Build the library (with release optimizations) and install it in
# the currently active virtual environment.
maturin develop --releaseSupported platforms
Genomeshader is compiled for Linux and MacOSX. Windows is not currently supported.
Getting help
If you encounter bugs or have questions/comments/concerns, please file an issue on our Github page.
Developers’ guide
For information on contributing to Genomeshader development, visit our developer documentation.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for genomeshader-0.1.75-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e601bcf0996d045886ede45bf32c562c9378c02ca05ff51f87a118f23a488314 |
|
| MD5 | 8e73134073a2a6cefb5346c315684171 |
|
| BLAKE2b-256 | bbeab06f5cd6e684c0688ecfbf85fb0180f25a64dc26f4d8906e6ab561649a42 |
Hashes for genomeshader-0.1.75-cp37-abi3-macosx_11_0_arm64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 573491589ca2ee2675b7d32eeb128e1f27d99c9617d6b0acdf7b9a935131b207 |
|
| MD5 | 06ec6eff44b55153befb45981d253773 |
|
| BLAKE2b-256 | 657e0de0b307cff72aad674da28e6ee1b6bcb70362bee1d94245d2fc62018ef6 |
Hashes for genomeshader-0.1.75-cp37-abi3-macosx_10_12_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cba447d15b7462e1588baeec5d79e7d6e3a0a2f57729989baf61f675db54c72b |
|
| MD5 | 4477afbbd4a3078b3b77ac6ce6d582a1 |
|
| BLAKE2b-256 | 89bfbb346cba2ebc88c76653cf81da8725dcc7c6b84df0b130845d68996aa430 |
