Skip to main content

Quickdraws is a software tool for performing Genome-Wide Association Studies (GWAS)

Project description

Quickdraws Logo

Quickdraws relies on cuda-enabled pytorch for speed, and it is expected to work on most cuda-compatible Linux systems.

Installation

It is strongly recommended to either set up a python virtual environment, or a conda environment:

Python virtual environment

python -m venv venv
source venv/bin/activate
pip install --upgrade pip setuptools wheel

Conda environment

conda create -n quickdraws python=3.11 -y
conda activate quickdraws
pip install --upgrade pip setuptools wheel

Install pytorch and quickdraws

It is necessary for anything bigger than toy examples to use either:

  1. on Linux, a cuda-enabled version of pytorch (now available by default from PyPI)
  2. on macOS, the latest pytorch, which can leverage the MPS backend

Use the pytorch configuration helper to find suitable installation instruction for your system, based on your preferred CUDA version. If you want a specific CUDA version, you may need to start with something like pip install torch --index-url https://download.pytorch.org/whl/cu118.

The code snippet below will probably work for most systems, and should install quickdraws in approximately 10 minutes for cuda or much quicker on macOS:

Linux or macOS

pip install quickdraws

Running example

Once you install quickdraws, three executables should be available in your path:

  1. convert-to-hdf5
  2. quickdraws-step-1
  3. quickdraws-step-2.

Clone the Git repository to access the example data and script demonstrating how these can be used:

git clone https://github.com/PalamaraLab/quickdraws.git
cd quickdraws
bash run_example.sh

Local development

To make changes to the quickdraws sourcecode, obtain the repository and install it using poetry. Assuming you have poetry installed:

git clone https://github.com/PalamaraLab/quickdraws.git
cd quickdraws
poetry install

Documentation

See https://palamaralab.github.io/software/quickdraws/manual/

Summary Statistics for some UKB traits

See https://www.stats.ox.ac.uk/publication-data/sge/ppg/quickdraws/

Contact information

For any technical issues please contact Hrushikesh Loya (loya@stats.ox.ac.uk)

Citation

Loya et al., "A scalable variational inference approach for increased mixed-model association power" under review

Release Notes

v0.1.4 (2025-03-27)

  • Bug fix, introduced --chunksize argument in quickdraws-step-1 aswell

v0.1.3 (2025-01-24)

  • Better memory usage and speed for step 0, introduced --chunksize argument

v0.1.2 (2025-01-07)

  • Minor updates to documentation
  • Remove reliance on specific CUDA torch for Linux
  • Resolve numpy dependency conflict

v0.1.1 (2024-10-24)

  • Minor updates to documentation
  • Remove reliance on pre-release Torch for macOS

v0.1.0 (2024-10-15)

First public release to accompany the paper (see citation above).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quickdraws-0.1.4.tar.gz (55.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quickdraws-0.1.4-py3-none-any.whl (65.3 kB view details)

Uploaded Python 3

File details

Details for the file quickdraws-0.1.4.tar.gz.

File metadata

  • Download URL: quickdraws-0.1.4.tar.gz
  • Upload date:
  • Size: 55.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.9 Linux/6.8.0-1021-azure

File hashes

Hashes for quickdraws-0.1.4.tar.gz
Algorithm Hash digest
SHA256 daadb5a3a3df27476370e7013ed2dde9638fd839b16e7c281db54663b88a5915
MD5 f5840de6ac926c8b73660ae4bb3914fe
BLAKE2b-256 2f091e72ae978471288e377538f4c0a927d981335d3ab818fd867929efe5967d

See more details on using hashes here.

File details

Details for the file quickdraws-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: quickdraws-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 65.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.9 Linux/6.8.0-1021-azure

File hashes

Hashes for quickdraws-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 dcc6320b12f3a46c7530efa03d9db018553db69c1c9fef63af815faba22c2aac
MD5 5b4016391573358c2aac2c528cba21f9
BLAKE2b-256 21d6525c0e35ed5e7860706569ac4fa6ff2dab3a4c90cd45b618f365d0a2d434

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page