[Doc] Use sphinx-tags to enable finding examples by tag

This commit is contained in:
Ray Speth
2023-10-03 11:23:39 -04:00
committed by Ray Speth
parent 6c0b9b80fc
commit 9db15111b6
8 changed files with 31 additions and 6 deletions
+5
View File
@@ -1,2 +1,7 @@
Python Examples
===============
.. seealso::
To find examples covering a specific topic, see the
:ref:`index of example tags <tagoverview>`.
+2 -1
View File
@@ -19,7 +19,8 @@ for elementary and Blower-Masel reactions. The second plot shows the activation
change of a Blowers-Masel reaction with respect to the delta enthalpy of the reaction.
Requires: cantera >= 2.6.0, matplotlib >= 2.0
Keywords: kinetics, sensitivity analysis
.. tags:: Python, kinetics, sensitivity analysis
"""
import cantera as ct
+2 -1
View File
@@ -7,7 +7,8 @@ An example demonstrating how to use custom reaction objects.
For benchmark purposes, an ignition test is run to compare simulation times.
Requires: cantera >= 3.0.0
Keywords: kinetics, benchmarking, user-defined model
.. tags:: Python, kinetics, benchmarking, user-defined model
"""
from timeit import default_timer
@@ -11,7 +11,8 @@ mechanism and the submechanism, which demonstrates that the submechanism
contains all of the important species and reactions.
Requires: cantera >= 2.6.0, matplotlib >= 2.0
Keywords: kinetics, combustion, 1D flow, editing mechanisms, plotting
.. tags:: Python, kinetics, combustion, 1D flow, editing mechanisms, plotting
"""
from timeit import default_timer
@@ -16,8 +16,10 @@ to see whether the reduced mechanisms with a certain number of species are able
to adequately simulate the ignition delay problem.
Requires: cantera >= 2.6.0, matplotlib >= 2.0
Keywords: kinetics, combustion, reactor network, editing mechanisms, ignition delay,
plotting
.. tags:: Python, kinetics, combustion, reactor network, editing mechanisms,
ignition delay, plotting
"""
import cantera as ct
+2 -1
View File
@@ -8,7 +8,8 @@ Graphviz can be obtained from https://www.graphviz.org/ or (possibly) installed
using your operating system's package manager.
Requires: cantera >= 2.5.0
Keywords: kinetics, reaction path analysis, pollutant formation
.. tags:: Python, kinetics, reaction path analysis, pollutant formation
"""
from subprocess import run