Flaminkit
=========

A toolkit for the FLAMINGO cosmological hydrodynamical simulation suite. Flaminkit is developed on `Github <https://github.com/cristobal-sifon/flaminkit>`_.

.. note::
    Currently only works with HBT+ catalogs.

.. warning::
    Flaminkit is under active development; the functionalities and API may change.

Installation
------------

Flaminkit can be installed through ``pip``: ::

    pip install flaminkit


Version log
-----------

*0.0.6*
    - Options to parallelize or show progress bar in ``particles_around``
    - Remove ``requirements.txt``

.. note::
    Versions 0.0.5 and older cannot be installed from PyPI


License
-------

Flaminkit is distributed under a GNU GPLv3 License. See `here <https://github.com/cristobal-sifon/flaminkit/blob/master/LICENSE>`_ for more details.

.. toctree::
    :maxdepth: 4
    :caption: API Documentation

    autoapi/flaminkit/index