Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
LXCAT2YAML(1)			  User Commands 		   LXCAT2YAML(1)

NAME
     lxcat2yaml - Convert LXCat integral cross-section data to YAML format

SYNOPSIS
     lxcat2yaml   [-h]	[--input  INPUT]  [--database  DATABASE]  [--mech  MECH]
     [--phase PHASE] [--insert] [--output OUTPUT]

DESCRIPTION
     Convert the LXCat integral cross-section data in XML  format  (LXCATML)  to
     YAML format.

OPTIONS
     -h, --help
	    Show this help message and exit.

     --input INPUT
	    LXCat  electron-collision  cross  sections	input file, containing a
	    list of the electron-collision plasma reactions  with  the	electron
	    energy levels and corresponding cross sections. Must be specified.

     --database DATABASE
	    The  name  of the database. Optional. Use it when multiple databases
	    exist in the input file.

     --mech MECH
	    Cantera yaml-format reaction mechanism file. The list of the species
	    is used as the filter to determine	which  electron-collision  reac-
	    tions in the input file are parsed. In addition, the electron-colli-
	    sion reactions can be inserted automatically into the mechanism file
	    with the argument --insert and become the output file.

     --phase PHASE
	    This  specifies  the  name	of  the phase in the mechanism file. Op-
	    tional.

     --insert
	    Enable inserting the electron-collision reactions into the mechanism
	    file.  Need to use with the argument --mech to provide the mechanism
	    file.  Optional.

     --output OUTPUT
	    Specifies the OUTPUT file name. By default, the output file name  is
	    the input file name with the extension changed to .yaml.

EXAMPLES
     Basic usage with database and mechanism insertion:

	    lxcat2yaml --input=mycs.xml --database=itikawa --mech=oxygen-plasma.yaml \
		       --phase=isotropic-electron-energy-plasma --insert \
		       --output=oxygen-itikawa-plasma.yaml

     If  the lxcat2yaml script is not on your path but the Cantera Python module
     is, lxcat2yaml can also be invoked by running:

	    python -m cantera.lxcat2yaml --input=mycs.xml

     In both cases, the equal signs in the options are optional. In  the  second
     case, the xml file is converted to yaml without inserting the collision re-
     actions into the mechanism file.

SEE ALSO
     Cantera documentation at https://cantera.org

Cantera 			      2025			   LXCAT2YAML(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=lxcat2yaml&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help