Skip to main content

A software for the analysis of immune repertoires

Project description

AIMS - An Automated Immune Molecule Separator

Quick Start

As of AIMS v0.9, everything should be nicely wrapped up as an installable pypi package. You can simply install the AIMS GUI, CLI, and notebook using pip:

pip install aims-immune

You can then launch the GUI, the CLI, or the notebook from the terminal in the directory your data is located using one of:

aims-gui
aims-cli
aims-notebook

Lastly, you can optionally copy test data into your current directory using:

aims-tests

Whether you are a new or returning AIMS user, it is strongly recommended you check out the documentation (see below) to learn details about formatting and usage. For returning users especially, the way AIMS is called has changed completely.

Description

The primary goal of AIMS is to identify discriminating factors between two distinct sets of immune molecules. As of versions 0.8 and later, the software is now capable of analyzing any set of sequences with general conservation and localized diversity. AIMS has specific analysis modes for Immunoglobulins (Ig - T Cell Receptors and Antibodies) and Peptides (Specifically those isolated from MHC), as well as a more general multi-sequence alignment analysis mode that has been used to characterize MHC molecules, MHC-like molecules, and the non-immunological Dpr-DIP proteins.

AIMS is a python package distributed in a notebook, CLI, and GUI format. An example of an application of AIMS can be seen in this peer-reviewed article: https://elifesciences.org/articles/61393

When publishing analysis from this software, please cite:

Boughter CT, Borowska MT, Guthmiller JJ, Bendelac A, Wilson PC, Roux B, Adams EJ. Biochemical Patterns of Antibody Polyreactivity Revealed Through a Bioinformatics-Based Analysis of CDR Loops. eLife. 2020. DOI: 10.7554/eLife.61393

&

Boughter CT, Meier-Schellersheim M. An Integrated Approach to the Characterization of Immune Repertoires Using AIMS: An Automated Immune Molecule Separator. PLoS Computational Biology. 2023. DOI: 10.1371/journal.pcbi.1011577

Documentation

Rather than have all of the instructions on this GitHub page, all information on installation and usage (and more!) has been moved to a separate, more readable documentation page. Please follow this link:

https://aims-doc.readthedocs.io/en/latest/

For the comprehensive AIMS user guide.

Reproduction of Published Results

As of versions 0.8 and later, the data necessary for reproducing data published thus far have been moved to a separate repository. This repository can be found here:

https://github.com/ctboughter/AIMS_manuscripts

The underlying code remains the same, and will continue to be updated. This has been done to keep the AIMS analysis software more streamlined and less cluttered with manuscript-specific analysis.

Further Reading

Now that AIMS has been out and in the wild for around two years, there have been additional published peer-reviewed manuscripts or posted preprints that highlight the capabilities of AIMS! I'll try to keep this list relatively up to date, and if it ever gets lengthy will likely move it to the ReadTheDocs page. Manuscripts thus far include:

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

aims_immune-0.9.2.tar.gz (4.7 MB view details)

Uploaded Source

Built Distribution

aims_immune-0.9.2-py3-none-any.whl (4.8 MB view details)

Uploaded Python 3

File details

Details for the file aims_immune-0.9.2.tar.gz.

File metadata

  • Download URL: aims_immune-0.9.2.tar.gz
  • Upload date:
  • Size: 4.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for aims_immune-0.9.2.tar.gz
Algorithm Hash digest
SHA256 1556f3e73ef19191b961615f57cdb6154715a4c6b2af7e7823ddc928372c3e0b
MD5 9dc97ee5d1e3c2ffad01bf386c3ba990
BLAKE2b-256 bf36189057b91310255cb5439532e3be07346623f8da78211717d657b86dd17d

See more details on using hashes here.

File details

Details for the file aims_immune-0.9.2-py3-none-any.whl.

File metadata

  • Download URL: aims_immune-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 4.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for aims_immune-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b81bbe7d510d1dac7b61f744283ba592524ebb54672e4aff0cafefb013e8df8b
MD5 2147a964dda6bc9ce9a91918b9ee96ca
BLAKE2b-256 2a5683b46cfedd540c786bbe867744eff31cfc39a7f37c0bacd55409a43f68be

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