Source code for viiapackage.tools.nlka_assessment.viia_nlka

### ===================================================================================================================
###   NLKA tool
### ===================================================================================================================
# Copyright ©VIIA 2025

### ===================================================================================================================
###    1. Import modules
### ===================================================================================================================

# General imports
from __future__ import annotations
from typing import TYPE_CHECKING

# References for functions and classes in the viiaPackage
if TYPE_CHECKING:
    from viiapackage.viiaStatus import ViiaProject
from viiapackage.tools.nlka_assessment.viia_nlka_gui import NLKA_GUI
from viiapackage import installed_modules

# Import module fpdf, check if module is installed
# This module is used for the GUI for the NLKA assessment tool
if 'fpdf' in installed_modules:
    from fpdf import FPDF
else:
    FPDF = None


### ===================================================================================================================
###    2. NLKA assessment for VIIA
### ===================================================================================================================

[docs]def viia_nlka_tool(project: ViiaProject):
    """
    This function is developed for the NLKA assessment that is part of the VIIA project workflow. The assessment
    is performed in a seperate tool for which a graphical interface is provided. The tool should run in a
    python-editor (like PyCharm) and can't be used in DIANA.

    .. note:: The function requires the FPDF 3rd party module.
    """
    for module_name in ['fpdf']:
        if module_name not in installed_modules:
            raise ModuleNotFoundError(
                f"ERROR: The NLKA assessment requires the module '{module_name}' to be properly installed. "
                "Function is aborted.")

    # Initialise the GUI for the NLKA assessment
    NLKA_GUI.start(project)

### ===================================================================================================================
###    3. End of script
### ===================================================================================================================