Citing
======

If you use ``circle_bundles`` in academic work, please cite both the software
and the main paper describing the underlying theory.

Software
--------

.. code-block:: text

   Brad Turow and José A. Perea.
   circle_bundles: Discrete Approximate Circle Bundles for Data Analysis
   (version 0.1.0), 2026.
   https://github.com/bradturow/circle_bundles

BibTeX:

.. code-block:: bibtex

   @software{turow2026circlebundles,
     author    = {Turow, Brad and Perea, Jos\'{e} A.},
     title     = {circle\_bundles: Discrete Approximate Circle Bundles
                  for Data Analysis},
     version   = {0.1.0},
     year      = {2026},
     url       = {https://github.com/bradturow/circle_bundles},
   }

A ``CITATION.cff`` file is also provided in the repository for use with
GitHub's `built-in citation feature
<https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files>`_.


Papers
------

The algorithms in this package are based on the following paper:

**Discrete Approximate Circle Bundles**
Brad Turow, José A. Perea.
*arXiv preprint*, 2025.
`arXiv:2508.12914 <https://arxiv.org/abs/2508.12914>`_

.. code-block:: bibtex

   @article{turow2025discrete,
     author    = {Turow, Brad and Perea, Jos\'{e} A.},
     title     = {Discrete Approximate Circle Bundles},
     year      = {2025},
     eprint    = {2508.12914},
     archivePrefix = {arXiv},
     primaryClass  = {math.AT},
     url       = {https://arxiv.org/abs/2508.12914},
   }

For results involving optical flow data (reproduced in the
:doc:`optical flow tutorial <auto_examples/all/04_optical_flow_torus>`):

**An Extended Topological Model for High-Contrast Optical Flow**
Brad Turow, José A. Perea.
*arXiv preprint*, 2026.
`arXiv:2603.06853 <https://arxiv.org/abs/2603.06853>`_

.. code-block:: bibtex

   @article{turow2026opticalflow,
     author    = {Turow, Brad and Perea, Jos\'{e} A.},
     title     = {An Extended Topological Model for High-Contrast
                  Optical Flow},
     year      = {2026},
     eprint    = {2603.06853},
     archivePrefix = {arXiv},
     primaryClass  = {cs.CV},
     url       = {https://arxiv.org/abs/2603.06853},
   }