# Shamrock features

Here is a somewhat exhaustive list of Shamrock's features, do not hesitate to raise an issue if one appears to be missing.
This page was made in order to list the features of the code as well as properly attributing contribution and avoid having multiple peoples working on the same features.

We list the features by categories as well as their status which can be any of:
![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)
![Ok](https://img.shields.io/badge/Ok-yellowgreen)
![WIP](https://img.shields.io/badge/WIP-yellow) (Work in progress)
![Broken](https://img.shields.io/badge/Broken-red)
This page also traces the contributor who made the contribution as well as the corresponding paper to cite for each feature.
If any feature is notated with
![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical)
please wait for the corresponding feature to be published before publishing anything using it.

## Physical

### SPH model

#### Core features

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Gas solver | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| [Sink particles](https://shamrock-code.github.io/Shamrock/mkdocs/features/sph/sinks/) | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | |
| Pseudo-Newtonian <br> corrections | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | [![PR - #319](https://img.shields.io/badge/PR-%23319-brightgreen?logo=github)](https://github.com/Shamrock-code/Shamrock/pull/319) |
| MHD solver | ![WIP](https://img.shields.io/badge/WIP-yellow)  |  [Yona Lapeyre](https://github.com/y-lapeyre) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | [![PR - #707](https://img.shields.io/badge/PR-%23707-brightgreen?logo=github)](https://github.com/Shamrock-code/Shamrock/pull/707) |
| One fluid multispecies dust <br> (TVA approximation) | ![Ok](https://img.shields.io/badge/Ok-yellowgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | [![PR - #1862](https://img.shields.io/badge/PR-%231862-brightgreen?logo=github)](https://github.com/Shamrock-code/Shamrock/pull/1862) |


| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| [On the fly-plots](https://shamrock-code.github.io/Shamrock/mkdocs/usermanual/plotting/) | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | [![PR - #623](https://img.shields.io/badge/PR-%23623-brightgreen?logo=github)](https://github.com/Shamrock-code/Shamrock/pull/623) |
| [Conformance with Phantom](https://shamrock-code.github.io/Shamrock/mkdocs/features/sph/conformance_phantom/) | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) <br> & [Yona Lapeyre](https://github.com/y-lapeyre) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| [Setup graph](user_guide/sph/setup_graph.md) | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | [![PR - #593](https://img.shields.io/badge/PR-%23593-brightgreen?logo=github)](https://github.com/Shamrock-code/Shamrock/pull/593) |
| [Shearing box](user_guide/sph/shearing_box.md) | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | |
| Periodic box | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | |

#### Shock handling mechanisms

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Constant $\alpha_{AV}$ | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) <br> & [Yona Lapeyre](https://github.com/y-lapeyre) | | |
| MM97 $\alpha_{AV}$ | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl)| [![Nasa ads - MM97](https://img.shields.io/badge/Nasa_ads-MM97-blue)](https://ui.adsabs.harvard.edu/abs/1997JCoPh.136...41M/abstract) | |
| CD10 $\alpha_{AV}$ | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl)| [![Nasa ads - CD10](https://img.shields.io/badge/Nasa_ads-CD10-blue)](https://ui.adsabs.harvard.edu/abs/2010MNRAS.408..669C/abstract) | |
| $\alpha$-disc viscosity | ![Ok](https://img.shields.io/badge/Ok-yellowgreen) |  [Yona Lapeyre](https://github.com/y-lapeyre)|  | Requires the warp diffusion test to fully validate |

#### Equations of state

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Isothermal | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Yona Lapeyre](https://github.com/y-lapeyre) | | |
| Adiabatic | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | | |
| Isothermal - LP07 | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Yona Lapeyre](https://github.com/y-lapeyre) | | [![PR - #361](https://img.shields.io/badge/PR-%23361-brightgreen?logo=github)](https://github.com/Shamrock-code/Shamrock/pull/361)  |
| Isothermal - FA14 | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | | |

### GSPH model

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Core solver | ![WIP](https://img.shields.io/badge/WIP-yellow)  |  [Yansong Guo](https://github.com/Guo-astro) <br> & [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | [![PR - #1450](https://img.shields.io/badge/PR-%231450-brightgreen?logo=github)](https://github.com/Shamrock-code/Shamrock/pull/1450) |

### Godunov model

#### Principal components

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Ramses solver | ![Ok](https://img.shields.io/badge/Ok-yellowgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) & [Thomas Guillet](https://github.com/thomasguillet) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | Needs some polishing to be considered production ready |
| Refinement handling | ![Ok](https://img.shields.io/badge/Ok-yellowgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) |  |
| Multifluid dust | ![WIP](https://img.shields.io/badge/WIP-yellow)  |  [Léodasce Sewanou](https://github.com/Akos299) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | [![PR - #916](https://img.shields.io/badge/PR-%23916-brightgreen?logo=github)](https://github.com/Shamrock-code/Shamrock/pull/916) |

#### Refinement criterions

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Mass based refinement | ![Ok](https://img.shields.io/badge/Ok-yellowgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) |  |
| Pseudo-gradient refinement | ![WIP](https://img.shields.io/badge/WIP-yellow)  |  [Léodasce Sewanou](https://github.com/Akos299) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) |  |
| Modified second derivative refinement | ![WIP](https://img.shields.io/badge/WIP-yellow)  |  [Léodasce Sewanou](https://github.com/Akos299) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) |  |

#### Slope limiters

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| None | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) |  |
| Minmod | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) |  |
| VanLeer | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) |  |
| Symmetrized VanLeer | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) & [Thomas Guillet](https://github.com/thomasguillet) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) |  |

#### Riemann solvers

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Rusanov | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) & [Thomas Guillet](https://github.com/thomasguillet) |  |  |
| HLL | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) & [Thomas Guillet](https://github.com/thomasguillet) |  |  |
| HLLC | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Léodasce Sewanou](https://github.com/Akos299) |  |
| Dusty HLL | ![WIP](https://img.shields.io/badge/WIP-yellow) |  [Léodasce Sewanou](https://github.com/Akos299) |  |
| HB dust solver | ![WIP](https://img.shields.io/badge/WIP-yellow) |  [Léodasce Sewanou](https://github.com/Akos299) |  |

### Zeus model

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Core solver | ![Ok](https://img.shields.io/badge/Ok-yellowgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | Needs some polishing to be considered production ready |

### NBody FMM solver

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Core solver | ![WIP](https://img.shields.io/badge/WIP-yellow) |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical)  | WIP of a N-Body FMM self-gravity solver, physically correct but not usable for any production runs yet. |

## Framework

### Software

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Python integration | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Test library | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| CI/CD | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |

### Shamrock internal libraries

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Shamalgs | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shambackends | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shambase | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shambindings | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shamcmdopt | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shamcomm | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shammath | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shammodels | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shamphys | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shamrock | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shamsolvergraph | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | ![Wait for the paper !](https://img.shields.io/badge/Wait_for_the_paper_!-critical) | [![PR - #1984](https://img.shields.io/badge/PR-%231984-brightgreen?logo=github)](https://github.com/Shamrock-code/Shamrock/pull/1984) |
| Shamsys | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shamtest | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shamtree | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |
| Shamunits | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen)  |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D) | |

### Components

| Feature  | Status   | Contributor / Maintainer  |  Paper to cite | Details |
| --- | --- | --- | --- |  --- |
| Patch system | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen) |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D)  |
| Sparse communications | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen) |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D)  |
| Radix Tree | ![Production ready](https://img.shields.io/badge/Production_ready-brightgreen) |  [Timothée David--Cléris](https://github.com/tdavidcl) | [![Nasa ads](https://img.shields.io/badge/nasa_ADS-Shamrock1-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025MNRAS.539....1D)  |