Skip to main content

Utilities for analysis of adaptive immune receptor repertoire (AIRR) data

Project description

tests Documentation Status

abutils

Models, functions and visualization tools for working with adaptive immune receptore repertoire (AIRR) data. The primary purpose of abutils is to provide generalizable tools suitable for direct use analyzing bulk AIRR datasets, and is used by scab for single cell AIRR analysis. abutils is a core component of the ab[x] toolkit for AIRR data analysis.

install

pip install abutils

api

We've tried to design the abutils API to be intuitive yet powerful, with the goal of enabling both interactive analyses (via environments like Jupyter notebooks) as well as integration of abutils tools into more complex analysis pipelines and/or standalone software tools. See the documentation for more detail about the API. As always, any feedback is greatly appreciated!!

testing

You can run the complete abutils test suite by first installing pytest:

pip install pytest

followed by:

git clone https://github.com/briney/abutils
cd abutils
pytest

This test suite is automatically run following every commit, and is tested against all supported versions of Python.

requirements

python 3.8+

abstar
baltic
biopython
celery
ete3
fastcluster
matplotlib
mnemonic
natsort
numpy
pandas
paramiko
parasail
pytest
python-circos
python-Levenshtein
pyyaml
sample-sheet
scikit-learn
scipy
seaborn
smart_open

All of the above dependencies can be installed with pip, and will be installed automatically when installing abutils with pip.

abutils packages several additional external binaries that are required for specific functions:

Althogh these binaries are all packaged into abutils, each respective abutils function provides the option to supply a different binary path in case you'd prefer to use a different version or an alternate compilation.

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

abutils-0.4.18.tar.gz (188.4 kB view details)

Uploaded Source

Built Distribution

abutils-0.4.18-py3-none-any.whl (231.9 kB view details)

Uploaded Python 3

File details

Details for the file abutils-0.4.18.tar.gz.

File metadata

  • Download URL: abutils-0.4.18.tar.gz
  • Upload date:
  • Size: 188.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for abutils-0.4.18.tar.gz
Algorithm Hash digest
SHA256 842ac98c6186c46d3782f7477fd7941a347fd755a685b9d485c2c92e166bac05
MD5 61693d9baa3a775abafe104696d2b5a5
BLAKE2b-256 99582a2a8151f98a8787a9f8d44b4e73ffdf9681c48fad3a365169b23314ab75

See more details on using hashes here.

File details

Details for the file abutils-0.4.18-py3-none-any.whl.

File metadata

  • Download URL: abutils-0.4.18-py3-none-any.whl
  • Upload date:
  • Size: 231.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for abutils-0.4.18-py3-none-any.whl
Algorithm Hash digest
SHA256 c270e2c9e995532e6077cb9734e1a02eef4af00e1ca2fff673e14a15934c8f4e
MD5 e89d08d1a6e9b36a1668ac760abdd295
BLAKE2b-256 7199e6ff52fa04ff1caaefacc71cb15c8b0e6ae73b630f3d9c5046fa72c46ab0

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