Skip to main content

ADAMIXTURE logo

Fast Biobank-Scale Population Genetics Clustering

Python Version PyPI Version License Status Downloads


ADAMIXTURE is a fast CPU/GPU implementation of ADMIXTURE for biobank-scale genetic clustering. .P and .Q outputs remain compatible with ADMIXTURE.

System requirements

Hardware & Platform compatibility

ADAMIXTURE runs cross-platform on Linux, macOS, and Windows, supporting CPU computation as well as GPU acceleration on NVIDIA GPUs (CUDA) and Apple Silicon (MPS).

Software requirements

We recommend creating a fresh Python 3.10+ virtual environment. For a faster installation experience, we highly recommend using uv.

As an example, using uv (recommended):

$ uv venv --python 3.10
$ source .venv/bin/activate
$ uv pip install adamixture

Installation Guide

The package can be installed using pip:

Basic Installation (CPU default)

Uses the pre-compiled C/Cython wheel and does not install PyTorch:

$ pip install adamixture

GPU Installation (NVIDIA CUDA / Apple Silicon MPS)

Includes PyTorch and Ninja for hardware-accelerated execution:

$ pip install "adamixture[gpu]"

The commands above use the binary wheel when one is available for the Python version and platform. Installing directly from a source checkout (for example, with pip install -e .) requires a local C/Cython build toolchain.

Running ADAMIXTURE

To train a model, simply invoke the following commands from the root directory of the project. For more info about all the arguments, please run adamixture --help. Note that BED, VCF, PGEN and BCF are supported.

Supported input files include:

  • PLINK BED: .bed, .bed.gz, .bed.zst, with .bim/.fam sidecars that may also be plain, .gz or .zst.
  • PLINK PGEN: .pgen or .pgen.zst, with .pvar/.psam sidecars that may be plain, .gz or .zst.
  • VCF: .vcf, .vcf.gz and .vcf.zst.
  • BCF: .bcf, .bcf.gz and .bcf.zst.

As an example, the following ADMIXTURE call

$ ./admixture snps_data.bed 8 -s 42

would be equivalent in ADAMIXTURE by running

$ adamixture -k 8 --data_path snps_data.bed --save_dir SAVE_PATH --name snps_data -s 42

By default, the following files will be output to the SAVE_PATH directory (the name parameter will be used to create the full filenames):

  • A .P file, similar to ADMIXTURE.
  • A .Q file, similar to ADMIXTURE.
  • A .png plot file containing the visualization of the inferred ancestry proportions (Q matrix).

Logs are printed to the stdout channel by default. If you want to save them to a file, you can use the command tee along with a pipe:

$ adamixture -k 8 ... | tee run.log

Running with multi-threading

To run ADAMIXTURE using multiple CPU threads, use the -t flag:

$ adamixture -k 8 --data_path data.bed --save_dir out/ --name test -t 8

Running with GPU acceleration

To leverage GPU acceleration (highly recommended for large datasets), use the --device flag:

  • NVIDIA GPU (CUDA):
    $ adamixture -k 8 --data_path data.bed --save_dir out/ --name test --device gpu
    
  • macOS Apple Silicon (MPS):
    $ adamixture -k 8 --data_path data.bed --save_dir out/ --name test --device mps
    

For a step-by-step guide on how to run a complete analysis workflow, see the 1000 Genomes Tutorial.

Multi-K Sweep

Instead of running ADAMIXTURE for a single K, you can automatically sweep over a range of K values using --min_k and --max_k. The data is loaded once, and each K is trained sequentially. K=1 is the no-structure null model and is a valid start for a sweep or a CV baseline:

$ adamixture --min_k 1 --max_k 10 --data_path snps_data.bed --save_dir SAVE_PATH --name snps_sweep

Cross-validation

Use --cv to estimate the optimal K by masking a fraction of genotype entries and measuring prediction error. → Full documentation

$ adamixture -k 8 --cv --data_path data.bed --save_dir out/ --name test

Plotting

By default, ADAMIXTURE automatically generates a png plot at 300 DPI without needing any additional flags. Following the method of Clumppling, it automatically aligns clusters across runs and K values. → Full documentation

Plots can include hierarchical population labels if you provide the arguments (--labels, --labels2, --labels3).

If you want to customize the format and resolution (e.g., to generate a PDF), use --plot (or --plot_single for individual per-K plots in multi-K sweeps):

  • Single K runs (-k): Use --plot.

    $ adamixture -k 8 --data_path data.bed --save_dir out/ --name test --plot pdf 300
    
  • Multi-K sweeps (--min_k and --max_k): Use --plot to configure the combined sweep plot (or --plot_single for individual plots per K).

    $ adamixture --min_k 2 --max_k 10 --data_path data.bed --save_dir out/ --name test --plot pdf 300
    

Projection Mode

Estimate ancestry proportions for new samples using a pre-trained, fixed P matrix (Q-only optimisation). K is detected automatically from P. → Full documentation

$ adamixture-project \
    --data_path new_samples.bed \
    --p_path trained_model/results.8.P \
    --save_dir projection_out/ \
    --name projected

Supervised Mode

Anchor the model with known population labels for a subset of samples while estimating Q freely for unlabeled ones. Labels use the same format as --labels (population name or -). → Full documentation

$ adamixture-supervised \
    --data_path all_samples.bed \
    --labels labels.txt \
    --save_dir supervised_out/ \
    --name supervised_run

K is the number of distinct population names in the labels file, so -k is not passed.

Other options

All hyperparameters and flags can be explored with:

$ adamixture --help

The help groups the options by purpose (required arguments, number of populations, general, input filtering, optimization, initialization and plotting).

Key arguments:

Argument                                          Default Description
--algorithm brqn Solver: SQP + ZAL quasi-Newton (brqn) or Adam-EM (adamem).
--init als Initialization method: SVD+ALS (als) or random EM priming (em).
--tol 0.1 Convergence tolerance for log-likelihood changes.
--max_iter 10000 Maximum solver iterations (BR-QN or Adam-EM).
--patience 3 Iterations without log-likelihood improvement before stopping.
-t 1 Number of CPU threads.
-s 42 Random seed.
--device cpu Device to use: cpu, gpu, or mps.
--chunk_size 8192 Number of SNPs in chunk operations.
--n_inits 1 Number of independent initializations (keeps run with best log-likelihood).
--chrom_mode autosomes Chromosome filter: autosomes keeps autosomes 1 to --autosomes; all keeps every chromosome.
--autosomes 22 Number of autosomes kept when --chrom_mode autosomes (equivalent to --specific_chrom 1 2 ... 22).
--specific_chrom None List of specific chromosomes to analyze when --chrom_mode autosomes (overrides --autosomes).
--no_freqs False Do not save the .P allele-frequency matrix.

Algorithm note

The ADAMIXTURE paper introduced Adam-EM as an adaptive first-order optimizer for admixture inference. The package still includes this solver via --algorithm adamem.

In the current implementation, the default is --algorithm brqn. Empirical benchmarking showed that block relaxation with ZAL quasi-Newton acceleration, when paired with our improved SVD+ALS initialization, reaches high-quality solutions in fewer iterations and better wall-clock time. For that reason, BR-QN is the default solver, while Adam-EM remains available for experimentation and reproducibility. Adam-EM tuning parameters are documented in Troubleshooting and Tips.

Troubleshooting and Tips

Common issues and platform notes:

  • macOS: Install libomp via Homebrew (brew install libomp) before compiling.
  • Windows: Pre-compiled wheels are provided on PyPI (pip install adamixture). If compiling from source (pip install -e .), install Build Tools for Visual Studio with Desktop development with C++.
  • CUDA: Set CUDA_HOME or install nvcc via Conda (conda install -c nvidia nvcc).
  • Adam-EM options: only relevant with --algorithm adamem, so they are hidden from --help; list them with adamixture --help-adam (or adamixture-supervised --help-adam).

→ Full documentation

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.

Cite

When using this software, please cite the following paper:

@article{saurina2026adamixture,
  title={ADAMIXTURE: adaptive first-order optimization for biobank-scale genetic clustering},
  author={Saurina-i-Ricos, Joan and Mas Montserrat, Daniel and Ioannidis, Alexander G.},
  journal={Bioinformatics},
  volume={42},
  number={Supplement\_1},
  pages={btag236},
  year={2026},
  doi={10.1093/bioinformatics/btag236},
  url={https://doi.org/10.1093/bioinformatics/btag236}
}

Metadata

Release files for adamixture 1.8.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adamixture 1.8.9
File Size Uploaded Provenance Actions
adamixture-1.8.9.tar.gz 22.4 MB Without provenance Details for adamixture-1.8.9.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for adamixture 1.8.9
File Actions
adamixture-1.8.9-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for adamixture-1.8.9-cp312-cp312-win_amd64.whl
adamixture-1.8.9-cp312-cp312-manylinux_2_28_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.28+ x86-64 Details for adamixture-1.8.9-cp312-cp312-manylinux_2_28_x86_64.whl
adamixture-1.8.9-cp312-cp312-macosx_14_0_x86_64.whl CPython 3.12 CPython 3.12 macOS 14.0+ x86-64 Details for adamixture-1.8.9-cp312-cp312-macosx_14_0_x86_64.whl
adamixture-1.8.9-cp312-cp312-macosx_14_0_arm64.whl CPython 3.12 CPython 3.12 macOS 14.0+ ARM64 Details for adamixture-1.8.9-cp312-cp312-macosx_14_0_arm64.whl
adamixture-1.8.9-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for adamixture-1.8.9-cp311-cp311-win_amd64.whl
adamixture-1.8.9-cp311-cp311-manylinux_2_28_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.28+ x86-64 Details for adamixture-1.8.9-cp311-cp311-manylinux_2_28_x86_64.whl
adamixture-1.8.9-cp311-cp311-macosx_14_0_x86_64.whl CPython 3.11 CPython 3.11 macOS 14.0+ x86-64 Details for adamixture-1.8.9-cp311-cp311-macosx_14_0_x86_64.whl
adamixture-1.8.9-cp311-cp311-macosx_14_0_arm64.whl CPython 3.11 CPython 3.11 macOS 14.0+ ARM64 Details for adamixture-1.8.9-cp311-cp311-macosx_14_0_arm64.whl
adamixture-1.8.9-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details for adamixture-1.8.9-cp310-cp310-win_amd64.whl
adamixture-1.8.9-cp310-cp310-manylinux_2_28_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.28+ x86-64 Details for adamixture-1.8.9-cp310-cp310-manylinux_2_28_x86_64.whl
adamixture-1.8.9-cp310-cp310-macosx_14_0_x86_64.whl CPython 3.10 CPython 3.10 macOS 14.0+ x86-64 Details for adamixture-1.8.9-cp310-cp310-macosx_14_0_x86_64.whl
adamixture-1.8.9-cp310-cp310-macosx_14_0_arm64.whl CPython 3.10 CPython 3.10 macOS 14.0+ ARM64 Details for adamixture-1.8.9-cp310-cp310-macosx_14_0_arm64.whl

Total release size: 173.5 MB

Release files / adamixture-1.8.9.tar.gz

Download URL adamixture-1.8.9.tar.gz
Size 22.4 MB
Tags Source
SHA-256 checksum
How to use checksums
31c0e8801c706d689d44bfeaa94ae79102f1e9541343959f8aae655f13d37c8f
BLAKE2b-256 checksum
How to use checksums
63d87f44531f04951a63559eed9acc3678823b444bdabe119cae6ed2be1acd0c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp312-cp312-win_amd64.whl

Download URL adamixture-1.8.9-cp312-cp312-win_amd64.whl
Size 12.4 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
8f21a7c5c310511ab1b3f2d6b8e1c0c4a4177e8b788104d97c351e139302fb4c
BLAKE2b-256 checksum
How to use checksums
fc9a3e36390003568fc13d56e2daa3ffd8ec501d6e2fb8c258776643924f387e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp312-cp312-manylinux_2_28_x86_64.whl

Download URL adamixture-1.8.9-cp312-cp312-manylinux_2_28_x86_64.whl
Size 12.8 MB
Tags CPython 3.12 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
827fd295bc660e6ebb74edbb6f157e7d5bcae99e99a8d6c2ac5b299e8e3c2d90
BLAKE2b-256 checksum
How to use checksums
b8630159f53bd4175108b0d52942543e5a0008f2438d4f8781841583aa929925
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp312-cp312-macosx_14_0_x86_64.whl

Download URL adamixture-1.8.9-cp312-cp312-macosx_14_0_x86_64.whl
Size 12.5 MB
Tags CPython 3.12 macOS 14.0+ x86-64
SHA-256 checksum
How to use checksums
795121225147021ad87f5f36474be8be3d81f8d5994f18ea61a82778b22a739f
BLAKE2b-256 checksum
How to use checksums
217cd970d2cb1148a4ed4f48b5a88f68f49f8227930c5cae324bedd2a68d0ce5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp312-cp312-macosx_14_0_arm64.whl

Download URL adamixture-1.8.9-cp312-cp312-macosx_14_0_arm64.whl
Size 12.7 MB
Tags CPython 3.12 macOS 14.0+ ARM64
SHA-256 checksum
How to use checksums
83fce130c7abaff3c50af6434c268274770fdc6b7341d189380a2cddd7940406
BLAKE2b-256 checksum
How to use checksums
024e56ca751c32858b492bb004eb8e18e01c24b6faea5d9045f9de954f85ff6b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp311-cp311-win_amd64.whl

Download URL adamixture-1.8.9-cp311-cp311-win_amd64.whl
Size 12.4 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
d9d416574b74b8cd816e5054c21c5c13b2537520af8851a53efc914221511804
BLAKE2b-256 checksum
How to use checksums
6f21470b70911b31f087d619e1b623f7e651397a415758a5d81e2fc999458baa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp311-cp311-manylinux_2_28_x86_64.whl

Download URL adamixture-1.8.9-cp311-cp311-manylinux_2_28_x86_64.whl
Size 12.8 MB
Tags CPython 3.11 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
5123d71187a4b8aa3237df4708ffe28e85fd2401529676e92b2451de63746c32
BLAKE2b-256 checksum
How to use checksums
774c55b01a781953f440f3a7f065ecff1828fe5ae94db40012265faa745c116a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp311-cp311-macosx_14_0_x86_64.whl

Download URL adamixture-1.8.9-cp311-cp311-macosx_14_0_x86_64.whl
Size 12.5 MB
Tags CPython 3.11 macOS 14.0+ x86-64
SHA-256 checksum
How to use checksums
e1a8862f0ea2de17ae3c1499a86c1fabc9c30f6fff0828228d3899ec2503901d
BLAKE2b-256 checksum
How to use checksums
98b0e7b1cb4f3d8f7c94127831008cd43ecbab0afcaf8828a79fd31c344f6f13
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp311-cp311-macosx_14_0_arm64.whl

Download URL adamixture-1.8.9-cp311-cp311-macosx_14_0_arm64.whl
Size 12.7 MB
Tags CPython 3.11 macOS 14.0+ ARM64
SHA-256 checksum
How to use checksums
4687d21c6bc9131892ecd67ce91119c4354c06175ab98d4a552b07f550349d0f
BLAKE2b-256 checksum
How to use checksums
0ab5c80802ad5eacac1f9b5626ffc6d2b44f10ed27d3e7c1966d8e81b99d595c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp310-cp310-win_amd64.whl

Download URL adamixture-1.8.9-cp310-cp310-win_amd64.whl
Size 12.4 MB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
15c1c6a4b5da13d8ffdf7f551ff1f5f0e9e7bd4b351ebda0170741d9c81afb79
BLAKE2b-256 checksum
How to use checksums
583a200a7e5df827cb866e9e1971f82b19bc88a80efc854ba687f21bf3b9ef22
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp310-cp310-manylinux_2_28_x86_64.whl

Download URL adamixture-1.8.9-cp310-cp310-manylinux_2_28_x86_64.whl
Size 12.9 MB
Tags CPython 3.10 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
78c7f0de97cc97e50b5b3bfc4b2b45ae526a042e3198613b63527d9db81dc26b
BLAKE2b-256 checksum
How to use checksums
f0a5c3839833ddcec043e0d9c7e1393f4e4505e808b47d3eec46e07cfbbefcb9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp310-cp310-macosx_14_0_x86_64.whl

Download URL adamixture-1.8.9-cp310-cp310-macosx_14_0_x86_64.whl
Size 12.5 MB
Tags CPython 3.10 macOS 14.0+ x86-64
SHA-256 checksum
How to use checksums
ec4bf527326fcd77142551d64f1d8908a06a2f8a295bd1dd8d391da9428c2e96
BLAKE2b-256 checksum
How to use checksums
b2c2d7240593a0a3201677253a24a3871afa17106e76bcee0f9ae33497348dd1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.8.9-cp310-cp310-macosx_14_0_arm64.whl

Download URL adamixture-1.8.9-cp310-cp310-macosx_14_0_arm64.whl
Size 12.7 MB
Tags CPython 3.10 macOS 14.0+ ARM64
SHA-256 checksum
How to use checksums
7de5b38aad92478299b4285ac8683900164f39ecc8f87dac3b8de9943635db3a
BLAKE2b-256 checksum
How to use checksums
5c78738e41cc8a2b5a6df003a1d6a7b1dc131c2c6c57f3d7dd173ed86bb26bef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for adamixture 1.8.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.8.9 This release

13 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page