data-manipulation-utilities 0.0.6__tar.gz → 0.0.9__tar.gz

{data_manipulation_utilities-0.0.6 → data_manipulation_utilities-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: data_manipulation_utilities
-Version: 0.0.6
+Version: 0.0.9
 Description-Content-Type: text/markdown
 Requires-Dist: zfit
 Requires-Dist: logzero
@@ -24,6 +24,33 @@ Requires-Dist: pytest; extra == "dev"
 
 These are tools that can be used for different data analysis tasks.
 
+For LHCb specific tools (not useful for people outside LHCb) see [this](doc/lhcb.md)
+
+# GIT
+
+## Pushing
+
+From the root directory of a version controlled project (i.e. a directory with the `.git` subdirectory) 
+using a `pyproject.toml` file, run:
+
+```bash
+publish
+```
+
+such that:
+
+1. The `pyproject.toml` file is checked and the version of the project is extracted.
+1. If a tag named as the version exists move to the steps below. 
+1. If it does not, make a new tag with the name as the version
+
+Then, for each remote it pushes the tags and the commits. 
+
+*Why?* 
+
+1. Tags should be named as the project's version
+1. As soon as a new version is created, that version needs to be tagged.
+1. In GitHub, one can configure actions to publish projects when the commits are tagged.
+
 # Generic
 
 This section describes generic tools that could not be put in a specific category, but tend to be useful.

{data_manipulation_utilities-0.0.6 → data_manipulation_utilities-0.0.9}/README.md

@@ -2,6 +2,33 @@
 
 These are tools that can be used for different data analysis tasks.
 
+For LHCb specific tools (not useful for people outside LHCb) see [this](doc/lhcb.md)
+
+# GIT
+
+## Pushing
+
+From the root directory of a version controlled project (i.e. a directory with the `.git` subdirectory) 
+using a `pyproject.toml` file, run:
+
+```bash
+publish
+```
+
+such that:
+
+1. The `pyproject.toml` file is checked and the version of the project is extracted.
+1. If a tag named as the version exists move to the steps below. 
+1. If it does not, make a new tag with the name as the version
+
+Then, for each remote it pushes the tags and the commits. 
+
+*Why?* 
+
+1. Tags should be named as the project's version
+1. As soon as a new version is created, that version needs to be tagged.
+1. In GitHub, one can configure actions to publish projects when the commits are tagged.
+
 # Generic
 
 This section describes generic tools that could not be put in a specific category, but tend to be useful.

{data_manipulation_utilities-0.0.6 → data_manipulation_utilities-0.0.9}/pyproject.toml

@@ -1,22 +1,22 @@
 [project]
 name        = 'data_manipulation_utilities'
-version     = '0.0.6'
+version     = '0.0.9'
 readme      = 'README.md'
 dependencies= [
-'zfit', 
+'zfit',
 'logzero',
-'PyYAML', 
-'scipy', 
-'awkward', 
-'tqdm', 
-'joblib', 
-'scikit-learn', 
-'toml', 
-'numpy', 
-'matplotlib', 
-'mplhep', 
+'PyYAML',
+'scipy',
+'awkward',
+'tqdm',
+'joblib',
+'scikit-learn',
+'toml',
+'numpy',
+'matplotlib',
+'mplhep',
 'hist[plot]',
-'polars', 
+'polars',
 'pandas']
 
 [project.optional-dependencies]
@@ -29,11 +29,12 @@ where   = ['src']
 transform_text    ='dmu_scripts.text.transform_text:main'
 coned             ='dmu_scripts.ssh.coned:main'
 check_truth       ='dmu_scripts.physics.check_truth:main'
+update_decinfo    ='dmu_scripts.physics.update_decinfo:main'
 print_trees       ='dmu_scripts.rfile.print_trees:main'
 compare_root_files='dmu_scripts.rfile.compare_root_files:main'
 
 [tool.setuptools.package-data]
-dmu_data=['text/*.txt', 'text/*.toml', 'ml/*/*.yaml', 'plotting/*/*.yaml']
+dmu_data=['physics/*.yaml', 'text/*.txt', 'text/*.toml', 'ml/*/*.yaml', 'plotting/*/*.yaml']
 
 [tool.setuptools]
 script-files=['src/dmu_scripts/git/publish']

{data_manipulation_utilities-0.0.6 → data_manipulation_utilities-0.0.9}/src/data_manipulation_utilities.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: data_manipulation_utilities
-Version: 0.0.6
+Version: 0.0.9
 Description-Content-Type: text/markdown
 Requires-Dist: zfit
 Requires-Dist: logzero
@@ -24,6 +24,33 @@ Requires-Dist: pytest; extra == "dev"
 
 These are tools that can be used for different data analysis tasks.
 
+For LHCb specific tools (not useful for people outside LHCb) see [this](doc/lhcb.md)
+
+# GIT
+
+## Pushing
+
+From the root directory of a version controlled project (i.e. a directory with the `.git` subdirectory) 
+using a `pyproject.toml` file, run:
+
+```bash
+publish
+```
+
+such that:
+
+1. The `pyproject.toml` file is checked and the version of the project is extracted.
+1. If a tag named as the version exists move to the steps below. 
+1. If it does not, make a new tag with the name as the version
+
+Then, for each remote it pushes the tags and the commits. 
+
+*Why?* 
+
+1. Tags should be named as the project's version
+1. As soon as a new version is created, that version needs to be tagged.
+1. In GitHub, one can configure actions to publish projects when the commits are tagged.
+
 # Generic
 
 This section describes generic tools that could not be put in a specific category, but tend to be useful.

{data_manipulation_utilities-0.0.6 → data_manipulation_utilities-0.0.9}/src/data_manipulation_utilities.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ src/dmu/ml/cv_classifier.py
 src/dmu/ml/cv_predict.py
 src/dmu/ml/train_mva.py
 src/dmu/ml/utilities.py
+src/dmu/physics/utilities.py
 src/dmu/plotting/plotter.py
 src/dmu/plotting/plotter_1d.py
 src/dmu/plotting/plotter_2d.py
@@ -27,6 +28,7 @@ src/dmu/testing/utilities.py
 src/dmu/text/transformer.py
 src/dmu_data/__init__.py
 src/dmu_data/ml/tests/train_mva.yaml
+src/dmu_data/physics/evt_name.yaml
 src/dmu_data/plotting/tests/2d.yaml
 src/dmu_data/plotting/tests/fig_size.yaml
 src/dmu_data/plotting/tests/high_stat.yaml
@@ -42,6 +44,7 @@ src/dmu_data/text/transform_set.txt
 src/dmu_data/text/transform_trf.txt
 src/dmu_scripts/git/publish
 src/dmu_scripts/physics/check_truth.py
+src/dmu_scripts/physics/update_decinfo.py
 src/dmu_scripts/rfile/compare_root_files.py
 src/dmu_scripts/rfile/print_trees.py
 src/dmu_scripts/ssh/coned.py

{data_manipulation_utilities-0.0.6 → data_manipulation_utilities-0.0.9}/src/data_manipulation_utilities.egg-info/entry_points.txt

@@ -4,3 +4,4 @@ compare_root_files = dmu_scripts.rfile.compare_root_files:main
 coned = dmu_scripts.ssh.coned:main
 print_trees = dmu_scripts.rfile.print_trees:main
 transform_text = dmu_scripts.text.transform_text:main
+update_decinfo = dmu_scripts.physics.update_decinfo:main

data_manipulation_utilities-0.0.9/src/dmu/physics/utilities.py

@@ -0,0 +1,57 @@
+'''
+Module containing utility functions
+'''
+from importlib.resources import files
+from functools           import cache
+
+import yaml
+
+# ---------------------------------
+@cache
+def _get_evt_name() -> dict[str,str]:
+    file_path = files('dmu_data').joinpath('physics/evt_name.yaml')
+    file_path = str(file_path)
+    with open(file_path, encoding='utf-8') as ifile:
+        d_data = yaml.safe_load(ifile)
+
+    return d_data
+# ---------------------------------
+def _format_nickname(nickname : str, style : str) -> str:
+    if style == 'literal':
+        return nickname
+
+    if style != 'safe_1':
+        raise ValueError(f'Invalid style: {style}')
+
+    nickname = nickname.replace('.',   'p')
+    nickname = nickname.replace('-',   'mn')
+    nickname = nickname.replace('+',   'pl')
+    nickname = nickname.replace('=', '_eq_')
+    nickname = nickname.replace(',',    '_')
+
+    return nickname
+# ---------------------------------
+def read_decay_name(event_type : str, style : str = 'safe_1') -> str:
+    '''
+    Takes event type, and style strings, returns nickname of decay as defined in DecFiles package
+
+    Styles:
+
+    literal         : No change is made to nickname
+    safe_1 (default): With following replacements:
+        . -> p
+        = -> _eq_
+        - -> mn
+        + -> pl
+        , -> _
+    '''
+    d_evt_name = _get_evt_name()
+
+    if event_type not in d_evt_name:
+        raise ValueError(f'Event type {event_type} not found')
+
+    value = d_evt_name[event_type]
+    value = _format_nickname(value, style)
+
+    return value
+# ---------------------------------