From 32be0534077be09c12f0a8958bdf264ddfbdf4f2 Mon Sep 17 00:00:00 2001 From: Bryan Weber Date: Tue, 25 Apr 2023 14:07:10 -0400 Subject: [PATCH] Add a bit more docs --- doc/sphinx/cython/units.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/doc/sphinx/cython/units.rst b/doc/sphinx/cython/units.rst index 28178f67f8..f5036671a1 100644 --- a/doc/sphinx/cython/units.rst +++ b/doc/sphinx/cython/units.rst @@ -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 `__ -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 `__. +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 -------------------