PyDPF
=====

Installation
============
PyDPF can be be installed by running:

.. code-block:: python

    pip install pydpf

Before using our package we recommend you read our :ref:`pydpf-basics` guide for an overview of some key aspects of writing models
and running experiments in pydpf.


If you use our package in your publication please cite our paper:

.. code-block:: text

    @article{brady2025pydpf,
      title={PyDPF: A Python Package for Differentiable Particle Filtering},
      author={John-Joseph Brady and Benjamin Cox and Yunpeng Li and V\'{i}ctor Elvira},
      year={2025},
      journal={arXiv preprint arXiv:2510.25693},
      url={https://arxiv.org/abs/2510.25693},
    }


Documentation Index
===================

.. toctree::
   :maxdepth: 5

   api/index
   basics
   tutorial