=======================
Getting Started
=======================

This website provides information and resources regarding
the AIRR Community Standards for the diverse community of immunology
researchers, bioinformaticians, and software developers.

MiAIRR standard for study data submission
-----------------------------------------

+ Gather experimental and analysis information about your study to conform to the :ref:`MiAIRR <MiAIRR>` standard
  (minimal information about adaptive immune receptor repertoires).

+ :ref:`Submission <Data_Submission>` of your study data to a public repository.

AIRR Data Commons for query and download of AIRR-seq data
---------------------------------------------------------

+ :ref:`Query <Data_Submission>` publicly available AIRR-seq studies in the :ref:`AIRR Data Commons <DataCommons>`.

Resources related to data representations and software development
------------------------------------------------------------------

+ Schema, definitions and file formats for the :ref:`AIRR Data Model <DataRepresentations>`. The AIRR Data Model
  defines the structure and relationship for the MiAIRR data elements.

+ :ref:`Software guidelines <ToolsStandard>` for tools developers to enable rigorous and reproducible immune
  repertoire research.

+ :ref:`AIRR Data Commons API <DataCommonsAPI>` provides programmatic access to query and download AIRR-seq data.

Software tools and libraries
----------------------------

+ :ref:`Python reference library <PythonOverview>` for reading/writing/validating AIRR data files.

+ :ref:`R reference library <ROverview>` for reading/writing/validating AIRR data files.

+ :ref:`ADC API reference implementation <ADCAPIReference>` for a local data repository.

+ :ref:`Resources and tools <Community>` that support the AIRR Standards.

Tutorials, examples and workflows
---------------------------------

.. toctree::
   :maxdepth: 1

   examples/datarep_cmd_example
   examples/api_analysis_example
   examples/api_queries