TRX-cpp Documentation
=====================

.. image:: https://readthedocs.org/projects/trx-cpp/badge/?version=latest
   :target: https://trx-cpp.readthedocs.io/en/latest/
   :alt: Documentation Status

.. image:: https://codecov.io/gh/tee-ar-ex/trx-cpp/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/tee-ar-ex/trx-cpp
   :alt: codecov

A C++17 library for reading, writing, and memory-mapping the TRX tractography
format.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   introduction
   quick_start
   building

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   concepts
   api_layers
   reading
   writing
   streaming
   spatial_queries
   nifti

.. toctree::
   :maxdepth: 2
   :caption: Integration Guide

   integration

.. toctree::
   :maxdepth: 2
   :caption: Performance

   benchmarks

.. toctree::
   :maxdepth: 2
   :caption: TRX Format

   spec

.. toctree::
   :maxdepth: 2
   :caption: Contributing

   linting

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/library_root