update description for application of transformations

Author: matthiasprobst

CITATION.cff

@@ -6,6 +6,6 @@ authors:
     orcid: "https://orcid.org/0000-0001-8729-0482"
 title: "ssnolib (1.5.1.2)"
 version: 1.5.1.2
-doi: 10.5281/zenodo.todo
+doi: 10.5281/zenodo.15457925
 date-released: 2025-05-18
 url: "https://github.com/matthiasprobst/ssnolib"

ssnolib/ssno/standard_name_table.py

@@ -578,24 +578,24 @@ def _get_by_transformation(self, standard_name: str) -> Union[StandardName, None
             descriptions = []
             for m in matches:
                 if isinstance(m, StandardName):
-                    descriptions.append(m.description.strip("."))
+                    descriptions.append(f"{m.standardName}: {m.description.strip('.')}.")
                 else:
-                    descriptions.append(m.hasVariableDescription.strip("."))
-            match_descriptions = ". ".join(descriptions)
+                    descriptions.append(f"{m.hasStringValue}: {m.hasVariableDescription.strip('.')}.")
+            match_descriptions = " ".join(descriptions)
             matches_standard_names = [m for m in matches if isinstance(m, StandardName)]
             combined_description = " and ".join([f"'{m.standardName}'" for m in matches_standard_names])
             if len(matches) == 1:
-                new_description = f"Derived Standard Name using transformation '{found_transformation.name}' ({found_transformation.description}) from standard name {combined_description}."
+                new_description = f"Derived standard name using transformation '{found_transformation.name}' ({found_transformation.description}) applied to {combined_description}."
             else:
-                new_description = f"Derived Standard Name using transformation '{found_transformation.name}' ({found_transformation.description}) from standard names {combined_description}."
+                new_description = f"Derived standard name using transformation '{found_transformation.name}' ({found_transformation.description}) applied to {combined_description}."
             if self.id.endswith("/"):
                 new_sn_id = self.id + "derived_standard_name/" + standard_name
             else:
                 new_sn_id = self.id + "/derived_standard_name/" + standard_name
             valid_standard_name = StandardName(id=new_sn_id,
                                                standardName=standard_name,
                                                unit=alter_unit(matches_standard_names, found_transformation),
-                                               description=new_description + " " + match_descriptions + ".")
+                                               description=new_description.strip(".") + ". " + match_descriptions)
 
             _cache_valid_standard_name(self, valid_standard_name)
             return valid_standard_name

tests/test_ssno_table.py

@@ -300,7 +300,8 @@ def test_from_jsonld_file(self):
         self.assertFalse(snt.verify_name("u_velocity"))
         self.assertTrue(snt.verify_name("x_air_density"))
         sn = snt.get_standard_name("x_velocity")
-        self.assertEqual("velocity: The velocity vector of an object or fluid. x: No description available.", sn.description)
+        self.assertEqual("velocity: The velocity vector of an object or fluid. x: No description available.",
+                         sn.description)
         self.assertEqual('http://qudt.org/vocab/unit/M-PER-SEC', sn.unit)
         self.assertEqual("x_velocity", sn.standardName)
 
@@ -566,7 +567,8 @@ def test_cf_qualifications(self):
             name="component",
             description='The direction of the spatial component of a vector is indicated by one of the words upward, downward, northward, southward, eastward, westward, x, y. The last two indicate directions along the horizontal grid being used when they are not true longitude and latitude (if there is a rotated pole, for instance). If the standard name indicates a tensor quantity, two of these direction words may be included, applying to two of the spatial dimensions Z Y X, in that order. If only one component is indicated for a tensor, it means the flux in the indicated direction of the magnitude of the vector quantity in the plane of the other two spatial dimensions. The names of vertical components of radiative fluxes are prefixed with net_, thus: net_downward and net_upward. This treatment is not applied for any kinds of flux other than radiative. Radiative fluxes from above and below are often measured and calculated separately, the "net" being the difference. Within the atmosphere, radiation from below (not net) is indicated by a prefix of upwelling, and from above with downwelling. For the top of the atmosphere, the prefixes incoming and outgoing are used instead.,',
             hasValidValues=["upward", "downward", "northward", "southward", "eastward", "westward",
-                            TextVariable(hasStringValue="x", hasVariableDescription="The x-component of the vector."), "y"]
+                            TextVariable(hasStringValue="x", hasVariableDescription="The x-component of the vector."),
+                            "y"]
         )
         at_surface = ssnolib.Qualification(
             name="surface",
@@ -923,7 +925,7 @@ def test_transformation_with_domain_concept_set(self):
             hasValidValues=[
                 TextVariable(
                     has_string_value="fan",
-                    has_variable_description="my fan"),
+                    has_variable_description="The investigated fan."),
                 TextVariable(
                     has_string_value="orifice plate",
                     has_variable_description="orifice plate to measure volume flow rate"
@@ -933,8 +935,9 @@ def test_transformation_with_domain_concept_set(self):
             id=f"https://example.org/transformation/difference_of_X_across_device",
             name="difference_of_X_across_DEVICE",
             altersUnit="[X]",
-            hasCharacter=[Character(character="X", associatedWith=SSNO.AnyStandardName),
-                          Character(character="DEVICE", associatedWith=devices), ],
+            hasCharacter=[
+                Character(character="X", associatedWith=SSNO.AnyStandardName),
+                Character(character="DEVICE", associatedWith=devices), ],
             description="Difference of a quantity across a device."
         )
         test_snt = StandardNameTable(title="Test SNT")
@@ -948,6 +951,10 @@ def test_transformation_with_domain_concept_set(self):
         # self.assertEqual("http://qudt.org/vocab/unit/M-PER-SEC", vel.unit)
         vel_across_fan = test_snt.get_standard_name("difference_of_velocity_across_fan")
         self.assertEqual("difference_of_velocity_across_fan", vel_across_fan.standardName)
+        self.assertEqual(
+            "Derived standard name using transformation 'difference_of_X_across_DEVICE' (Difference of a quantity across a device.) applied to 'velocity'. velocity: velocity. fan: The investigated fan.",
+            vel_across_fan.description
+        )
         self.assertEqual("http://qudt.org/vocab/unit/M-PER-SEC", vel_across_fan.unit)
 
         # test parsing domain concept set
@@ -959,7 +966,6 @@ def test_transformation_with_domain_concept_set(self):
 
         pathlib.Path('snt_with_domain_concept.jsonld').unlink(missing_ok=True)
 
-
     def test_get_transformed_standard_name(self):
         snt = StandardNameTable(name="Fluid SNT")
         velocity = StandardName(standardName="velocity", description="velocity", unit="m/s")