# TRX-cpp Documentation

```{image} https://img.shields.io/badge/docs-github.io-blue?style=flat&logo=github
:alt: Documentation Status
:target: https://tee-ar-ex.github.io/trx-cpp/
```

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

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

```{toctree}
:caption: Getting Started
:maxdepth: 2

introduction
quick_start
building
```

```{toctree}
:caption: User Guide
:maxdepth: 2

concepts
api_layers
reading
writing
streaming
spatial_queries
nifti
```

```{toctree}
:caption: Integration Guide
:maxdepth: 2

integration
```

```{toctree}
:caption: Performance
:maxdepth: 2

benchmarks
```

```{toctree}
:caption: TRX Format
:maxdepth: 2

spec
```

```{toctree}
:caption: Contributing
:maxdepth: 2

linting
```

```{toctree}
:caption: API Reference
:maxdepth: 2

api/library_root
```