AMReX-Combustion / PelePhysics

A collection of physics databases and implementation code for use with the Pele suite of of codes
https://amrex-combustion.github.io/PelePhysics/
Other
57 stars 51 forks source link

Update the CEPTR usage doc slightly. #499

Closed EnnaDelfen closed 3 months ago

EnnaDelfen commented 4 months ago

Hi Marc, here's the PR with a couple modifs to the CEPTR documentation. I reorganized the section a little for it to follow the actual steps performed (generate a yaml first, then generate the single mechanisms file, then maybe to the batch generation). I also made sure the arguments given in the code snippets are the same as in the text because it was confusing me at times. I've tried clarifying the commands for generating a single QSS YAML file and then I wanted to explain the steps for generating a single QSS Pele mechanism file BEFORE the batch generation is mentioned - but then I found that there's an entire other section dedicated to that so I let the reference to it and simply moved the QSS section before the batched section. Finally I warned users that one may need a certain Python version/Cantera to be installed. Overall, very little but I think it's a tad improved.