Skip to content

Commit 65adac8

Browse files
author
github-actions
committed
Automated documentation rebuild
1 parent 3c4c950 commit 65adac8

File tree

3 files changed

+20
-9
lines changed

3 files changed

+20
-9
lines changed

_sources/users/rmg/installation/anacondaDeveloper.rst.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -276,26 +276,31 @@ Running Examples
276276

277277
A number of basic examples can be run immediately. Additional example input files can be found in the ``RMG-Py/examples`` folder. Please read more on :ref:`Example Input Files <examples>` in the documentation.
278278

279-
#. **Minimal Example**: this will run an Ethane pyrolysis model. It should take less than a minute to complete. The results will be in the ``RMG-Py/testing/minimal`` folder::
279+
#. **Minimal Example**: this will run an Ethane pyrolysis model. It should take less than a minute to complete. The results will be in the ``RMG-Py/testing/eg1`` folder::
280280

281281
cd RMG-Py
282282
make eg1
283283
284-
#. **Hexadiene Example**: this will run a Hexadiene model with pressure dependence and QMTP. Note that you must have MOPAC installed for this to run. The results will be in the ``RMG-Py/testing/hexadiene`` folder::
284+
#. **Hexadiene Example**: this will run a Hexadiene model with pressure dependence and QMTP. Note that you must have MOPAC installed for this to run. The results will be in the ``RMG-Py/testing/eg2`` folder::
285285

286286
cd RMG-Py
287287
make eg2
288288
289-
#. **Liquid Phase Example**: this will run a liquid phase RMG model. The results will be in the ``RMG-Py/testing/liquid_phase`` folder ::
289+
#. **Liquid Phase Example**: this will run a liquid phase RMG model. The results will be in the ``RMG-Py/testing/eg3`` folder ::
290290

291291
cd RMG-Py
292292
make eg3
293293
294-
#. **ThermoEstimator Example**: this will run the :ref:`Thermo Estimation Module <thermoModule>` on a few molecules. Note that you must have MOPAC installed for this to run completely. The results will be in the ``RMG-Py/testing/thermoEstimator`` folder ::
294+
#. **ThermoEstimator Example**: this will run the :ref:`Thermo Estimation Module <thermoModule>` on a few molecules. Note that you must have MOPAC installed for this to run completely. The results will be in the ``RMG-Py/testing/eg4`` folder ::
295295

296296
cd RMG-Py
297297
make eg4
298298

299+
#. **RMS Constant Volume Example**: this will run a constant volume reactor using the ReactionMechanismSimulator.jl package. Note that you must have Julia and ReactionMechanismSimulator.jl installed for this to run completely. The results will be in the ``RMG-Py/testing/eg8`` folder ::
300+
301+
cd RMG-Py
302+
make eg8
303+
299304

300305
Building Documentation
301306
======================

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

users/rmg/installation/anacondaDeveloper.html

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -333,30 +333,36 @@ <h2><span class="section-number">3.3.1.2. </span>Test Suite<a class="headerlink"
333333
<h2><span class="section-number">3.3.1.4. </span>Running Examples<a class="headerlink" href="#running-examples" title="Permalink to this heading"></a></h2>
334334
<p>A number of basic examples can be run immediately. Additional example input files can be found in the <code class="docutils literal notranslate"><span class="pre">RMG-Py/examples</span></code> folder. Please read more on <a class="reference internal" href="../examples.html#examples"><span class="std std-ref">Example Input Files</span></a> in the documentation.</p>
335335
<ol class="arabic">
336-
<li><p><strong>Minimal Example</strong>: this will run an Ethane pyrolysis model. It should take less than a minute to complete. The results will be in the <code class="docutils literal notranslate"><span class="pre">RMG-Py/testing/minimal</span></code> folder:</p>
336+
<li><p><strong>Minimal Example</strong>: this will run an Ethane pyrolysis model. It should take less than a minute to complete. The results will be in the <code class="docutils literal notranslate"><span class="pre">RMG-Py/testing/eg1</span></code> folder:</p>
337337
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">RMG</span><span class="o">-</span><span class="n">Py</span>
338338
<span class="n">make</span> <span class="n">eg1</span>
339339
</pre></div>
340340
</div>
341341
</li>
342-
<li><p><strong>Hexadiene Example</strong>: this will run a Hexadiene model with pressure dependence and QMTP. Note that you must have MOPAC installed for this to run. The results will be in the <code class="docutils literal notranslate"><span class="pre">RMG-Py/testing/hexadiene</span></code> folder:</p>
342+
<li><p><strong>Hexadiene Example</strong>: this will run a Hexadiene model with pressure dependence and QMTP. Note that you must have MOPAC installed for this to run. The results will be in the <code class="docutils literal notranslate"><span class="pre">RMG-Py/testing/eg2</span></code> folder:</p>
343343
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">RMG</span><span class="o">-</span><span class="n">Py</span>
344344
<span class="n">make</span> <span class="n">eg2</span>
345345
</pre></div>
346346
</div>
347347
</li>
348-
<li><p><strong>Liquid Phase Example</strong>: this will run a liquid phase RMG model. The results will be in the <code class="docutils literal notranslate"><span class="pre">RMG-Py/testing/liquid_phase</span></code> folder</p>
348+
<li><p><strong>Liquid Phase Example</strong>: this will run a liquid phase RMG model. The results will be in the <code class="docutils literal notranslate"><span class="pre">RMG-Py/testing/eg3</span></code> folder</p>
349349
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">RMG</span><span class="o">-</span><span class="n">Py</span>
350350
<span class="n">make</span> <span class="n">eg3</span>
351351
</pre></div>
352352
</div>
353353
</li>
354-
<li><p><strong>ThermoEstimator Example</strong>: this will run the <a class="reference internal" href="../modules/thermoEstimation.html#thermomodule"><span class="std std-ref">Thermo Estimation Module</span></a> on a few molecules. Note that you must have MOPAC installed for this to run completely. The results will be in the <code class="docutils literal notranslate"><span class="pre">RMG-Py/testing/thermoEstimator</span></code> folder</p>
354+
<li><p><strong>ThermoEstimator Example</strong>: this will run the <a class="reference internal" href="../modules/thermoEstimation.html#thermomodule"><span class="std std-ref">Thermo Estimation Module</span></a> on a few molecules. Note that you must have MOPAC installed for this to run completely. The results will be in the <code class="docutils literal notranslate"><span class="pre">RMG-Py/testing/eg4</span></code> folder</p>
355355
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">RMG</span><span class="o">-</span><span class="n">Py</span>
356356
<span class="n">make</span> <span class="n">eg4</span>
357357
</pre></div>
358358
</div>
359359
</li>
360+
<li><p><strong>RMS Constant Volume Example</strong>: this will run a constant volume reactor using the ReactionMechanismSimulator.jl package. Note that you must have Julia and ReactionMechanismSimulator.jl installed for this to run completely. The results will be in the <code class="docutils literal notranslate"><span class="pre">RMG-Py/testing/eg8</span></code> folder</p>
361+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">RMG</span><span class="o">-</span><span class="n">Py</span>
362+
<span class="n">make</span> <span class="n">eg8</span>
363+
</pre></div>
364+
</div>
365+
</li>
360366
</ol>
361367
</section>
362368
<section id="building-documentation">

0 commit comments

Comments
 (0)