From 55e3dea9e93fabb818d2facfb2b700e7ebc7d069 Mon Sep 17 00:00:00 2001 From: Bruce Perry Date: Thu, 25 Jan 2024 18:16:15 -0700 Subject: [PATCH 1/2] README code moved warning, citation --- README.rst | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 48b631ef..657ddda7 100644 --- a/README.rst +++ b/README.rst @@ -4,7 +4,15 @@ PeleMP: Multiphysics solver for the Pele code suite |AMReX Badge| |Exascale Computing Project Badge| -`PeleMP` is the multiphysics code extension for `PeleC`, `PeleLM`, and `PeleLMeX`. Currently provides models for sprays and soot. +`PeleMP` was the multiphysics code extension for `PeleC`, `PeleLM`, and `PeleLMeX`. It provided models for sprays and soot. + +.. warning:: + + The physics modules and documentation of PeleMP have been moved to + `PelePhysics `_, + and this repository is now archived. Further development is continuing + within PelePhysics. The test cases have moved to the + PeleC and PeleLMeX repositorties. Getting Started ~~~~~~~~~~~~~~~ @@ -23,6 +31,20 @@ Detailed instructions are provided in the `Documentation git clone https://github.com/AMReX-Combustion/PeleMP.git ${PELEMP_HOME} +Citation +~~~~~~~~ + +To cite the Soot and Spray capabilities from PeleMP, please use the following `Journal of Fluids Engineering article `_: :: + + @article{owen2023pelemp, + title={PeleMP: The Multiphysics Solver for the Combustion Pele Adaptive Mesh Refinement Code Suite}, + author={Owen, Landon D and Ge, Wenjun and Rieth, Martin and Arienti, Marco and Esclapez, Lucas and S Soriano, Bruno and Mueller, Michael E and Day, Marc and Sankaran, Ramanan and Chen, Jacqueline H}, + journal={Journal of Fluids Engineering}, + pages={1--41}, + year={2023} + } + + Dependencies ~~~~~~~~~~~~ From f7eb78b2c4c6fca4d8c137c2d261227f8527820d Mon Sep 17 00:00:00 2001 From: Bruce Perry Date: Thu, 25 Jan 2024 18:22:56 -0700 Subject: [PATCH 2/2] github doesnt support warning in readme rst --- README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 657ddda7..bb4fbedc 100644 --- a/README.rst +++ b/README.rst @@ -6,13 +6,13 @@ PeleMP: Multiphysics solver for the Pele code suite `PeleMP` was the multiphysics code extension for `PeleC`, `PeleLM`, and `PeleLMeX`. It provided models for sprays and soot. -.. warning:: +WARNING +------- - The physics modules and documentation of PeleMP have been moved to - `PelePhysics `_, - and this repository is now archived. Further development is continuing - within PelePhysics. The test cases have moved to the - PeleC and PeleLMeX repositorties. +The physics modules and documentation of PeleMP have been moved to +`PelePhysics `_, +and this repository is now archived. Further development is continuing +within PelePhysics. The test cases have moved to the PeleC and PeleLMeX repositorties. Getting Started ~~~~~~~~~~~~~~~