Dependencies

As of the most recent version, Krajjat relies on 11 other python packages and 1 software in order to run all the functions properly. When installing Krajjat, all the dependencies should install automatically. However, you may encounter some issues with PyAudio: if you do so, check the corresponding section below. You will also need to install FFmpeg if you want to create videos from the toolbox.

Python packages

chardet	chardet is used when opening a text file, to automatically detect the encoding.
	Matplotlib is used for plotting the data in graphs.
	NumPy is used to handle large arrays for faster computation: array and ndarray types are used to perform faster computation on large arrays. NaN (acronym of Not A Number) is used in order to replace missing data. This allows to avoid plotting missing data as zero values. Note The Audio object uses ndarrays by default for all of its values. In a future version of the toolbox, it is planned to turn the lists in Sequence and Pose to ndarrays for faster computation.
	OpenCV is used to read the frames from the video files in the Display functions.
openpyxl	openpyxl is used for opening and saving files in .xlsx (Excel format).
	pandas is used to create dataframes to handle the data for the Analysis functions.
	Parselmouth is used for computing the intensity, the pitch and the formants of the voice included in audio clips (the envelope is computed via SciPy).
	PyAudio is a module allowing to read audio streams. It is used in the toolbox to read audio files in the Display functions. Warning On Windows, PyAudio should install without any issue. However: On Mac, you should first ensure that `portaudio` has been installed, using the command line `brew install portaudio`. On Linux, you should also be sure to have portaudio installed.
	Pygame is a module allowing to display graphic elements in a window. While originally designed for creating video games, in Krajjat it is used for: Displaying the sequences in all of the Display functions. Displaying the silhouette in Plot functions.
	SciPy is used for: Reading and writing .wav files, using scipy.io.wavfile.read and scipy.io.wavfile.write Getting the audio envelope using a hilbert transform, using scipy.signal.hilbert Applying band-pass filters, using scipy.signal.butter and scipy.signal.lfilter Saving files in .mat format (Matlab), using scipy.io.savemat Interpolating data using the scipy.interpolate.interp1d function
	Seaborn is used to make the graphs looking more attractive.

FFmpeg

FFmpeg is necessary in order to generate videos with save_video_sequence().

Warning

FFmpeg is not used as a Python module, but rather needs to be installed on your computer. While an installation of Krajjat using pip will install the other dependencies, you still need to manually install FFmpeg if you plan on using the toolbox to generate videos.