Export4Pele

Functions

`export_pele`(fuel[, path, units, ...])	Export fuel properties to input file for Pele simulations.
`main`()	Main function to execute the export process.
`vec_to_str`(vec)	Convert a list or numpy array to a string representation.

Export4Pele.export_pele(fuel, path='/home/runner/work/FuelLib/FuelLib/exportData', units='mks', dep_fuel_names=None, max_dep_fuels=30)

Export fuel properties to input file for Pele simulations.

Parameters:

fuel (fuel object) – An instance of the fuel class.
path (str, optional (default: FuelLib/exportData)) – Directory to save the input file.
units (str, optional (default: "mks")) – Units for the properties (“mks” for SI, “cgs” for CGS).
dep_fuel_names (list of str, optional (default: None)) – List or single fuel that each compound deposits to.
max_dep_fuels (int, optional (default: 30)) – Maximum number of deposition fuels to consider.

Returns:

None

Return type:

None

Export4Pele.main()

Main function to execute the export process.

Parameters:

--fuel_name (str) – Name of the fuel (mandatory).
--units (str, optional) – Units for critical properties. Options are “mks” (default) or “cgs”.
--dep_fuel_names (str, optional) – Space-separated list with len(fuel.compounds) or single fuel that all compounds deposit. Default is fuel.compounds.
--max_dep_fuels (int, optional) – Maximum number of deposition fuels to consider. Default is 30.
--export_dir (str, optional) – Directory to export the properties. Default is “FuelLib/exportData”.

Raises:

FileNotFoundError – If required files for the specified fuel are not found.

Export4Pele.vec_to_str(vec)

Convert a list or numpy array to a string representation.