jupyter-analysis-tools 1.2.1__tar.gz → 1.2.2__tar.gz

{jupyter_analysis_tools-1.2.1 → jupyter_analysis_tools-1.2.2}/.cookiecutterrc

@@ -20,7 +20,7 @@ default_context:
     release_date:              'today'
     year_from:                 '2018'
     year_to:                   '2023'
-    version:                   '1.2.1'
+    version:                   '1.2.2'
     pypi_host:                 'pypi.org'
     license:                   'MIT license'
     sphinx_theme:              'furo'

{jupyter_analysis_tools-1.2.1 → jupyter_analysis_tools-1.2.2}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## v1.2.2 (2025-07-15)
+
+### Bug fixes
+
+* readPDHmeta: use unique dict keys, the xmk *key* can occur in multiple groups in PDH ([`ef41c81`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/ef41c81d40d801b5baf86f56cf9012ca35d2ccde))
+
+### Documentation
+
+* pyproject: revert specify readme+changelog document types ([`1baa762`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/1baa762d441fe0a1b7b663b9d0589de857277426))
+
+* pyproject: specify readme+changelog document types to render overview on pypi correctly ([`6e4d1e5`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/6e4d1e56640b604f971ddca8dabd8d1aff5c9bf1))
+
+* ghpages: make sure .nojekyll exists after purging old html docs ([`4847845`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/4847845cc06884b6e589b26897e83411d649ef4d))
+
 ## v1.2.1 (2025-07-11)
 
 ### Bug fixes

{jupyter_analysis_tools-1.2.1 → jupyter_analysis_tools-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-analysis-tools
-Version: 1.2.1
+Version: 1.2.2
 Summary: Yet another Python library with helpers and utilities for data analysis and processing.
 Author-email: Ingo Breßler <dev@ingobressler.net>
 License: MIT license
@@ -53,8 +53,8 @@ Yet another Python library with helpers and utilities for data analysis and proc
     :target: https://pypi.org/project/jupyter-analysis-tools
     :alt: PyPI Package latest release
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.2.1.svg
-    :target: https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.2.1...main
+.. |commits-since| image:: https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.2.2.svg
+    :target: https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.2.2...main
     :alt: Commits since latest release
 
 .. |license| image:: https://img.shields.io/pypi/l/jupyter-analysis-tools.svg
@@ -127,6 +127,20 @@ Note, to combine the coverage data from all the tox environments run:
 
 # CHANGELOG
 
+## v1.2.2 (2025-07-15)
+
+### Bug fixes
+
+* readPDHmeta: use unique dict keys, the xmk *key* can occur in multiple groups in PDH ([`ef41c81`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/ef41c81d40d801b5baf86f56cf9012ca35d2ccde))
+
+### Documentation
+
+* pyproject: revert specify readme+changelog document types ([`1baa762`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/1baa762d441fe0a1b7b663b9d0589de857277426))
+
+* pyproject: specify readme+changelog document types to render overview on pypi correctly ([`6e4d1e5`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/6e4d1e56640b604f971ddca8dabd8d1aff5c9bf1))
+
+* ghpages: make sure .nojekyll exists after purging old html docs ([`4847845`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/4847845cc06884b6e589b26897e83411d649ef4d))
+
 ## v1.2.1 (2025-07-11)
 
 ### Bug fixes

{jupyter_analysis_tools-1.2.1 → jupyter_analysis_tools-1.2.2}/README.rst

@@ -14,8 +14,8 @@ Yet another Python library with helpers and utilities for data analysis and proc
     :target: https://pypi.org/project/jupyter-analysis-tools
     :alt: PyPI Package latest release
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.2.1.svg
-    :target: https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.2.1...main
+.. |commits-since| image:: https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.2.2.svg
+    :target: https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.2.2...main
     :alt: Commits since latest release
 
 .. |license| image:: https://img.shields.io/pypi/l/jupyter-analysis-tools.svg

{jupyter_analysis_tools-1.2.1 → jupyter_analysis_tools-1.2.2}/docs/conf.py

@@ -29,7 +29,7 @@ project = "Jupyter Analysis Tools"
 year = "2018-2023"
 author = "Ingo Breßler"
 copyright = "{0}, {1}".format(year, author)
-version = "1.2.1"
+version = "1.2.2"
 release = version
 commit_id = None
 try:

{jupyter_analysis_tools-1.2.1 → jupyter_analysis_tools-1.2.2}/src/jupyter_analysis_tools/__init__.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # __init__.py
 
-__version__ = "1.2.1"
+__version__ = "1.2.2"
 
 from .binning import reBin
 from .git import checkRepo, isNBstripoutActivated, isNBstripoutInstalled, isRepo

{jupyter_analysis_tools-1.2.1 → jupyter_analysis_tools-1.2.2}/src/jupyter_analysis_tools/readdata.py

@@ -68,14 +68,18 @@ def xmlPDHToDict(root):
     while stack:
         elem, parentCont = stack.pop()
         elemCont = {}
-        key = elem.attrib.pop("key", None)
         idx = -1
-        if (
-            not len(list(elem)) and
-            not len(elem.attrib) and
-            not (elem.text and len(elem.text.strip()))
+        key = elem.attrib.pop("key", None)
+        if (  # get a unique key, the key can occur in multiple groups in PDH
+            key is not None and elem.tag == "group" and elem.attrib.get("id", None) is not None
+        ):
+            key = elem.attrib.pop("id")
+        if (  # skip empty elements with a key only early
+            not len(list(elem))
+            and not len(elem.attrib)
+            and not (elem.text and len(elem.text.strip()))
         ):
-            continue  # skip empty elements with a key only early
+            continue
         if elem.tag == "list":
             elemCont = []
         else:  # add attributes & values to dict
@@ -115,9 +119,8 @@ def xmlPDHToDict(root):
                 else:  # have a key
                     parentCont[parentKey] = {key: elemCont}
             else:  # parentKey exists already
-                if (
-                    not isinstance(parentCont[parentKey], list) and
-                    not isinstance(parentCont[parentKey], dict)
+                if not isinstance(parentCont[parentKey], list) and not isinstance(
+                    parentCont[parentKey], dict
                 ):
                     # if its a plain value before, make a list out of it and append in next step
                     parentCont[parentKey] = [parentCont[parentKey]]
@@ -135,7 +138,7 @@ def xmlPDHToDict(root):
     try:
         oldts = result["fileinfo"]["parameter"]["DateTime"]["value"]
         # timestamp seems to be based on around 2009-01-01 (a day give or take)
-        delta = ((39 * 365 + 10) * 24 * 3600)
+        delta = (39 * 365 + 10) * 24 * 3600
         # make it compatible to datetime.datetime routines
         result["fileinfo"]["parameter"]["DateTime"]["value"] = oldts + delta
     except KeyError:

{jupyter_analysis_tools-1.2.1 → jupyter_analysis_tools-1.2.2}/src/jupyter_analysis_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-analysis-tools
-Version: 1.2.1
+Version: 1.2.2
 Summary: Yet another Python library with helpers and utilities for data analysis and processing.
 Author-email: Ingo Breßler <dev@ingobressler.net>
 License: MIT license
@@ -53,8 +53,8 @@ Yet another Python library with helpers and utilities for data analysis and proc
     :target: https://pypi.org/project/jupyter-analysis-tools
     :alt: PyPI Package latest release
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.2.1.svg
-    :target: https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.2.1...main
+.. |commits-since| image:: https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.2.2.svg
+    :target: https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.2.2...main
     :alt: Commits since latest release
 
 .. |license| image:: https://img.shields.io/pypi/l/jupyter-analysis-tools.svg
@@ -127,6 +127,20 @@ Note, to combine the coverage data from all the tox environments run:
 
 # CHANGELOG
 
+## v1.2.2 (2025-07-15)
+
+### Bug fixes
+
+* readPDHmeta: use unique dict keys, the xmk *key* can occur in multiple groups in PDH ([`ef41c81`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/ef41c81d40d801b5baf86f56cf9012ca35d2ccde))
+
+### Documentation
+
+* pyproject: revert specify readme+changelog document types ([`1baa762`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/1baa762d441fe0a1b7b663b9d0589de857277426))
+
+* pyproject: specify readme+changelog document types to render overview on pypi correctly ([`6e4d1e5`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/6e4d1e56640b604f971ddca8dabd8d1aff5c9bf1))
+
+* ghpages: make sure .nojekyll exists after purging old html docs ([`4847845`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/4847845cc06884b6e589b26897e83411d649ef4d))
+
 ## v1.2.1 (2025-07-11)
 
 ### Bug fixes

{jupyter_analysis_tools-1.2.1 → jupyter_analysis_tools-1.2.2}/testdata/S2842 water.json

@@ -165,7 +165,6 @@
                 "isdevice": "false",
                 "category": "exp",
                 "sub": "sample",
-                "id": "exp:sample:Default",
                 "ParameterCount": {
                     "value": 0,
                     "counts": "ParameterKey|ParameterName|ParameterValue",
@@ -208,7 +207,6 @@
                 "isdevice": "false",
                 "category": "exp",
                 "sub": "file",
-                "id": "exp:file:Default",
                 "Filename": {
                     "value": "S2842",
                     "type": "String",
@@ -261,7 +259,6 @@
                 "isdevice": "false",
                 "category": "exp",
                 "sub": "vari",
-                "id": "exp:vari:Default",
                 "VariationCount": {
                     "value": 0,
                     "counts": "Parameter|Count|Start|Increment|Positions|Prefix|Digits|NamingOption",
@@ -316,10 +313,9 @@
                     "db": "D"
                 }
             },
-            "custom_generator": {
+            "generator::custom_generator#0": {
                 "isdevice": "true",
                 "category": "generator",
-                "id": "generator::custom_generator#0",
                 "isactive": "true",
                 "Name": {
                     "value": "PW1830",
@@ -453,10 +449,9 @@
                     "type": "String"
                 }
             },
-            "AP_SAXSess": {
+            "camera::AP_SAXSess#0": {
                 "isdevice": "true",
                 "category": "camera",
-                "id": "camera::AP_SAXSess#0",
                 "Name": {
                     "value": "SAXSess",
                     "type": "String",
@@ -573,11 +568,10 @@
                     "type": "String"
                 }
             },
-            "PI_SCX4300": {
+            "detector:ccd:PI_SCX4300#0": {
                 "isdevice": "true",
                 "category": "detector",
                 "sub": "ccd",
-                "id": "detector:ccd:PI_SCX4300#0",
                 "Name": {
                     "value": "CCD",
                     "type": "String",
@@ -897,10 +891,9 @@
                     "Y": 1
                 }
             },
-            "AP_TCS120": {
+            "holder::AP_TCS120#0": {
                 "isdevice": "true",
                 "category": "holder",
-                "id": "holder::AP_TCS120#0",
                 "Name": {
                     "value": "TCS 120",
                     "type": "String",
@@ -957,11 +950,10 @@
                     "type": "String"
                 }
             },
-            "AP_TCU50": {
+            "secu:temp:AP_TCU50#0": {
                 "isdevice": "true",
                 "category": "secu",
                 "sub": "temp",
-                "id": "secu:temp:AP_TCU50#0",
                 "Name": {
                     "value": "TCU 50",
                     "type": "String",
@@ -1158,11 +1150,10 @@
                     "type": "String"
                 }
             },
-            "Dectris_Mythen1K": {
+            "detector:ccd:Dectris_Mythen1K#0": {
                 "isdevice": "true",
                 "category": "detector",
                 "sub": "ccd",
-                "id": "detector:ccd:Dectris_Mythen1K#0",
                 "Name": {
                     "value": "1D diode array",
                     "type": "String",
@@ -1506,11 +1497,10 @@
                     "Y": 1
                 }
             },
-            "Spark_ASXc": {
+            "sampler:auto:Spark_ASXc#0": {
                 "isdevice": "true",
                 "category": "sampler",
                 "sub": "auto",
-                "id": "sampler:auto:Spark_ASXc#0",
                 "Name": {
                     "value": "ASX-c",
                     "type": "String",

{jupyter_analysis_tools-1.2.1 → jupyter_analysis_tools-1.2.2}/tests/readdata.py

@@ -26,17 +26,28 @@ def test_readdata1(capsys):
     assert df.columns.tolist() == ["q", "I", "e"]
     assert df.dtypes.tolist() == [numpy.float64, numpy.float64, numpy.float64]
     # checking the first data values
-    assert numpy.all(df.loc[:2].values == numpy.array(
-            [[-1.005583e00, 5.555556e-08, 2.754402e-08],
-             [-9.989474e-01, 3.611111e-07, 6.568830e-08],
-             [-9.923112e-01, 3.055556e-07, 6.120415e-08]]))
+    assert numpy.all(
+        df.loc[:2].values
+        == numpy.array(
+            [
+                [-1.005583e00, 5.555556e-08, 2.754402e-08],
+                [-9.989474e-01, 3.611111e-07, 6.568830e-08],
+                [-9.923112e-01, 3.055556e-07, 6.120415e-08],
+            ]
+        )
+    )
     # and checking the last data values
-    assert numpy.all(df.loc[df.shape[0] - 3 :].values == numpy.array(
-            [[7.381979e00, 2.972222e-06, 1.792166e-07],
-             [7.388376e00, 2.944444e-06, 1.436040e-07],
-             [7.394774e00, 2.388889e-06, 1.548690e-07]]))
-    assert numpy.all(df.median().values == numpy.array(
-            [3.233221e00, 5.826389e-05, 8.835466e-07]))
+    assert numpy.all(
+        df.loc[df.shape[0] - 3 :].values
+        == numpy.array(
+            [
+                [7.381979e00, 2.972222e-06, 1.792166e-07],
+                [7.388376e00, 2.944444e-06, 1.436040e-07],
+                [7.394774e00, 2.388889e-06, 1.548690e-07],
+            ]
+        )
+    )
+    assert numpy.all(df.median().values == numpy.array([3.233221e00, 5.826389e-05, 8.835466e-07]))
 
 
 def test_readdata2(capsys):
@@ -48,8 +59,7 @@ def test_readdata2(capsys):
     assert fn == "S2843"
     assert df.shape == (427, 3)
     assert df.columns.tolist() == ["q", "I", "e"]
-    assert numpy.all(df.median().values == numpy.array(
-            [1.470428, 0.01907878, 0.01353293]))
+    assert numpy.all(df.median().values == numpy.array([1.470428, 0.01907878, 0.01353293]))
 
 
 def test_readPDHmeta1():
@@ -62,7 +72,7 @@ def test_readPDHmeta1():
 
     # writing the test JSON for comparisons on updates
     # with open(pathPDH1.with_suffix(".json"), "w") as fd:
-    #    json.dump(data, fd, indent=4)
+    #     json.dump(data, fd, indent=4)
 
     # write the JSON formatted metadata to disk, read it back in and compare
     # it with the expected reference from testdata dir
@@ -97,8 +107,9 @@ def test_readSSF():
         #    json.dump(data, fd, indent=4)
         # write the JSON formatted session data to disk
         # and compare it with the expected JSON file from testdata dir
-        with open(pathSSFZ.with_suffix(".ssf.json")) as fdRef, \
-             tempfile.TemporaryFile("w+") as fdNew:
+        with open(pathSSFZ.with_suffix(".ssf.json")) as fdRef, tempfile.TemporaryFile(
+            "w+"
+        ) as fdNew:
             json.dump(data, fdNew, indent=4)
             fdNew.seek(0)
             assert fdRef.read() == fdNew.read()