Skip to content

Commit

Permalink
Add a bit more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bryanwweber authored and speth committed Apr 25, 2023
1 parent c46adb2 commit 32be053
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion doc/sphinx/cython/units.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,14 @@ Python Interface With Units

This interface allows users to specify physical units associated with quantities.
To do so, this interface leverages the `pint <https://pint.readthedocs.io/en/stable/>`__
library to provide consistent unit conversion.
library to provide consistent unit conversion. Several examples of this interface can
be found in the ``samples/python`` folder in the
`root of the repository <https://github.com/Cantera/cantera/tree/main/samples/python>`__.
Examples that use this interface are suffixed with `_units`.

The overall goal is to provide a compatible implementation of the `cantera.Solution` and
`cantera.PureFluid` interfaces. Please see those pages for further documentation of the
available properties.

Solution with Units
-------------------
Expand Down

0 comments on commit 32be053

Please sign in to comment.