.. toctree::
    :hidden:
    :caption: Users

    quickstart
    algorithms
    environments
    tuning
    examples
    citation
    references

.. toctree::
    :hidden:
    :caption: Developers

    contributing
    license
    Changelog <https://github.com/radar-research-lab/MFGLib/blob/main/CHANGELOG.md>


MFGLib
======

    *A library for mean-field games.*

MFGLib is an open-source Python library designed to facilitate research into mean-field games (MFGs).
The library provides an intuitive and flexible platform for developing, testing, and experimenting with
MFG algorithms and environments.

**Key Features:**

* **Extensible Framework:** Easily add new algorithms and environments to fit your research needs.
* **User-Friendly Interface:** Designed for quick prototyping with minimal setup required.
* **Pre-built Components:** Implementations of commonly used MFG algorithms/environments to help you get started.
* **Community Support:** As an open-source project, MFGLib thrives on contributions from the research community.

We recommend newcomers start with our :doc:`quickstart` tutorial.