research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
6859 commits 2 branches 16 tags 37 MiB
Commit graph

32 commits

Author SHA1 Message Date
band-a-prend
59eabbe454
[SCons/Doc] Fix installation of Sphinx docs 
Fix installation of Cantera Sphinx Documentation
via similar way as it was done for Doxygen documentation
https://github.com/Cantera/cantera/commit/8f2468d
 2018-09-26 02:18:32 +03:00
Ray Speth
8f2468da52 [SCons/Doc] Fix installation of Doxygen docs 
Fixes regression introduced in b84d3e3, where the organization of files in the built
documentation changed.

Fixes #553
 2018-08-24 09:24:45 -04:00
Bryan W. Weber
21db5d84f3 Move Matlab docs out of the code-docs subfolder 
Now that examples are gone, it's not needed anymore.
 2018-07-29 17:47:14 -04:00
Bryan W. Weber
b68a87d624 Make Matlab doc sections more consistent with Python sections 2018-07-29 17:47:14 -04:00
Bryan W. Weber
7a69386b8d Remove unused SConscript functions for building Python examples 2018-07-29 17:47:14 -04:00
Bryan W. Weber
e81cac9582 [Examples] Remove building Matlab examples into the docs 
They have moved to the new website
 2018-07-29 17:47:14 -04:00
Bryan W. Weber
7b6d04c381 [Examples] Remove building Python examples into the documentation 2018-07-29 17:47:14 -04:00
Ray Speth
7d0bc71448 [SCons] Make build scripts compatible with SCons 3.0.0 and Python 3 2017-10-05 13:48:54 -04:00
KyleLinevitchJr
43bd96b5ba [Matlab] Make counterflow diffusion flame simulation more general 
The CounterFlowDiffusionFlame (CFDF) code is able to perform more general cases
of npflame_init for multiple species fuel and oxidizer streams. The
stoichiometric mixture fraction in the CFDF code uses the Bilger definition of
mixture fraction, using the conservation of elements C, H, and O. This method is
used in the python module, but not the MATLAB npflame_init function.

Also, the CFDF code uses the fuel stream density to calculate the fuel stream
velocity and the oxidizer stream density to calculate the oxidizer stream
velocity, where as the npflame_init code uses the fuel density for both velocity
calculations.

The elementMassFraction code is a MATLAB version of the python function:
elemental_mass_fraction, which is needed to run the CFDF code.

Update the diffflame.m example to use the more general CFDF function since the
input parameters are different than the npflame_init function. This example is
the same as the diffusion_flame.py sample in the Python module.
 2017-06-10 16:44:50 -04:00
Ray Speth
3accd415e8 [Doc] Fix building Matlab Sphinx docs 
Forgot to remove references to deprecated code that has been removed
 2017-05-13 00:16:34 -04:00
Ray Speth
8e89bbb8d2 Add methods for accessing the git commit used when compiling 2017-01-20 22:43:56 -05:00
Ray Speth
5641fa83e9 [clib/Matlab] Add function for getting Cantera version 2016-11-11 23:06:35 -05:00
Bryan W. Weber
1cdc6b6d7e Add C-Lib and Matlab interface to getDataDirectories 2016-10-31 17:14:26 -04:00
Ray Speth
0c1eb4cd89 [Doc] Include summaries of each example in index of Matlab examples 2016-10-14 17:06:45 -04:00
Ray Speth
a35a0cb510 [Doc] Include summaries of each example in index of Python examples 2016-10-14 17:06:45 -04:00
Bryan W. Weber
af48524593 [Doc] Fix missing file after rename in Matlab docs 2016-01-22 17:37:41 -05:00
Ray Speth
8ce62988a1 [SCons] Remove previously-deprecated configuration options 2015-05-11 17:23:37 -04:00
Ray Speth
044235c065 [SCons] Remove unnecessary uses of pjoin 2014-10-08 16:54:49 +00:00
Ray Speth
71cabc86ef [SCons] Express dependencies for rebuilding Doxygen documentation 2014-08-25 22:18:56 +00:00
Bryan W. Weber
cd8e9242a6 [Doc] Allow differentiation of classes from functions in the Matlab docs 2014-07-18 14:37:42 +00:00
Bryan W. Weber
f4041d6fb2 [Doc] Add the ability to pseudo-autodocument MATLAB code to the SConscript file 2014-07-18 14:32:53 +00:00
Ray Speth
d2ff7dbaaa [SCons] 'clean' removes auto-generated .rst files from examples 2014-04-08 16:26:11 +00:00
Ray Speth
6266986d7b [SCons] Add specific targets for building the docs 
Documentation can be built independently of the code by using the 'scons sphinx'
and 'scons doxygen' commands, as an alternative to using the options
'sphinx_docs=y' and 'doxygen_docs=y' to 'scons build'.
 2014-03-13 21:35:39 +00:00
Ray Speth
4534bbd21b [Doc] Add all Matlab examples to the Sphinx docs 2013-08-22 21:46:37 +00:00
Ray Speth
1cedf904df [Doc] Add all Python examples to the Sphinx docs 2013-08-22 21:46:27 +00:00
Ray Speth
0c904bebfa Added infrastructure for using Sphinx to document the new Python module 
This includes adding the sphinx_cmd option to SCons, which can be set to the
Python 3 version of sphinx-build as necessary.
 2012-09-06 19:58:13 +00:00
Ray Speth
3acf30b3aa Moved build directories for docs to make relative links consistent 2012-04-04 18:45:26 +00:00
Ray Speth
b4ceb7da2e Reformatted the Python docstrings to work better with Sphinx 
This means that the docstrings are now parsed as reStructuredText.
 2012-03-13 17:34:47 +00:00
Ray Speth
09d9ded2e7 Added templates for using Sphinx to generate the Python module docs 2012-03-13 17:34:38 +00:00
Ray Speth
8150f49c2c Simplified adding SCons build and install targets 2012-03-05 20:45:20 +00:00
Ray Speth
1ece5bcc3d Some changes to make SCons faster 2012-02-23 21:25:20 +00:00
Ray Speth
3ca1eb819e SCons can now build and install the Doxygen-generated documentation 2012-02-13 17:24:44 +00:00