GreenPolyProducts/cantera
5
0
Fork 0
mirror of https://github.com/Cantera/cantera.git synced 2025-02-25 18:55:29 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
c533ca90bbfe3846674adab216aaaf616b044f41
cantera/doc/sphinx/reference.md
Ray Speth c533ca90bb [Doc] Flatten output directory structure 
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx
index can be the full site index.

Partially addresses Cantera/cantera-website#229
2023-10-09 16:40:37 -04:00

1.2 KiB
Raw Blame History

Reference

This pages provide detailed reference documentation for Cantera.

Programming Reference

These sections document the classes and functions that define the Cantera interface for each available programming language, as well as the structure of Cantera's YAML mechanism files.

:gutter: 3

```{grid-item-card} YAML Format Reference
:link: yaml/index
:link-type: doc
:text-align: center
```

```{grid-item-card} Python API Reference
:link: cython/index
:link-type: doc
:text-align: center
```

```{grid-item-card} Matlab API Reference
:link: matlab/index
:link-type: doc
:text-align: center
```

```{grid-item-card} C++ API Reference
:link: cxx/index.html
:text-align: center
```


:hidden:
:maxdepth: 1
:caption: API Reference

yaml/index
cython/index
matlab/index

Science Reference

These sections document the scientific theories, mathematical models, and numerical methods implemented by Cantera

:gutter: 3

```{grid-item-card} Reactors
:link: reference/science/reactors/index
:link-type: doc
:text-align: center
```


:hidden:
:maxdepth: 1
:caption: Science Reference

reference/science/reactors/index