Ray Speth
5adb325f18
[Doc] Transfer glossary and link terms in some places
2024-01-16 17:17:39 -05:00
Ray Speth
cabeac3311
[Doc] Provide extra links on User Guide index page
2024-01-16 17:17:39 -05:00
Ray Speth
11e142d4b7
[Doc] Transfer and condense C++ Tutorial
...
Reduce the C++ tutorial to a single page. Eliminates some redundant
content, and moves some other content that was not specific to the
C++ interface to other pages.
2024-01-16 17:17:39 -05:00
Ray Speth
c47a3028ec
[Doc] Transfer C++ compilation tutorial
2024-01-16 17:17:39 -05:00
Ray Speth
49e18e5f2b
[Doc] Transfer install landing page
2024-01-16 17:17:39 -05:00
Ray Speth
925d10e668
[Doc] Transfer OS-specific install instructions
2024-01-16 17:17:39 -05:00
Ray Speth
74a343c4d6
[Doc] Transfer Pip installation instructions
2024-01-16 17:17:39 -05:00
Ray Speth
d3e0833621
[Doc] Transfer Conda installation instructions
2024-01-16 17:17:39 -05:00
Ray Speth
035af0aa44
[Doc] Transfer release notes to main docs
2024-01-16 17:17:39 -05:00
Daniel Thomas
b5ce584652
Deleted one trailing whitespace to pass Lint checks
2024-01-12 12:01:42 -07:00
Daniel Thomas
4caecb794b
Edited docs for transport_model method for clarity
2024-01-12 12:01:42 -07:00
Ray Speth
fb53e9618b
[Doc] Improve wording about automatic third-body detection
...
Fixes Cantera/cantera-website#262
2024-01-09 11:40:20 -05:00
Ray Speth
b294740bb8
[Doc] Adopt more review suggestions for science docs
...
Co-authored-by: Steven C. DeCaluwe <steven.decaluwe@gmail.com>
2024-01-09 11:40:20 -05:00
Ray Speth
d36a07a2a3
[Doc] Introduce some LaTeX macros in Sphinx and fix text subscripts
2024-01-09 11:40:20 -05:00
Ray Speth
7aa65e55a0
[Doc] Revise science docs based on review suggestions
...
Co-authored-by: Bryan Weber <bryan.w.weber@gmail.com>
2024-01-09 11:40:20 -05:00
Ray Speth
c5b0200f9d
[CI] Update pinned Sphinx version
...
Able to update now that MyST-NB 1.0 has been released
Also build docs with a newer version of Python
2024-01-09 11:40:20 -05:00
Ray Speth
5cad2389a4
[Doc] Transfer & Revise reactor network documentation
...
Split among science reference, an introductory tutorial, and more
detailed information in the developer guide.
2024-01-09 11:40:20 -05:00
Ray Speth
21b61a6801
[Doc] Transfer ExtensibleReactor tutorial
2024-01-09 11:40:20 -05:00
Ray Speth
e5b3666f44
[Doc] Transfer PFR documentation
2024-01-09 11:40:20 -05:00
Ray Speth
7121030924
[Doc] Transfer docs for homogeneous reactors, flow devices, and walls
2024-01-09 11:40:20 -05:00
Ray Speth
955cc0c4a3
[Doc] Transfer Transport "science" docs
2024-01-09 11:40:20 -05:00
Ray Speth
66c6a39e8c
[Doc] Complete list of phase models in the Reference section
2024-01-09 11:40:20 -05:00
Ray Speth
d88fed9f09
[Doc] Revise species thermo documentation
...
Expand the description to cover both the calculation of standard-state
cp/h/s and the models that provide parameters affecting the equation
of state.
Also try to provide a description of the difference between the typical
definition of standard state and the distinction that Cantera sometimes
tries to make between "reference state" and "standard state" properties.
2024-01-09 11:40:20 -05:00
Ray Speth
066db41ad0
[Doc] Flatten structure for "science" docs
2024-01-09 11:40:20 -05:00
Ray Speth
fe3207c4ac
[Doc] Transfer Thermo "science" docs
2024-01-09 11:40:20 -05:00
Ray Speth
6e26df5576
[Doc] Transfer Kinetics "science" docs
2024-01-09 11:40:20 -05:00
Ray Speth
5c601e0fe4
[Doc] Transfer 1D flame governing equation docs
2024-01-09 11:40:20 -05:00
Ray Speth
fec6442b8b
Update AUTHORS
2024-01-05 20:28:44 -05:00
Ray Speth
dd7834566f
Fix some documentation for ReactorNet drawing
2024-01-05 20:28:44 -05:00
Ray Speth
78ba8c1818
Use pytest features in ReactorNet drawing tests
2024-01-05 20:28:44 -05:00
Niclas Garan
5c01a0a5de
simplify attribute initiation
2024-01-05 20:28:44 -05:00
Niclas Garan
2cb54f145e
updated tests
2024-01-05 20:28:44 -05:00
Niclas Garan
809c760c8d
split logic for walls and flow controller, reworked keywords
...
made sure attributes set during calls overwrite everything
2024-01-05 20:28:44 -05:00
Niclas Garan
94e1388fcd
rename dot to graph and groupname to group_name
2024-01-05 20:28:44 -05:00
Niclas Garan
04b06712ec
add docstrings to public cdef attributes
2024-01-05 20:28:44 -05:00
Niclas Garan
a1763c8e9c
add version tag to methods, functions and properties
2024-01-05 20:28:44 -05:00
Niclas Garan
6efd412906
Change graphviz package name in setup.cfg.in
...
Since these are pip-related files , the correct name is `graphviz` while `python-graphviz` is the name of the conda package.
2024-01-05 20:28:44 -05:00
Niclas Garan
04df9f404c
adjust wall velocity representation
...
Requires graphviz >= 9.0
2024-01-05 20:28:44 -05:00
Niclas Garan
c6b2d04ca8
Check for unique names, remove wrapper functions
...
If names are not unique, raise AssertionError
Regroup keyword arguments for functions
2024-01-05 20:28:44 -05:00
Niclas Garan
96c21a2b6f
add species_units keyword to draw_reactor
...
This allows to display reactors' species as either percent or ppm
2024-01-05 20:28:44 -05:00
Niclas Garan
a1e0acd8fa
Make keyword arguments explicit and adjust docstrings
2024-01-05 20:28:44 -05:00
Niclas Garan
c7cdf27c9f
Use graphviz' cluster feature to allow for grouping of reactors
...
This introduces an additional `groupname` attribute for the `Reactor` extention class
2024-01-05 20:28:44 -05:00
Niclas Garan
ff046ddd31
Ensure that drawing nodes are always given a unique name
...
Otherwise, graphviz will consider them to be the same object.
2024-01-05 20:28:44 -05:00
Niclas Garan
74d004359f
Change new rw properties into public members of extention classes
2024-01-05 20:28:44 -05:00
Niclas Garan
7e795389f6
Clean up imports and apply suggested changes in drawnetwork.py
2024-01-05 20:28:44 -05:00
Niclas Garan
7b20d8e27c
include wall movement
2024-01-05 20:28:44 -05:00
Niclas Garan
c553eb2915
Include ReactorSurface
2024-01-05 20:28:44 -05:00
Niclas Garan
9a7af06221
add optional graphviz dependency to build pipelines
2024-01-05 20:28:44 -05:00
Niclas Garan
92609d8475
add unittests for drawing methods
2024-01-05 20:28:44 -05:00
Niclas Garan
7ffd1c96bd
let direct draw edge_attr overwrite for single connection
2024-01-05 20:28:44 -05:00
