nrgpy.utils.encodings module#

class nrgpy.utils.encodings.convert_utf16le_to_utf8(filename='', input_directory='', output_directory='', inplace=False)[source]#

Bases: object

for making Spidar data files compatible with programs that do not support utf-16-le character encoding

Parameters:
filenamestr

(optional) path of file to convert

input_directorystr

(optional) path of directory with files to convert

output_directorystr

(optional) path of directory store converted files in

inplacebool

(False) if true, overwrites filename provided

Returns:
None

Examples

convert single file

>>> import nrgpy
>>> filename = "/path/to/files/file.zip"
>>> nrgpy.convert_utf16le_to_utf8(filename)

convert directory of files

>>> input_directory = "/path/to/files/"
>>> nrgpy.convert_utf16le_to_utf8(input_directory=input_directory)
single_file()[source]#