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
  2. on macOS, the latest nightly build of pytorch, which can leverage the MPS backend

Use the pytorch configuration helper to find suitable installation instruction for your system. The code snippets below will probably work for most systems, and should install quickdraws in approximately 10 minutes for cuda or much quicker on macOS:

Linux

pip install torch --index-url https://download.pytorch.org/whl/cu118
pip install quickdraws

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.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.1.tar.gz (55.5 kB view details)

Uploaded Source

Built Distribution

quickdraws-0.1.1-py3-none-any.whl (64.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: quickdraws-0.1.1.tar.gz
  • Upload date:
  • Size: 55.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

File hashes

Hashes for quickdraws-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7371417a2ca1407a148303f3addde97621a22970533335626a3e21b06b8d4ebc
MD5 a68e8b64d5378badfbc2ad1c4d8da16a
BLAKE2b-256 e12e150d5acc9a08b0af21138ba5e56ebf354d26dc822cad5c3e8b7a4a948a19

See more details on using hashes here.

File details

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

File metadata

  • Download URL: quickdraws-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 64.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

File hashes

Hashes for quickdraws-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e5e2fd4a08b22452f2e50698876d882a73329938ac4f3a03c375adf95d45fcf
MD5 ee2b8f0893663e6ea5dea3482804cd02
BLAKE2b-256 23f74275723053820b63c720525975097543627ed4445a5fb8c3d8732bfe84ae

See more details on using hashes here.

Supported by

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