abstar
VDJ assignment and antibody sequence annotation. Scalable from a single sequence to billions of sequences.
- Source code: github.com/brineylab/abstar
- Documentation: abstar.readthedocs.org
- Download: pypi.python.org/pypi/abstar
- Docker: hub.docker.com/r/brineylab/datascience/
install
pip install abstar
use
To run abstar on a single FASTA or FASTQ file, you need to supply the input file and the project directory (into which output and logs will be written):
abstar path/to/sequences.fasta path/to/project_directory
To iteratively run abstar on all files in an input directory, pass a directory containing FASTA or FASTQ files instead of the path to a single file:
abstar path/to/input_directory path/to/project_directory
additional options
abstar contains a number of additional options and tools, including merging paired-end reads, parsing unique molecular identifiers (UMIs), and building/using custom germline databases. These are described in the abstar documentation.
api
Most core abstar functions are available through a Python API, making it easier to run abstar as a component of integrated analysis pipelines or to run abstar interactively (e.g. in a Jupyter notebook). See the abstar documentation for more detail about the API.
testing
You can run the complete abstar test suite by first installing pytest:
pip install pytest
followed by:
git clone https://github.com/brineylab/abstar
cd abstar
pytest
This test suite is automatically run after every commit, and is tested against all supported versions of Python.
requirements
Python 3.10+
abutils
click
matplotlib
numpy
pandas
parasail
polars
pyarrow
pytest
Metadata
Release files for abstar 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| abstar-0.8.0.tar.gz | 640.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| abstar-0.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.4 MB
Release files / abstar-0.8.0.tar.gz
| Download URL | abstar-0.8.0.tar.gz |
|---|---|
| Size | 640.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ba765766a8ed9055e0ccaf3bd099f0ce5e0639ee10d990d078ea327ae69ce123
|
|
BLAKE2b-256 checksum How to use checksums |
7fea3588343f372142dc5b05db88e68d60e6c0d92fe7f3197b7f33f48b2e685b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 16, 2026.
Transparency logRelease files / abstar-0.8.0-py3-none-any.whl
| Download URL | abstar-0.8.0-py3-none-any.whl |
|---|---|
| Size | 735.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c3c25dd4c0ebcd8173fdd4737539957dfd2f5ca25a0a71cc7a1f2643cdb898f4
|
|
BLAKE2b-256 checksum How to use checksums |
a05b05cc22f1e3bc85f4e6c0c1ae10db893a12c276af9db95f46f4f5480baf7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 16, 2026.
Transparency log