From f85e49a87b45dcb5cda9de6ad1907a05d7467c97 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Thu, 29 May 2014 18:34:38 +0000 Subject: [PATCH] [Doc] Update methods for doing manual cti to ctml conversions --- doc/sphinx/cti/input-files.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/sphinx/cti/input-files.rst b/doc/sphinx/cti/input-files.rst index e2e4694f0..d55dd4686 100644 --- a/doc/sphinx/cti/input-files.rst +++ b/doc/sphinx/cti/input-files.rst @@ -363,16 +363,21 @@ If you are interested in seeing the internals of how the preprocessing works, take a look at file ``ctml_writer.py`` in the Cantera Python package. Or simply start Python, and type:: - >>> import ctml_writer - >>> help(ctml_writer) + >>> import cantera.ctml_writer + >>> help(cantera.ctml_writer) The ``ctml_writer.py`` module can also be run as a script to convert input .cti files to CTML. For example, if you have an input file ``phasedefs.cti``, then simply type at the command line:: - python ctml_writer.py phasedefs.cti + python -m cantera.ctml_writer phasedefs.cti -to create CTML file ``phasedefs.xml``. +to create CTML file ``phasedefs.xml``. On systems which support running Python +scripts directly, a script to run ``ctml_writer`` directly is also installed. If +the Cantera ``bin`` directory is on your ``PATH``, you can also do the +conversion by running:: + + ctml_writer phasedefs.cti Of course, most of the time creation of the CTML file will happen behind the scenes, and you will not need to be concerned with CTML files at all.