Skip to main content

Python library for immune repertoire analyses

Project description

License Latest release Build Status Documentation Status

Pyrepseq: the immune repertoire analysis toolkit

Pyrepseq is scipy & seaborn for studying adaptive immunity: modular implementations of algorithms for fast analyses, and bespoke plotting functions for compelling visualizations.

Documentation and examples

You can find API documentation on readthedocs. You can also create a local copy of the API documentation by running:

make html

in the docs folder.

There are jupyter notebooks illustrating some of the functionality in the 'examples' folder. You can also find usage examples by looking at the code underlying our recent paper Mayer Callan PNAS 2023.

Installation

The quickest way to install Pyrepseq is via pip:

pip install pyrepseq[full]

This will install pyrepseq with all optional dependencies. Depending on whether dependencies are already installed this might take a few minutes. You can also install the leading edge development version using:

pip install git+https://github.com/andim/pyrepseq

As the TCRdist dependency on parasail is known to cause installation issues on Mac OSX, pyrepseq can also be installed without this dependency by running:

pip install pyrepseq

In this case some functionality will not be available. To allow installation to proceed on mac you might have to manually install build tools using:

brew install autoconf automake libtool

Pyrepseq can also be installed from its Github source, by running:

python setup.py install

in the main directory.

Support and contributing

For bug reports and enhancement requests use the Github issue tool, or (even better!) open a pull request with relevant changes. If you have any questions don't hesitate to contact us by email (andimscience@gmail.com) or Twitter (@andimscience).

You can run the testsuite by running pytest in the top-level directory. Dependencies for generating testing and generating local versions of the documentation can be installed using:

pip install pyrepseq[dev]

You are cordially invited to contribute to the further development of pyrepseq!

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

pyrepseq-1.5.1.tar.gz (55.0 kB view details)

Uploaded Source

Built Distribution

pyrepseq-1.5.1-py3-none-any.whl (54.4 kB view details)

Uploaded Python 3

File details

Details for the file pyrepseq-1.5.1.tar.gz.

File metadata

  • Download URL: pyrepseq-1.5.1.tar.gz
  • Upload date:
  • Size: 55.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for pyrepseq-1.5.1.tar.gz
Algorithm Hash digest
SHA256 a77aeab09dd2ec6923e3e7aabe5b8ccaa0541d1a556e810ac27222fdbc0bfbae
MD5 9b682abee4c308a4e43d84208c21ce7b
BLAKE2b-256 e4d9b3d585e53ae5c3bb13b38fcad3b60a49ddb49ed594c837e93f2ec2f9618b

See more details on using hashes here.

File details

Details for the file pyrepseq-1.5.1-py3-none-any.whl.

File metadata

  • Download URL: pyrepseq-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 54.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for pyrepseq-1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 03805b53879a4d8e024d178287c0711e78d7afe05fcc505c8fdf00b9edb983da
MD5 1e540b8ec4bafec5c81d70bb7f71c55d
BLAKE2b-256 02cd92725ebf9797d9d9077cd645995dad21982a061fda7253032255a33ef45f

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