Mercurial > hg > cfcfd3
changeset 33:9aefbfafb6d1
Sphinx docs: Added air-Mach-12.3 example to poshax3 documentation.
In this commit, I have added a poshax3 subdirectory to the sphinx
source area. I added symlinks (ln -s TARGET LINKNAME) to the
sphinx/poshax3 directory which point to the real files in:
examples/poshax3/air-Mach-12.3.
I also fixed the package names for a Fedora 16 installation
as listed in getting-started.rst
| author | Rowan J. Gollan <r.gollan@uq.edu.au> |
|---|---|
| date | Tue, 07 Feb 2012 23:02:34 +1000 |
| parents | 726c26b0f216 |
| children | 580ada2fe4d8 |
| files | doc/sphinx/getting-started.rst doc/sphinx/poshax3.rst doc/sphinx/poshax3/air-Mach-12.3.rst doc/sphinx/poshax3/profile_T_rho.png doc/sphinx/poshax3/profile_moles.png examples/poshax3/air-Mach-12.3/README.txt |
| diffstat | 6 files changed, 20 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/sphinx/getting-started.rst Tue Feb 07 19:36:27 2012 +1000 +++ b/doc/sphinx/getting-started.rst Tue Feb 07 23:02:34 2012 +1000 @@ -84,9 +84,9 @@ #. gcc-gfortran #. swig #. python-devel -#. python-numeric (numpy) +#. numpy #. python-matplotlib -#. python-scipy +#. scipy #. readline-devel (for Lua) #. popt-devel
--- a/doc/sphinx/poshax3.rst Tue Feb 07 19:36:27 2012 +1000 +++ b/doc/sphinx/poshax3.rst Tue Feb 07 23:02:34 2012 +1000 @@ -3,3 +3,11 @@ Post-shock one-dimensional flow with complex chemistry and radiation. +Examples +-------- + +.. toctree:: + :maxdepth: 1 + + poshax3/air-Mach-12.3 +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/sphinx/poshax3/air-Mach-12.3.rst Tue Feb 07 23:02:34 2012 +1000 @@ -0,0 +1,1 @@ +../../../examples/poshax3/air-Mach-12.3/README.txt \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/sphinx/poshax3/profile_T_rho.png Tue Feb 07 23:02:34 2012 +1000 @@ -0,0 +1,1 @@ +../../../examples/poshax3/air-Mach-12.3/profile_T_rho.png \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/sphinx/poshax3/profile_moles.png Tue Feb 07 23:02:34 2012 +1000 @@ -0,0 +1,1 @@ +../../../examples/poshax3/air-Mach-12.3/profile_moles.png \ No newline at end of file
--- a/examples/poshax3/air-Mach-12.3/README.txt Tue Feb 07 19:36:27 2012 +1000 +++ b/examples/poshax3/air-Mach-12.3/README.txt Tue Feb 07 23:02:34 2012 +1000 @@ -2,8 +2,8 @@ Relaxation of chemically-reacting air behind a shock ===================================================== -:Author: Rowan J. Gollan <r.gollan@uq.edu.au> -:Date: 05-Feb-2012 +.. Author: Rowan J. Gollan <r.gollan@uq.edu.au> +.. Date: 05-Feb-2012 Description ----------- @@ -18,7 +18,7 @@ Files ----- -User-built files: +*User-built files:* air-Mach-12.3.cfg Input file for Poshax3. @@ -32,20 +32,20 @@ run.sh A script to execute the example and plot results. -Gas model input file: +*Gas model input file:* air-model.lua Gas model input file for direct use by Poshax3. This file is created using the ``gasfile`` program. -Output file: +*Output file:* air-Mach-12.3.data Output file from Poshax3 calculation. This contains flow properties as a function of distance downstream of the shock. *This file is only available after running the calculation.* -Data files: +*Data files:* marrone_fig3\_??.g3data Mole profiles of various species as calculated by Marrone. @@ -53,7 +53,7 @@ marrone_fig4\_??_ratio.g3data Flow property profiles (as ratio of free stream values) as calculated by Marrone. -Results files: +*Results files:* plot-data.gplot A Gnuplot input file for plotting of results.