Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation additions #181

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion documentation/source/users/rmg/database/modification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -264,4 +264,12 @@ Be sure to give errors whenever adding rules. If you don't know the uncertainty,
why do you trust the kinetics?

After you are done always check via populate reactions or the website, that your
modifications are behaving the way you expect.
modifications are behaving the way you expect.

Caveat regarding how rate rules are used by RMG and the rate parameters you input: because tunneling is
important for many chemical reactions, the rate of a reaction may not be easily represented by
a bi-Arrhenius fit. 3-parameter fits are more common. However, the resulting fit may report an
'activation energy' that is much different (possibly by 10+ kcals) than the the true barrier height.
When RMG is assembling pressure-dependent networks, it will use barrier heights from rate rules. This can
lead to very inaccurate rate calculations. To avoid this issue, try to ensure that your fitted arrhenius
activation energy truly does reflect the reaction barrier height.
11 changes: 11 additions & 0 deletions documentation/source/users/rmg/input.rst
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,17 @@ Miscellaneous options::
generatePlots=False,
)

generatedSpeciesConstraints(
maximumCarbonAtoms=10,
maximumHydrogenAtoms=10,
maximumOxygenAtoms=10,
maximumNitrogenAtoms=10,
maximumSiliconAtoms=10,
maximumSulfurAtoms=10,
maximumHeavyAtoms=10,
maximumRadicalElectrons=10,
)

Examples
========

Expand Down
2 changes: 1 addition & 1 deletion documentation/source/users/rmg/installation/linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The instructions listed below have been confirmed on a fresh Ubuntu 12.04 instal

sudo pip install numpy # install NumPy before other packages

sudo pip install scipy cython nose matplotlib quantities guppy sphinx psutil xlwt
sudo pip install scipy cython nose matplotlib quantities guppy sphinx psutil xlwt freetype2 libpng-dev

cd ~
git clone git@github.com:jwallen/PyDAS.git
Expand Down
11 changes: 10 additions & 1 deletion documentation/source/users/rmg/output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,13 @@
**************************
Analyzing the Output Files
**************************


You will see that RMG has created multiple output files and folders: ::
:file:'/chemkin input.py output.html /pdep /plot restart.pkl RMG.log /solver /species'

The :file:'/chemkin' folder will likely have a large number of chemkin formatted files. In general, these can be disregarded, as you will be mainly interested in :file:'chem.inp', the chemkin formatted input file with a species list, thermochemical database, and a kinetic mechanism. The file :file:'chem_annotated.inp' is provided as a means to help make sense of species syntax and information sources. In addition, a species dictionary,:file:'species_dictionary.txt', is generated. Either chemkin file, in addition to the dictionary, may be used as inputs in the tools section of this website to better visualize the species and reactions: http://rmg.mit.edu/simulate/chemkin
(alternatively, you can open :file:'output.html')

The :file:'/pdep' folder will contain files associated with the pressure-dependent reactions that RMG has generated. These files are formatted as input files for CanTherm.

RMG currently includes a solver for isothermal batch reactors. This is in fact a critical part of the model enlargement algorithm. If you have included simulations in your input file, the solutions will be located in :file:'/solver'. You will probably only be interested in the files with the largest number tags.
9 changes: 8 additions & 1 deletion documentation/source/users/rmg/running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,11 @@
*************
Running a Job
*************


Submitting a job is easy ::

python rmg.py input.py

We recommend you make a job-specific directory for each RMG simulation. Some jobs can take quite a while to complete, so we also recommend using a job scheduler (if working in an linux environment).