Specify appropriate units for input file in documentation

Niemeyer-Research-Group / pyMARS

Python-based (chemical kinetic) Model Automatic Reduction Software

MIT License

57 stars 45 forks source link

Closed jcsutherland closed 4 years ago

jcsutherland commented 4 years ago

Documentation should include units for the following elements of the input file:

[x] pressure
[x] temperature
[x] Mole/mass fractions for composition specification. It might be nice to allow the user to specify either and convert internally
[x] end-time

The sample input file should also include units in comments for clarity

kyleniemeyer commented 4 years ago

The docs do reference the units in this section https://niemeyer-research-group.github.io/pyMARS/usage.html#autoignition-conditions, but I agree we can list these out explicitly for more clarity (and include in the example).