Skip to content

Commit 4490e47

Browse files
committed
Docs: Documented the external library feature
1 parent 324db55 commit 4490e47

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

documentation/source/users/rmg/input.rst

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ by Benson's method.
4949

5050
For example, if you wish to use the GRI-Mech 3.0 mechanism [GRIMech3.0]_ as a ThermoLibrary in your model, the syntax will be::
5151

52-
thermoLibraries = ['primaryThermoLibrary','GRI-Mech3.0']
52+
thermoLibraries = ['primaryThermoLibrary', 'GRI-Mech3.0']
5353

5454
.. [GRIMech3.0] Gregory P. Smith, David M. Golden, Michael Frenklach, Nigel W. Moriarty, Boris Eiteneer, Mikhail Goldenberg, C. Thomas Bowman, Ronald K. Hanson, Soonho Song, William C. Gardiner, Jr., Vitali V. Lissianski, and Zhiwei Qin http://combustion.berkeley.edu/gri-mech/
5555
@@ -78,7 +78,7 @@ In the following example, the user has created
7878
a reaction library with a few additional reactions specific to n-butane, and these reactions
7979
are to be used in addition to the Glarborg C3 library::
8080

81-
reactionLibraries = [('Glarborg/C3',False)],
81+
reactionLibraries = [('Glarborg/C3', False)],
8282

8383
The keyword False/True permits user to append all unused reactions (= kept in the edge) from this library to the chemkin file.
8484
True means those reactions will be appended. Using just the string inputs would lead to
@@ -104,6 +104,23 @@ given in each mechanism, the different mechanisms can have different units.
104104
Library.
105105

106106

107+
.. _externallib:
108+
109+
External Libraries
110+
------------------
111+
Users may direct RMG to use thermo and/or kinetic libraries which are not included in the RMG database,
112+
e.g., a library a user created that was intentionally saved to a path different than the conventional
113+
RMG-database location. In such cases, the user can specify the full path to the library in the input file::
114+
115+
thermoLibraries = ['path/to/your/thermo/library/file.py']
116+
117+
or::
118+
119+
reactionLibraries = [(path/to/your/kinetic/library/folder/']
120+
121+
Combinations in any order of RMG's legacy libraries and users' external libraries are allowed,
122+
and the order in which the libraries are specified is the order in which they are loaded and given priority.
123+
107124
.. _seedmechanism:
108125

109126
Seed Mechanisms

0 commit comments

Comments
 (0)