Hughes2d documentation
===================================

**Hughes2d** is a Python library for approximating the solutions of a macroscopic pedestrian flow model named the Hughes' model. The package combines a finite volume scheme for the scalar conservation law and a fast marching algorithm for the Eikonal equation.

Check out the :doc:`maths` section for a quick introduction to macroscopic pedestrian models and a short bibliography on the subject.
Check out the :doc:`usage` section for further information, including
how to :ref:`installation` the project.
Check out the examples (https://github.com/TheoRGirard/hughes2d/tree/main/examples) on the repository for short demonstrations of what this package can achieve.
Check out the :doc:`reference` for a complete reference of the classes and methods of the package.

.. note::

   This project is under active development.

Citation 
---------

You can cite the **Hughes2d** package using:

.. code-block:: bibtex

  @software{hughes2d,
  author = {Théo Girard},
  title = {Hughes2d: approximating solutions of Hughes' model},
  journal = {(submitted)},
  year = {2025},
  }

which produces the output:

  **T. Girard**, *Hughes2d: approximating solutions of Hughes' model*, submitted (2025).

Contents
--------

.. toctree::

   usage
   maths
   reference