opensemantic.characteristics.quantitative 0.2.2.dev1__tar.gz → 0.2.2.dev2__tar.gz

{opensemantic_characteristics_quantitative-0.2.2.dev1 → opensemantic_characteristics_quantitative-0.2.2.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opensemantic.characteristics.quantitative
-Version: 0.2.2.dev1
+Version: 0.2.2.dev2
 Summary: Library with Python models derived from the page package world.opensemantic.characteristics.quantitative
 Home-page: https://github.com/OpenSemanticWorld-Packages/opensemantic.characteristics.quantitative-python
 Author: OpenSemanticWorld
@@ -17,12 +17,14 @@ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 License-File: LICENSE.txt
 Requires-Dist: pydantic
 Requires-Dist: pint
+Requires-Dist: pint-pandas
 Requires-Dist: oold
 Requires-Dist: opensemantic.characteristics
 Provides-Extra: testing
 Requires-Dist: setuptools; extra == "testing"
 Requires-Dist: pytest; extra == "testing"
 Requires-Dist: pytest-cov; extra == "testing"
+Requires-Dist: scipy; extra == "testing"
 Dynamic: license-file
 
 <!-- These are examples of badges you might want to add to your README:

{opensemantic_characteristics_quantitative-0.2.2.dev1 → opensemantic_characteristics_quantitative-0.2.2.dev2}/setup.cfg

@@ -27,6 +27,7 @@ python_requires = >=3.11
 install_requires = 
 	pydantic
 	pint
+	pint-pandas
 	oold
 	opensemantic.characteristics
 
@@ -40,6 +41,7 @@ testing =
 	setuptools
 	pytest
 	pytest-cov
+	scipy
 
 [options.entry_points]
 

{opensemantic_characteristics_quantitative-0.2.2.dev1 → opensemantic_characteristics_quantitative-0.2.2.dev2}/src/opensemantic/characteristics/quantitative/__init__.py

@@ -10,3 +10,7 @@ finally:
     del version, PackageNotFoundError
 
 from opensemantic.characteristics.quantitative._model import *  # noqa
+from opensemantic.characteristics.quantitative._static import (  # noqa
+    QuantityValue,
+    TabularData,
+)

{opensemantic_characteristics_quantitative-0.2.2.dev1 → opensemantic_characteristics_quantitative-0.2.2.dev2}/src/opensemantic/characteristics/quantitative/_model.py

@@ -369,7 +369,7 @@ class AmountOfSubstancePerMass(QuantityValue):
 
 
 class DimensionlessUnit(UnitEnum):
-    field_ = "Item:OSW5d3fe58ebbac5483bad8904ff8811366"
+    dimensionless = "Item:OSW5d3fe58ebbac5483bad8904ff8811366"
 
 
 class Dimensionless(QuantityValue):
@@ -398,7 +398,7 @@ class Dimensionless(QuantityValue):
 
     type: Optional[Any] = ["Category:OSWbcaa33bd770e53e09d5e6087d141648b"]
     unit: Optional[DimensionlessUnit] = Field(
-        DimensionlessUnit.field_,
+        DimensionlessUnit.dimensionless,
         options={"enum_titles": ["#"]},
         title="DimensionlessUnit",
         x_enum_varnames=[""],
@@ -1595,7 +1595,7 @@ class Dimensionless(QuantityValue):
 
     type: Optional[Any] = ["Category:OSWbcaa33bd770e53e09d5e6087d141648b"]
     unit: Optional[DimensionlessUnit] = Field(
-        DimensionlessUnit.field_,
+        DimensionlessUnit.dimensionless,
         options={"enum_titles": ["#"]},
         title="DimensionlessUnit",
         x_enum_varnames=[""],

{opensemantic_characteristics_quantitative-0.2.2.dev1 → opensemantic_characteristics_quantitative-0.2.2.dev2}/src/opensemantic/characteristics/quantitative/_static.py

@@ -10,11 +10,13 @@ else:
 
 from typing import Any, Dict, List, Optional, Union
 
+import pandas as pd
+
 # pip install pint
 import pint
+import pint_pandas  # noqa: F401
 from oold.model.v1 import LinkedBaseModelMetaClass as ModelMetaclass
-from pint import UnitRegistry
-from pydantic.v1 import Field
+from pydantic.v1 import Field, create_model
 from pydantic.v1.fields import FieldInfo
 
 from opensemantic import OswBaseModel
@@ -80,7 +82,7 @@ class Characteristic(OswBaseModel):
     # uuid: UUID = Field(default_factory=uuid4, options={"hidden": True}, title="UUID")
 
 
-ureg = UnitRegistry()
+ureg = pint.get_application_registry()
 
 quantity_registry: Dict[EnumType, ModelMetaclass] = {}
 
@@ -212,6 +214,11 @@ class QuantityValue(Characteristic, metaclass=QuantityValueMetaclass):
         pint_quantity = self.to_pint().to_base_units()
         return self.from_pint(pint_quantity, simplify=False)
 
+    def __eq__(self, other: "QuantityValue") -> bool:
+        if isinstance(other, QuantityValue):
+            other = other.to_pint()
+        return self.to_pint() == other
+
     def __add__(self, other: "QuantityValue") -> "QuantityValue":
         res_pint = self.to_pint() + other.to_pint()
         return self.from_pint(res_pint)
@@ -220,8 +227,94 @@ class QuantityValue(Characteristic, metaclass=QuantityValueMetaclass):
         res_pint = self.to_pint() - other.to_pint()
         return self.from_pint(res_pint)
 
+    # * operator
     def __mul__(self, other: Union["QuantityValue", float, int]) -> "QuantityValue":
         if not isinstance(other, (float, int)):
             other = other.to_pint()
         res_pint = self.to_pint() * other
         return self.from_pint(res_pint)
+
+    # / operator
+    def __truediv__(self, other: Union["QuantityValue", float, int]) -> "QuantityValue":
+        if not isinstance(other, (float, int)):
+            other = other.to_pint()
+        res_pint = self.to_pint() / other
+        return self.from_pint(res_pint)
+
+
+class TabularData(OswBaseModel):
+    # rows: List[Any] # convention for tabular data is a list of rows
+
+    # consider https://stackoverflow.com/questions/51505504/pandas-nesting-dataframes # noqa: E501
+    # consider https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.attrs.html # noqa: E501
+
+    def to_df(self) -> pd.DataFrame:
+        series = []
+        row_class = self.__class__.__fields__["rows"].type_
+        for attr in row_class.__fields__.keys():
+            q_name = (
+                row_class.__fields__[attr]
+                .type_.__fields__["unit"]
+                .default.name.replace("_", " ")
+            )
+            # q_pint = ureg[q_name]
+            s = pd.Series(
+                [
+                    (
+                        getattr(m, attr).to_pint().to(q_name).magnitude
+                        if getattr(m, attr, None) is not None
+                        else None
+                    )
+                    for m in self.rows
+                ],
+                dtype="pint[" + q_name + "]",
+                name=attr,
+            )
+            series.append(s)
+        rows = {s.name: s for s in series}
+        return pd.DataFrame(rows)
+
+    @classmethod
+    def from_df(cls, df: pd.DataFrame):
+        rows = []
+        row_class = OswBaseModel
+        if "rows" in cls.__fields__:
+            row_class = cls.__fields__["rows"].type_
+
+        additional_fields = {}
+        for key in df.columns:
+            # print(df[key].pint.__dict__)
+            if key not in row_class.__fields__.keys():
+                # raise ValueError(f"Column '{key}' not found in '{row_class.__name__}'") # noqa: E501
+                quantity = QuantityValue.from_pint(
+                    1 * getattr(df.dtypes, key).units
+                ).__class__
+                additional_fields[key] = (quantity, ...)
+
+        if len(additional_fields) > 0:
+            row_class = create_model(
+                row_class.__name__ + "Extended", **additional_fields, __base__=row_class
+            )
+            cls = create_model(
+                cls.__name__ + "Extended",
+                **{"rows": (List[row_class], ...)},
+                __base__=cls,
+            )
+
+        # convert all columns to the default unit
+        for attr in row_class.__fields__.keys():
+            q_name = (
+                row_class.__fields__[attr]
+                .type_.__fields__["unit"]
+                .default.name.replace("_", " ")
+            )
+            q_pint = ureg[q_name]
+            df[attr] = df[attr].pint.to(q_pint)
+
+        for i, row in df.iterrows():
+            # create a dictionary with the values of the row
+            # using the column names as keys
+            d = {key: {"value": row[key].magnitude} for key in df.columns}
+            m = row_class(**d)
+            rows.append(m)
+        return cls(rows=rows)

{opensemantic_characteristics_quantitative-0.2.2.dev1 → opensemantic_characteristics_quantitative-0.2.2.dev2}/src/opensemantic.characteristics.quantitative.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opensemantic.characteristics.quantitative
-Version: 0.2.2.dev1
+Version: 0.2.2.dev2
 Summary: Library with Python models derived from the page package world.opensemantic.characteristics.quantitative
 Home-page: https://github.com/OpenSemanticWorld-Packages/opensemantic.characteristics.quantitative-python
 Author: OpenSemanticWorld
@@ -17,12 +17,14 @@ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 License-File: LICENSE.txt
 Requires-Dist: pydantic
 Requires-Dist: pint
+Requires-Dist: pint-pandas
 Requires-Dist: oold
 Requires-Dist: opensemantic.characteristics
 Provides-Extra: testing
 Requires-Dist: setuptools; extra == "testing"
 Requires-Dist: pytest; extra == "testing"
 Requires-Dist: pytest-cov; extra == "testing"
+Requires-Dist: scipy; extra == "testing"
 Dynamic: license-file
 
 <!-- These are examples of badges you might want to add to your README:

{opensemantic_characteristics_quantitative-0.2.2.dev1 → opensemantic_characteristics_quantitative-0.2.2.dev2}/src/opensemantic.characteristics.quantitative.egg-info/requires.txt

@@ -1,5 +1,6 @@
 pydantic
 pint
+pint-pandas
 oold
 opensemantic.characteristics
 
@@ -7,3 +8,4 @@ opensemantic.characteristics
 setuptools
 pytest
 pytest-cov
+scipy

opensemantic_characteristics_quantitative-0.2.2.dev2/tests/integration_test.py

@@ -0,0 +1,238 @@
+import json
+from typing import List, Optional
+
+from scipy.stats import linregress
+
+from opensemantic import OswBaseModel
+from opensemantic.characteristics.quantitative import (
+    Area,
+    AreaUnit,
+    Force,
+    ForcePerAreaUnit,
+    ForceUnit,
+    Length,
+    LengthUnit,
+    LinearStrain,
+    ModulusOfElasticity,
+    QuantityValue,
+    Stress,
+    TabularData,
+    Thickness,
+    Width,
+)
+
+# to we have to adapt VSCode settings to include the package index?
+# "python.analysis.packageIndexDepths": [
+#       {"name": "opensemantic.characteristics.quantitative",
+#       "depth": 4, "includeAllSymbols": true}
+# ]
+
+
+def test_pint():
+
+    q = Length(value=1.0, unit=LengthUnit.milli_meter)
+    # transform to pint
+    q_pint = q.to_pint()
+    # transform back to QuantityValue
+    q_ = QuantityValue.from_pint(q_pint)
+    assert q == q_
+
+    q2 = Length(value=1.0, unit=LengthUnit.meter)
+    q3 = q + q2
+    assert q3 == Length(value=1.001, unit=LengthUnit.meter)
+
+    q31 = q * q2
+    assert q31 == Area(value=1000.0, unit=AreaUnit.milli_meter_squared)
+
+    q41 = Area(value=1.0, unit=AreaUnit.meter_squared)
+    q42 = Area(value=1.0, unit=AreaUnit.milli_meter_squared)
+    # 'square_meter' is not a valid unit for pint, but 'square_meter' is
+    q43 = q41 + q42
+    assert q43 == Area(value=1.000001, unit=AreaUnit.meter_squared)
+
+
+def test_export():
+
+    q = Length(value=1.0, unit=LengthUnit.milli_meter)
+
+    q_json = json.loads(q.json(exclude_none=True))
+    print(q_json)
+    assert q_json == {
+        "type": ["Category:OSWee9c7e5c343e542cb5a8b4648315902f"],
+        "value": 1.0,
+        "unit": str(
+            "Item:OSWf101d25e944856e3bd4b4c9863db7de2"
+            "#OSW322dec469be75aedb008b3ebff29db86"
+        ),
+    }
+
+    q = Length(value=1.0, unit=LengthUnit.meter)
+
+    q_json = json.loads(q.json(exclude_none=True))
+    print(q_json)
+    assert q_json == {
+        "type": ["Category:OSWee9c7e5c343e542cb5a8b4648315902f"],
+        "value": 1.0,
+        "unit": "Item:OSWf101d25e944856e3bd4b4c9863db7de2",
+    }
+
+    q_json = json.loads(q.json(exclude_none=True, exclude_defaults=True))
+    print(q_json)
+    assert q_json == {"value": 1.0}
+
+    ln = Length(value=0.1)
+    w = Width(value=200, unit=LengthUnit.milli_meter)
+    a = ln * w
+    print(a)
+
+    json_dict = a.dict()
+    print(json_dict)
+    assert json_dict["type"] == ["Category:OSW1fcf1694712e5684885071efdf775bd9"]
+    assert json_dict["value"] == 20000.0
+    assert json_dict["unit"] == (
+        "Item:OSWd10e5841c68e5aad94b481b58ef9dfb9"
+        "#OSWeca22bf4270853038ef3395bd6dd797b"
+    )
+
+    # _a = QuantityValue(**json_dict)
+
+    _a = a.to_base()
+    json_dict = _a.dict(exclude_none=True, exclude_defaults=True)
+    print(json_dict)
+    assert json_dict["value"] == 0.02
+    assert len(json_dict.keys()) == 1
+
+    __a = Area(**json_dict)
+    assert __a == _a
+
+    # not supported yet
+    # jsonld_dict = a.to_jsonld()
+    # print(json.dumps(jsonld_dict, indent=2))
+
+    # a2 = QuantityValue.from_jsonld(jsonld_dict)
+    # print(a2)
+
+
+def test_pandas():
+
+    class Measurement(OswBaseModel):
+        length: Length
+        width: Width
+        area: Optional[Area] = None
+
+    class MeasurementData(TabularData):
+        rows: List[Measurement]
+
+    measurement = MeasurementData(
+        rows=[
+            Measurement(length=Length(value=1.0), width=Width(value=2.0)),
+            Measurement(length=Length(value=3.0), width=Width(value=4.0)),
+        ]
+    )
+    df = measurement.to_df()
+    print(df)
+    df["area"] = df["length"] * df["width"]
+    print(df)
+    measurement2 = MeasurementData.from_df(df)
+    print(measurement2)
+    measurement3 = TabularData.from_df(df)
+    print(measurement3.json(exclude_none=True, exclude_defaults=True, indent=2))
+    # print(measurement3.__class__.schema_json(indent=2))
+
+
+def test_tensile_test():
+
+    class TensileTestSpecimen(OswBaseModel):
+        length: Length
+        width: Width
+        thickness: Length
+        cross_section_area: Optional[Area] = None
+        e_mod: Optional[ModulusOfElasticity] = None
+
+    class TensileTestResultRow(OswBaseModel):
+        elongation: Length
+        force: Force
+        strain: Optional[LinearStrain] = None
+        stress: Optional[Stress] = None
+
+    class TensileTestResult(TabularData):
+        rows: List[TensileTestResultRow]
+        linear_region: Optional[LinearStrain] = LinearStrain(value=0.002)
+
+    class TensileTestDataset(OswBaseModel):
+        specimen: TensileTestSpecimen
+        result: TensileTestResult
+
+    def tensile_test_analysis(dataset: TensileTestDataset):
+        # Calculate cross section area if not provided
+        if dataset.specimen.cross_section_area is None:
+            dataset.specimen.cross_section_area = (
+                dataset.specimen.width * dataset.specimen.thickness
+            )
+
+        # Calculate stress and strain - slow iteration
+        # for row in dataset.result.rows:
+        #     #row.stress = Stress(value=row.force.value / dataset.specimen.cross_section_area.value, unit=row.force.unit)   # noqa: E501
+        #     #row.strain = LinearStrain(value=row.force.value / (dataset.specimen.e_mod.value * dataset.specimen.cross_section_area.value), unit=row.force.unit)   # noqa: E501
+        #     row.stress = row.force / dataset.specimen.cross_section_area   # noqa: E501
+
+        # Calculate stress and strain - fast as pandas DataFrame operation
+        df = dataset.result.to_df()
+        df["strain"] = df["elongation"] / dataset.specimen.length.to_pint()
+        df["stress"] = df["force"] / dataset.specimen.cross_section_area.to_pint()
+
+        # make a linear fit on the linear region of the stress-strain curve
+        # to find the modulus of elasticity
+        linear_region = df[df["strain"] <= dataset.result.linear_region.to_pint()]
+
+        slope, intercept, r_value, p_value, std_err = linregress(
+            linear_region["strain"].pint.to_base_units().pint.magnitude,
+            linear_region["stress"].pint.to_base_units().pint.magnitude,
+        )
+
+        slope = (
+            slope
+            * linear_region["stress"].pint.to_base_units().pint.units
+            / linear_region["strain"].pint.to_base_units().pint.units
+        )  # noqa: E501
+        dataset.specimen.e_mod = ModulusOfElasticity.from_pint(slope.to("Pa"))
+
+        dataset.result = TensileTestResult.from_df(df)
+
+        return dataset
+
+    # Example usage
+    specimen = TensileTestSpecimen(
+        length=Length(value=100, unit=LengthUnit.milli_meter),
+        width=Width(value=10, unit=LengthUnit.milli_meter),
+        thickness=Thickness(value=10, unit=LengthUnit.milli_meter),
+    )
+    result = TensileTestResult(
+        rows=[
+            TensileTestResultRow(
+                force=Force(value=1.0000, unit=ForceUnit.kilo_newton),
+                elongation=Length(value=0.10, unit=LengthUnit.milli_meter),
+            ),  # noqa: E501
+            TensileTestResultRow(
+                force=Force(value=1.5050, unit=ForceUnit.kilo_newton),
+                elongation=Length(value=0.15, unit=LengthUnit.milli_meter),
+            ),  # noqa: E501
+            TensileTestResultRow(
+                force=Force(value=2.0000, unit=ForceUnit.kilo_newton),
+                elongation=Length(value=0.20, unit=LengthUnit.milli_meter),
+            ),  # noqa: E501
+        ]
+    )
+    dataset = TensileTestDataset(specimen=specimen, result=result)
+    analyzed_dataset = tensile_test_analysis(dataset)
+    # print(analyzed_dataset.json(exclude_none=True, indent=2))
+    assert analyzed_dataset.specimen.e_mod == ModulusOfElasticity(
+        value=10.0, unit=ForcePerAreaUnit.giga_pascal
+    )
+
+
+if __name__ == "__main__":
+    test_pint()
+    test_export()
+    test_pandas()
+    test_tensile_test()

opensemantic_characteristics_quantitative-0.2.2.dev1/tests/integration_test.py

@@ -1,106 +0,0 @@
-import json
-
-from opensemantic.characteristics.quantitative import (
-    Area,
-    AreaUnit,
-    Length,
-    LengthUnit,
-    QuantityValue,
-    Width,
-)
-
-# to we have to adapt VSCode settings to include the package index?
-# "python.analysis.packageIndexDepths": [
-#       {"name": "opensemantic.characteristics.quantitative",
-#       "depth": 4, "includeAllSymbols": true}
-# ]
-
-
-def test_pint():
-
-    q = Length(value=1.0, unit=LengthUnit.milli_meter)
-    # transform to pint
-    q_pint = q.to_pint()
-    # transform back to QuantityValue
-    q_ = QuantityValue.from_pint(q_pint)
-    assert q == q_
-
-    q2 = Length(value=1.0, unit=LengthUnit.meter)
-    q3 = q + q2
-    assert q3 == Length(value=1.001, unit=LengthUnit.meter)
-
-    q31 = q * q2
-    assert q31 == Area(value=1000.0, unit=AreaUnit.milli_meter_squared)
-
-    q41 = Area(value=1.0, unit=AreaUnit.meter_squared)
-    q42 = Area(value=1.0, unit=AreaUnit.milli_meter_squared)
-    # 'square_meter' is not a valid unit for pint, but 'square_meter' is
-    q43 = q41 + q42
-    assert q43 == Area(value=1.000001, unit=AreaUnit.meter_squared)
-
-
-def test_export():
-
-    q = Length(value=1.0, unit=LengthUnit.milli_meter)
-
-    q_json = json.loads(q.json(exclude_none=True))
-    print(q_json)
-    assert q_json == {
-        "type": ["Category:OSWee9c7e5c343e542cb5a8b4648315902f"],
-        "value": 1.0,
-        "unit": str(
-            "Item:OSWf101d25e944856e3bd4b4c9863db7de2"
-            "#OSW322dec469be75aedb008b3ebff29db86"
-        ),
-    }
-
-    q = Length(value=1.0, unit=LengthUnit.meter)
-
-    q_json = json.loads(q.json(exclude_none=True))
-    print(q_json)
-    assert q_json == {
-        "type": ["Category:OSWee9c7e5c343e542cb5a8b4648315902f"],
-        "value": 1.0,
-        "unit": "Item:OSWf101d25e944856e3bd4b4c9863db7de2",
-    }
-
-    q_json = json.loads(q.json(exclude_none=True, exclude_defaults=True))
-    print(q_json)
-    assert q_json == {"value": 1.0}
-
-    ln = Length(value=0.1)
-    w = Width(value=200, unit=LengthUnit.milli_meter)
-    a = ln * w
-    print(a)
-
-    json_dict = a.dict()
-    print(json_dict)
-    assert json_dict["type"] == ["Category:OSW1fcf1694712e5684885071efdf775bd9"]
-    assert json_dict["value"] == 20000.0
-    assert json_dict["unit"] == (
-        "Item:OSWd10e5841c68e5aad94b481b58ef9dfb9"
-        "#OSWeca22bf4270853038ef3395bd6dd797b"
-    )
-
-    # _a = QuantityValue(**json_dict)
-
-    _a = a.to_base()
-    json_dict = _a.dict(exclude_none=True, exclude_defaults=True)
-    print(json_dict)
-    assert json_dict["value"] == 0.02
-    assert len(json_dict.keys()) == 1
-
-    __a = Area(**json_dict)
-    assert __a == _a
-
-    # not supported yet
-    # jsonld_dict = a.to_jsonld()
-    # print(json.dumps(jsonld_dict, indent=2))
-
-    # a2 = QuantityValue.from_jsonld(jsonld_dict)
-    # print(a2)
-
-
-if __name__ == "__main__":
-    test_pint()
-    test_export()