Change the order of the variables added to the modelDescription to be…

… sorted by their variableReference

CHANGELOG.md

@@ -8,6 +8,7 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 ### Changed
 
 * Generation of modelDescription.xml file to correctly generate tags for each output with 1-indexed indexes and InitialUnknowns tags
+* Generation of modelDescription.xml adds the variables (inputs, parameters and outputs) in the orderer of their valueReference. This is for the indexing to work correctly
 
 ## [1.0.2]
 

src/mlfmu/utils/fmi_builder.py

@@ -78,7 +78,14 @@ def generate_model_description(fmu_model: FmiModel) -> ElementTree:
     outputs = SubElement(model_structure, "Outputs")
     initial_unknowns = SubElement(model_structure, "InitialUnknowns")
 
-    for var in fmu_model.get_fmi_model_variables():
+    # Get all variables to add them inside the <ModelVariables> tag
+    model_variables = fmu_model.get_fmi_model_variables()
+
+    # The variables needs to be added in the order of their valueReference
+    sorted_model_variables = sorted(model_variables, key=lambda x: x.variable_reference)
+
+    # Add each variable inside the <ModelVariables> tag
+    for var in sorted_model_variables:
         # XML variable attributes
         var_attrs = {
             "name": var.name,