MaRGE3D Package
***************

.. raw:: html

    <a href="https://pypi.org/project/marge3d">
        <img alt="PyPI - Package" src="https://img.shields.io/pypi/v/marge3d?logo=python">
    </a>
    <a href="https://pypistats.org/packages/marge3d">
        <img alt="PyPI - Download" src="https://img.shields.io/pypi/dm/marge3d?logo=pypi">
    </a>
    <a href="https://github.com/CompMath-TUHH/MaRGE_3D_solver">
        <img alt="Last Commit" src="https://img.shields.io/github/last-commit/CompMath-TUHH/MaRGE_3D_solver/main?logo=github" />
    </a>
    <a href="https://github.com/CompMath-TUHH/MaRGE_3D_solver/actions/workflows/ci_pipeline.yml">
        <img alt="CI pipeline" src="https://github.com/CompMath-TUHH/MaRGE_3D_solver/actions/workflows/ci_pipeline.yml/badge.svg">
    </a>
    <a href="https://codecov.io/gh/CompMath-TUHH/MaRGE_3D_solver">
        <img alt="Coverage" src="https://codecov.io/gh/CompMath-TUHH/MaRGE_3D_solver/graph/badge.svg?token=5Q6GS039XF">
    </a>

`marge3d` is a python package to solve forthe Maxey-Riley-Gatignol Equations (MaRGE) in 3D flow
using the method by `Daitche (2013) <https://doi.org/10.1016/j.jcp.2013.07.024>`_.
Analytical solution in simple vortex is provided to validate the method.

.. raw:: html

    <a href="https://zenodo.org/doi/10.5281/zenodo.17601798">
        <img alt="DOI" src="https://zenodo.org/badge/1090126264.svg">
    </a>

This package can be installed using `pip` :

.. code-block:: bash

    pip install marge3d

... but you can also use `conda` or installation from sources, see the :doc:`Installation Instructions 💾<installation>`


Doc Contents
============

.. toctree::
    :maxdepth: 1

    installation
    notebooks
    changelog
    contributing
    API reference <api/marge3d/index>

Links
=====

* Code repository: https://github.com/CompMath-TUHH/MaRGE_3D_solver
* Issues Tracker : https://github.com/CompMath-TUHH/MaRGE_3D_solver/issues

Developers
==========

* `Vamika Rathi <https://github.com/Vamika-Rathi>`_
* `Finn Sommer <https://github.com>`_