dccQuantities 1.4.6__tar.gz → 2.0.0.dev2__tar.gz

{dccquantities-1.4.6 → dccquantities-2.0.0.dev2}/LICENSE

@@ -2,7 +2,7 @@
                        Version 2.1, February 1999
 
  Copyright (C) 1991, 1999 Free Software Foundation, Inc.
- 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -55,7 +55,7 @@ modified by someone else and passed on, the recipients should know
 that what they have is not the original version, so that the original
 author's reputation will not be affected by problems that might be
 introduced by others.
-
+
   Finally, software patents pose a constant threat to the existence of
 any free program.  We wish to make sure that a company cannot
 effectively restrict the users of a free program by obtaining a
@@ -111,7 +111,7 @@ modification follow.  Pay close attention to the difference between a
 "work based on the library" and a "work that uses the library".  The
 former contains code derived from the library, whereas the latter must
 be combined with the library in order to run.
-
+
                   GNU LESSER GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
@@ -158,7 +158,7 @@ Library.
   You may charge a fee for the physical act of transferring a copy,
 and you may at your option offer warranty protection in exchange for a
 fee.
-
+
   2. You may modify your copy or copies of the Library or any portion
 of it, thus forming a work based on the Library, and copy and
 distribute such modifications or work under the terms of Section 1
@@ -216,7 +216,7 @@ instead of to this License.  (If a newer version than version 2 of the
 ordinary GNU General Public License has appeared, then you can specify
 that version instead if you wish.)  Do not make any other change in
 these notices.
-
+
   Once this change is made in a given copy, it is irreversible for
 that copy, so the ordinary GNU General Public License applies to all
 subsequent copies and derivative works made from that copy.
@@ -267,7 +267,7 @@ Library will still fall under Section 6.)
 distribute the object code for the work under the terms of Section 6.
 Any executables containing that work also fall under Section 6,
 whether or not they are linked directly with the Library itself.
-
+
   6. As an exception to the Sections above, you may also combine or
 link a "work that uses the Library" with the Library to produce a
 work containing portions of the Library, and distribute that work
@@ -329,7 +329,7 @@ restrictions of other proprietary libraries that do not normally
 accompany the operating system.  Such a contradiction means you cannot
 use both them and the Library together in an executable that you
 distribute.
-
+
   7. You may place library facilities that are a work based on the
 Library side-by-side in a single library together with other library
 facilities not covered by this License, and distribute such a combined
@@ -370,7 +370,7 @@ subject to these terms and conditions.  You may not impose any further
 restrictions on the recipients' exercise of the rights granted herein.
 You are not responsible for enforcing compliance by third parties with
 this License.
-
+
   11. If, as a consequence of a court judgment or allegation of patent
 infringement or for any other reason (not limited to patent issues),
 conditions are imposed on you (whether by court order, agreement or
@@ -422,7 +422,7 @@ conditions either of that version or of any later version published by
 the Free Software Foundation.  If the Library does not specify a
 license version number, you may choose any version ever published by
 the Free Software Foundation.
-
+
   14. If you wish to incorporate parts of the Library into other free
 programs whose distribution conditions are incompatible with these,
 write to the author to ask for permission.  For software which is
@@ -456,7 +456,7 @@ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
 DAMAGES.
 
                      END OF TERMS AND CONDITIONS
-
+
            How to Apply These Terms to Your New Libraries
 
   If you develop a new library, and you want it to be of the greatest
@@ -471,7 +471,7 @@ convey the exclusion of warranty; and each file should have at least the
 "copyright" line and a pointer to where the full notice is found.
 
     <one line to give the library's name and a brief idea of what it does.>
-    Copyright (C) 2024  Benedikt
+    Copyright (C) <year>  <name of author>
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Lesser General Public
@@ -484,9 +484,7 @@ convey the exclusion of warranty; and each file should have at least the
     Lesser General Public License for more details.
 
     You should have received a copy of the GNU Lesser General Public
-    License along with this library; if not, write to the Free Software
-    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
-    USA
+    License along with this library; if not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -495,10 +493,9 @@ school, if any, to sign a "copyright disclaimer" for the library, if
 necessary.  Here is a sample; alter the names:
 
   Yoyodyne, Inc., hereby disclaims all copyright interest in the
-  library `Frob' (a library for tweaking knobs) written by James Random
-  Hacker.
+  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
 
-  <signature of Ty Coon>, 1 April 1990
-  Ty Coon, President of Vice
+  <signature of Moe Ghoul>, 1 April 1990
+  Moe Ghoul, President of Vice
 
-That's all there is to it!
+That's all there is to it!

dccquantities-2.0.0.dev2/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include LICENSE

dccquantities-2.0.0.dev2/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: dccQuantities
+Version: 2.0.0.dev2
+Summary: Python classes for working with DDC calibration data
+Author: Vanessa Stehr, Thomas Bruns
+Author-email: Benedikt Seeger <benedikt.seeger@ptb.de>
+License-Expression: LGPL-2.1-or-later
+Project-URL: Homepage, https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: uncertainties
+Requires-Dist: requests
+Requires-Dist: pylatexenc
+Requires-Dist: odfpy
+Requires-Dist: openpyxl
+Requires-Dist: pandas
+Requires-Dist: dsiUnits>=2.5.2
+Requires-Dist: dccXMLJSONConv==3.0.0.dev7
+Requires-Dist: metas_unclib
+Requires-Dist: pythonnet
+Requires-Dist: pycountry
+Provides-Extra: dccquantitiesplot
+Requires-Dist: bokeh; extra == "dccquantitiesplot"
+Provides-Extra: testing
+Requires-Dist: pytest==7.4.1; extra == "testing"
+Requires-Dist: pytest-cov==4.1.0; extra == "testing"
+Dynamic: license-file
+
+# dccQuantities
+
+dccQuantities is a Python library designed for users of PTB’s Digital Calibration Certificates (DCC) in XML format. It provides an object‑oriented interface to parse, serialize, and manipulate calibration data with full support for uncertainties and units. Arithmetic works naturally on scalars, scalar‑vector mixes, and same‑length vectors element‑wise, preserving uncertainty propagation and metadata throughout.
+
+---
+
+## Key Features
+
+- **DCC XML Parsing & Serialization**  
+  Import certificates from XML into Python objects and export back to XML, JSON, CSV, Excel, or pandas DataFrames.
+
+- **Uncertainty & Unit Awareness**  
+  All quantity objects wrap values as `ufloat` (via `metas_unclib`) and units via `dsiUnits`, ensuring correct propagation in calculations.
+
+- **Object‑Oriented Arithmetic**  
+  Standard operators (`+`, `-`, `*`, `/`, `**`) are overloaded on:
+  - **`DccQuantityType`**: single or tabulated quantities
+  - **`SiRealList`**, **`SiComplexList`**, **`SiHybrid`**: 1D/2D arrays
+
+- **Tables & Fancy Indexing**
+The classes `DccLongTable` and `DccFlatTable` transparently implement numpy like indexing on efficient table structures described in the [table document](doc/tabellen/tables-de.md). Fancy indexing is supported, return type are always new tables.
+---
+
+## Installation
+
+From PyPI (core functionality):
+```bash
+pip install dccQuantities
+```
+
+For development and testing:
+```bash
+git clone https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities.git
+cd dccQuantities
+pip install -e .[testing]
+```
+
+## Under the Hood (Test‑Driven Behavior)
+
+The library’s design is guided by its test suite:
+
+1. **Core Parsing** (`tests/test_parser.py`): reads `<DccQuantityTable>` and `<DccQuantityType>` elements, building Python objects.
+2. **Naming** (`tests/test_dccName.py`): parses and normalizes `<DccName>` entries for multilingual support.
+3. **Quantity Discovery** (`tests/test_quantityTypeCollector.py`): auto‑registers data handlers via `AbstractQuantityTypeData` subclasses.
+5. **List Types** (`tests/test_SiRealList_*.py`): handles real, complex, and hybrid lists, including broadcasting and label merging.
+6. **Table Flattening** (`tests/test_tables.py`): cover the tables.
+7. **Round‑Trip Serialization** (`tests/test_serilizer.py`): ensures parse→serialize yields equivalent XML.
+8. **JSON Interchange** (`tests/test_dccQuantTabJSONDumpingAndLoadingFromFile.json`): lossless JSON dump/load.
+
+---
+
+## Contributing & Contact
+
+We welcome improvements, bug reports, and new features. To contribute:
+
+1. **Fork** the repository.  
+2. **Create** a feature branch.  
+3. **Add** tests for new functionality.  
+4. **Submit** a merge request.
+
+We highly encourage direct personal contact for design discussions or questions. Feel free to create Issues, even if you think your question/comment is not worth an issue, it is allways!
+
+Or reach out to the maintainer:
+- **Benedikt Seeger**: benedikt.seeger@ptb.de
+directly
+
+## License
+
+This project is licensed under the [LGPL‑2.1‑or‑later](LICENSE).
+

dccquantities-2.0.0.dev2/README.md

@@ -0,0 +1,70 @@
+# dccQuantities
+
+dccQuantities is a Python library designed for users of PTB’s Digital Calibration Certificates (DCC) in XML format. It provides an object‑oriented interface to parse, serialize, and manipulate calibration data with full support for uncertainties and units. Arithmetic works naturally on scalars, scalar‑vector mixes, and same‑length vectors element‑wise, preserving uncertainty propagation and metadata throughout.
+
+---
+
+## Key Features
+
+- **DCC XML Parsing & Serialization**  
+  Import certificates from XML into Python objects and export back to XML, JSON, CSV, Excel, or pandas DataFrames.
+
+- **Uncertainty & Unit Awareness**  
+  All quantity objects wrap values as `ufloat` (via `metas_unclib`) and units via `dsiUnits`, ensuring correct propagation in calculations.
+
+- **Object‑Oriented Arithmetic**  
+  Standard operators (`+`, `-`, `*`, `/`, `**`) are overloaded on:
+  - **`DccQuantityType`**: single or tabulated quantities
+  - **`SiRealList`**, **`SiComplexList`**, **`SiHybrid`**: 1D/2D arrays
+
+- **Tables & Fancy Indexing**
+The classes `DccLongTable` and `DccFlatTable` transparently implement numpy like indexing on efficient table structures described in the [table document](doc/tabellen/tables-de.md). Fancy indexing is supported, return type are always new tables.
+---
+
+## Installation
+
+From PyPI (core functionality):
+```bash
+pip install dccQuantities
+```
+
+For development and testing:
+```bash
+git clone https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities.git
+cd dccQuantities
+pip install -e .[testing]
+```
+
+## Under the Hood (Test‑Driven Behavior)
+
+The library’s design is guided by its test suite:
+
+1. **Core Parsing** (`tests/test_parser.py`): reads `<DccQuantityTable>` and `<DccQuantityType>` elements, building Python objects.
+2. **Naming** (`tests/test_dccName.py`): parses and normalizes `<DccName>` entries for multilingual support.
+3. **Quantity Discovery** (`tests/test_quantityTypeCollector.py`): auto‑registers data handlers via `AbstractQuantityTypeData` subclasses.
+5. **List Types** (`tests/test_SiRealList_*.py`): handles real, complex, and hybrid lists, including broadcasting and label merging.
+6. **Table Flattening** (`tests/test_tables.py`): cover the tables.
+7. **Round‑Trip Serialization** (`tests/test_serilizer.py`): ensures parse→serialize yields equivalent XML.
+8. **JSON Interchange** (`tests/test_dccQuantTabJSONDumpingAndLoadingFromFile.json`): lossless JSON dump/load.
+
+---
+
+## Contributing & Contact
+
+We welcome improvements, bug reports, and new features. To contribute:
+
+1. **Fork** the repository.  
+2. **Create** a feature branch.  
+3. **Add** tests for new functionality.  
+4. **Submit** a merge request.
+
+We highly encourage direct personal contact for design discussions or questions. Feel free to create Issues, even if you think your question/comment is not worth an issue, it is allways!
+
+Or reach out to the maintainer:
+- **Benedikt Seeger**: benedikt.seeger@ptb.de
+directly
+
+## License
+
+This project is licensed under the [LGPL‑2.1‑or‑later](LICENSE).
+

dccquantities-2.0.0.dev2/pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ["setuptools>=77.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dccQuantities"
+version = "2.0.0.dev2"
+description = "Python classes for working with DDC calibration data"
+readme = "README.md"
+requires-python = ">=3.9"
+
+# SPDX license expression + point at your LICENSE file
+license = "LGPL-2.1-or-later"
+license-files = ["LICENSE"]
+
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Operating System :: OS Independent",
+]
+
+authors = [
+  { name = "Benedikt Seeger", email = "benedikt.seeger@ptb.de" },
+  { name = "Vanessa Stehr" },
+  { name = "Thomas Bruns" },
+]
+urls = { "Homepage" = "https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities" }
+
+dependencies = [
+  "numpy",
+  "scipy",
+  "uncertainties",
+  "requests",
+  "pylatexenc",
+  "odfpy",
+  "openpyxl",
+  "pandas",
+  "dsiUnits>=2.5.2",
+  "dccXMLJSONConv==3.0.0.dev7",
+  "metas_unclib",
+  "pythonnet",
+  "pycountry",
+]
+
+[project.optional-dependencies]
+dccQuantitiesPlot = ["bokeh"]
+testing = [
+  "pytest==7.4.1",
+  "pytest-cov==4.1.0",
+]

dccquantities-2.0.0.dev2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

dccquantities-2.0.0.dev2/src/AbstractListType.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+from collections import defaultdict # for type annotation recursion
+
+from AbstractQuantityTypeData import AbstractQuantityTypeData
+from AbstractValueType import AbstractValueType
+from typing import Union #for python 3.8/3.9 compatibility
+
+
+class AbstractListType(AbstractQuantityTypeData):
+    def __init__(self, children: list[Union[AbstractListType,AbstractValueType]]) -> None:
+        super().__init__()
+        self.children = children
+
+    def toJsonDict(self):
+        result = defaultdict(list)
+        for child in self.children:
+            childJson = child.toJsonDict()
+            for key, value in childJson.items():
+                result[key].append(value)
+        return dict(result)
+
+
+    def flatten(self):
+        pass
+
+    def __len__(self):
+        return len(self.children)

dccquantities-2.0.0.dev2/src/AbstractQuantityTypeData.py

@@ -0,0 +1,4 @@
+class AbstractQuantityTypeData:
+    def __init__(self) -> None:
+        self._sorted=None
+        pass

dccquantities-2.0.0.dev2/src/AbstractValueType.py

@@ -0,0 +1,116 @@
+from datetime import datetime
+from dsiUnits import dsiUnit
+from numpy.core.defchararray import endswith
+
+from AbstractQuantityTypeData import AbstractQuantityTypeData
+from typing import Union #for python 3.8/3.9 compatibility
+import numpy as np
+from metas_unclib import *
+from helpers import dccConfiguration
+
+class AbstractValueType(AbstractQuantityTypeData):
+    def __init__(
+        self,
+        label: list[str] = None,
+        unit: list[Union[str , dsiUnit]] = None,
+        dateTime: list[datetime] = None,
+        _originType: str = None,
+        _uncInfo: dict = None,
+    ) -> None:
+        super().__init__()
+        self.label = label
+        self.unit = []
+        self._originType = _originType
+        self._uncInfo = _uncInfo
+        if isinstance(unit,str):
+            unit=[unit]
+        if unit:
+            for item in unit:
+                if isinstance(item, dsiUnit):
+                    self.unit.append(item)
+                elif isinstance(item, str):
+                    self.unit.append(dsiUnit(item))
+        self.dateTime = dateTime
+
+    def serilizeDataToJSON(self):
+        if isinstance(self.data, np.ndarray):
+            dType = self.data.dtype
+            length = self.data.size
+            # check if data is a number so we will not have any uncer
+            if np.issubdtype(dType, np.number):
+                # we have number type so we defensively don't have any uncer
+                if length > 1:
+                    flattValues = list(self.data.flat)
+                    flattUncs = None
+                else:
+                    flattValues = self.data.flat[0]
+                    flattUncs = None
+            # check if data is a object if yes check witch type of object
+            if dType == object:
+                flattarray = self.data.flat
+                objType = type(flattarray[0])  # flatten the array so we can get an first element and inspect it's type
+                if objType == ufloat:
+                    # Define a vectorized function to extract the membervar.
+                    vec_values = np.vectorize(lambda x: x.value)
+                    vec_uncs = np.vectorize(lambda x: x.stdunc)
+                    if length>1:
+                        flattValues = list(vec_values(flattarray))
+                        flattUncs = list(vec_uncs(flattarray))
+                    else:
+                        flattValues = vec_values(flattarray)[0]
+                        flattUncs = vec_uncs(flattarray)[0]
+            # okay now we can create the json
+            suffix = "" if length ==1 and not self._originType.endswith('XMLList') else "XMLList"
+            resultjson = {"si:value"+suffix: flattValues,}
+            if flattUncs and self._uncInfo != None:
+                kfactor=self._uncInfo['coverageFactor']
+                covP = self._uncInfo['coverageProbability']
+                distribution =self._uncInfo['distribution']
+                lens=np.array([len(kfactor),len(covP),len(distribution)])
+                if np.all(lens==1):
+                    kfactor=kfactor[0]
+                    covP=covP[0]
+                    distribution=distribution[0]
+                if not np.all(kfactor==1.0):
+                    # we should create expanded uncs now
+
+                    if not "originalUnc" in self._uncInfo:
+                        # we had no original uncer so wie calculate expanded unc
+                        uncValues=(np.array(flattUncs) * kfactor).tolist()
+                        if suffix=='':
+                            try:
+                                uncValues=uncValues[0]
+                            except TypeError:
+                                # if we cant suscribe it it must be int or float
+                                pass
+                    else:
+                        uncValues=self._uncInfo["originalUnc"]
+                        if suffix=='':
+                            try:
+                                uncValues=uncValues[0]
+                            except TypeError:
+                                # if we cant suscribe it it must be int or float
+                                pass
+
+                    resultjson["si:measurementUncertaintyUnivariate"+suffix] = {
+                        "si:expandedMU"+suffix:{
+                            "si:valueExpandedMU" + suffix:uncValues,
+                            "si:coverageFactor"+suffix:kfactor,
+                            "si:coverageProbability"+suffix:covP,
+                            "si:distribution"+suffix:distribution
+                        }
+                    }
+                else:
+                    resultjson["si:measurementUncertaintyUnivariate"+suffix] = {
+                        "si:standardMU"+suffix:{
+                            "si:valueStandardMU" + suffix: flattUncs,
+                            "si:distribution"+suffix:distribution
+                        }
+                    }
+
+            #TODO deal with coverra
+            return resultjson
+        else:
+            raise ValueError("Data is not a numpy array")
+
+

dccquantities-2.0.0.dev2/src/DccCharsXMLList.py

@@ -0,0 +1,63 @@
+import warnings
+from AbstractQuantityTypeData import AbstractQuantityTypeData
+from typing import Union #for python 3.8/3.9 compatibility
+
+class DccCharsXMLList(AbstractQuantityTypeData):
+    def __init__(self, data: list[str]) -> None:
+        super().__init__()
+        self.data = data
+
+    def __len__(self) -> int:
+        return len(self.data)
+
+    def __str__(self) -> str:
+        return self.data.__str__()
+
+    def __repr__(self) -> str:
+        params = {key: value for key, value in vars(self).items() if value is not None}
+        paramStr = ", ".join(f"{key}={repr(value)}" for key, value in params.items())
+        return f"DccCharsXMLList.DccCharsXMLList({paramStr})"
+
+    def __add__(self, other):
+        if isinstance(other, DccCharsXMLList):
+            return DccCharsXMLList(data=self.data + other.data)
+        elif isinstance(other, list):
+            warnings.warn("Concatenating DccCharsXMLList and list!", RuntimeWarning)
+            return DccCharsXMLList(data=self.data + other)
+        else:
+            raise TypeError(
+                "unsupported operand for +: "
+                f"'{type(self).__name__}' and '{type(other).__name__}'"
+            )
+        
+    def __radd__(self, other):
+        if isinstance(other, DccCharsXMLList):
+            return DccCharsXMLList(data=other.data + self.data)
+        elif isinstance(other, list):
+            warnings.warn("Concatenating DccCharsXMLList and list!", RuntimeWarning)
+            return DccCharsXMLList(data=other + self.data)
+        else:
+            raise TypeError(
+                "unsupported operand for +: "
+                f"'{type(other).__name__}' and '{type(self).__name__}'"
+            )
+        
+    def toJsonDict(self) -> list:
+        return {'dcc:charsXMLList': self.data}
+
+
+    @property
+    def sorted(self) -> bool:
+        if self._sorted is None:
+            self._sorted=all(self.data[i] <= self.data[i + 1] for i in range(len(self.data) - 1))
+        """Check if the list of strings is sorted in ascending order."""
+        return self._sorted
+
+
+def parse(jsonDict: Union[dict, list]):
+    if isinstance(jsonDict, list):
+        return DccCharsXMLList(data=jsonDict)
+    elif isinstance(jsonDict, dict):
+        return NotImplemented
+
+    return DccCharsXMLList(data=jsonDict)

dccquantities-2.0.0.dev2/src/DccFormulaType.py

@@ -0,0 +1,15 @@
+from helpers import parseAttributes
+
+
+class DccMathml:
+    def __init__(self, content, id: None, refId: None, refType: None) -> None:
+        self.content = content
+        self.id = id
+        self.refId = refId
+        self.refType = refType
+
+def parseDccMathml(jsonDict):
+    dccMathmlArgs = parseAttributes(jsonDict=jsonDict)
+    dccMathmlArgs['content'] = jsonDict['$']
+
+    return DccMathml(**dccMathmlArgs)