lheutils 0.0.2__tar.gz → 0.0.4__tar.gz

{lheutils-0.0.2 → lheutils-0.0.4}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: lheutils
-Version: 0.0.2
+Version: 0.0.4
 Summary: Various CLI utilities for handling LHE files
 Project-URL: Homepage, https://github.com/APN-Pucky/lheutils
 Project-URL: Source Code, https://github.com/APN-Pucky/lheutils
 Project-URL: Issue Tracker, https://github.com/APN-Pucky/lheutils/issues
 Project-URL: Releases, https://github.com/APN-Pucky/lheutils/releases
-Author-email: Alexander Puck Neuwirth <a_neuw01@unimib.it>
+Author-email: Alexander Puck Neuwirth <alexander.neuwirth@unimib.it>
 License: Apache-2.0
 License-File: LICENSE
 Keywords: lhe,physics
@@ -26,23 +26,11 @@ Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Physics
 Requires-Python: >=3.9
 Requires-Dist: pylhe>=1.0.0
+Requires-Dist: typing-extensions>=4.0.0
 Provides-Extra: develop
 Requires-Dist: pre-commit; extra == 'develop'
 Requires-Dist: pylhe[lint,test]; extra == 'develop'
 Requires-Dist: tbump>=6.7.0; extra == 'develop'
-Provides-Extra: docs
-Requires-Dist: jupyter-sphinx; extra == 'docs'
-Requires-Dist: myst-nb; extra == 'docs'
-Requires-Dist: myst-parser; extra == 'docs'
-Requires-Dist: nbsphinx; extra == 'docs'
-Requires-Dist: pandoc; extra == 'docs'
-Requires-Dist: sphinx; extra == 'docs'
-Requires-Dist: sphinx-autoapi; extra == 'docs'
-Requires-Dist: sphinx-autobuild; extra == 'docs'
-Requires-Dist: sphinx-copybutton; extra == 'docs'
-Requires-Dist: sphinx-math-dollar; extra == 'docs'
-Requires-Dist: sphinx-rtd-theme>=0.5.0; extra == 'docs'
-Requires-Dist: toml; extra == 'docs'
 Provides-Extra: lint
 Requires-Dist: mypy>=1.0.0; extra == 'lint'
 Requires-Dist: ruff; extra == 'lint'
@@ -54,7 +42,7 @@ Requires-Dist: pytest>=6.0; extra == 'test'
 Requires-Dist: scikit-hep-testdata>=0.5.5; extra == 'test'
 Description-Content-Type: text/markdown
 
-# lheutils v0.0.2
+# lheutils v0.0.4
 
 A collection of utilities for working with LHE files.
 
@@ -62,12 +50,13 @@ A collection of utilities for working with LHE files.
 
 | Program | Description |
 |---------|-------------|
+| `lhe2lhe` | Convert LHE files with different compression and weight format options. |
 | `lhecheck` | Validate LHE files and check momentum conservation. |
+| `lhediff` | Compare two LHE files and report differences. |
 | `lhefilter` | Filter LHE files based on process ID, particle PDG IDs, and event numbers.  |
 | `lheinfo` | Display information about LHE files. |
+| `lhemerge` | Merge LHE files with identical initialization sections (inverse of lhesplit). |
 | `lheshow` | Display specific events or init block from LHE files. |
 | `lhesplit` | Split LHE events from input file into multiple output files. |
-| `lhemerge` | Merge LHE files with identical initialization sections (inverse of lhesplit). |
 | `lhestack` | Stack multiple LHE files into a single file.  |
 | `lheunstack` | Split a single LHE file by process ID into separate files (inverse of lhestack).  |
-| `lhe2lhe` | Convert LHE files with different compression and weight format options. |

{lheutils-0.0.2 → lheutils-0.0.4}/README.md

@@ -1,4 +1,4 @@
-# lheutils v0.0.2
+# lheutils v0.0.4
 
 A collection of utilities for working with LHE files.
 
@@ -6,12 +6,13 @@ A collection of utilities for working with LHE files.
 
 | Program | Description |
 |---------|-------------|
+| `lhe2lhe` | Convert LHE files with different compression and weight format options. |
 | `lhecheck` | Validate LHE files and check momentum conservation. |
+| `lhediff` | Compare two LHE files and report differences. |
 | `lhefilter` | Filter LHE files based on process ID, particle PDG IDs, and event numbers.  |
 | `lheinfo` | Display information about LHE files. |
+| `lhemerge` | Merge LHE files with identical initialization sections (inverse of lhesplit). |
 | `lheshow` | Display specific events or init block from LHE files. |
 | `lhesplit` | Split LHE events from input file into multiple output files. |
-| `lhemerge` | Merge LHE files with identical initialization sections (inverse of lhesplit). |
 | `lhestack` | Stack multiple LHE files into a single file.  |
 | `lheunstack` | Split a single LHE file by process ID into separate files (inverse of lhestack).  |
-| `lhe2lhe` | Convert LHE files with different compression and weight format options. |

{lheutils-0.0.2 → lheutils-0.0.4}/pyproject.toml

@@ -13,7 +13,7 @@ readme = "README.md"
 license = { text = "Apache-2.0" }  # SPDX short identifier
 requires-python = ">=3.9"
 authors = [
-    { name = "Alexander Puck Neuwirth", email = "a_neuw01@unimib.it" },
+    { name = "Alexander Puck Neuwirth", email = "alexander.neuwirth@unimib.it" },
 ]
 keywords = [
     "lhe",
@@ -37,6 +37,7 @@ classifiers = [
 ]
 dependencies = [
     "pylhe>=1.0.0",
+    "typing-extensions>=4.0.0",
 ]
 
 [project.optional-dependencies]
@@ -56,20 +57,7 @@ develop = [
     "pre-commit",
     "tbump>=6.7.0",
 ]
-docs = [
-    "sphinx",
-    "sphinx-copybutton",
-    "sphinx-rtd-theme>=0.5.0",
-    "nbsphinx",
-    "jupyter-sphinx",
-    "sphinx-autoapi",
-    "sphinx-autobuild",
-    "sphinx-math-dollar",
-    "pandoc",
-    "myst-nb",
-    "myst-parser",
-    "toml",
-]
+
 
 [project.urls]
 Homepage = "https://github.com/APN-Pucky/lheutils"
@@ -80,6 +68,7 @@ Homepage = "https://github.com/APN-Pucky/lheutils"
 [project.scripts]
 lhecheck = "lheutils.cli.lhecheck:main"
 lhefilter = "lheutils.cli.lhefilter:main"
+lhefix = "lheutils.cli.lhefix:main"
 lheinfo = "lheutils.cli.lheinfo:main"
 lheshow = "lheutils.cli.lheshow:main"
 lhesplit = "lheutils.cli.lhesplit:main"
@@ -87,6 +76,7 @@ lhemerge = "lheutils.cli.lhemerge:main"
 lhestack = "lheutils.cli.lhestack:main"
 lheunstack = "lheutils.cli.lheunstack:main"
 lhe2lhe = "lheutils.cli.lhe2lhe:main"
+lhediff = "lheutils.cli.lhediff:main"
 
 [tool.hatch.version]
 source = "vcs"

lheutils-0.0.4/src/lheutils/__init__.py

@@ -0,0 +1,3 @@
+from lheutils._version import version as __version__
+
+__all__ = ["__version__"]

{lheutils-0.0.2 → lheutils-0.0.4}/src/lheutils/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.2'
-__version_tuple__ = version_tuple = (0, 0, 2)
+__version__ = version = '0.0.4'
+__version_tuple__ = version_tuple = (0, 0, 4)
 
 __commit_id__ = commit_id = None

lheutils-0.0.4/src/lheutils/_version.pyi

@@ -0,0 +1,2 @@
+version: str
+version_tuple: tuple[int, int, int] | tuple[int, int, int, str, str]

{lheutils-0.0.2 → lheutils-0.0.4}/src/lheutils/cli/lhe2lhe.py

@@ -14,7 +14,6 @@ from typing import Optional
 
 import pylhe
 
-import lheutils
 from lheutils.cli.util import create_base_parser
 
 # We do not want a Python Exception on broken pipe, which happens when piping to 'head' or 'less'
@@ -117,8 +116,9 @@ Weight formats:
     parser.add_argument(
         "--compress",
         "-c",
-        action="store_true",
+        action=argparse.BooleanOptionalAction,
         help="Compress the output file (ignored if output filename ends with .gz/.gzip)",
+        default=False,
     )
 
     parser.add_argument(

{lheutils-0.0.2 → lheutils-0.0.4}/src/lheutils/cli/lhecheck.py

@@ -17,9 +17,8 @@ from dataclasses import dataclass
 from pathlib import Path
 from typing import Any, Optional, TextIO, Union
 
-from typing_extensions import Self
-
 import pylhe
+from typing_extensions import Self
 
 from lheutils.cli.util import create_base_parser
 
@@ -522,9 +521,10 @@ Examples:
     )
 
     parser.add_argument(
-        "--no-total-momentum",
-        action="store_true",
+        "--total-momentum",
+        action=argparse.BooleanOptionalAction,
         help="Skip total momentum conservation checks",
+        default=True,
     )
     parser.add_argument(
         "--total-momentum-rel",
@@ -540,9 +540,10 @@ Examples:
     )
 
     parser.add_argument(
-        "--no-onshell",
-        action="store_true",
+        "--onshell",
+        action=argparse.BooleanOptionalAction,
         help="Skip on-shell mass checks",
+        default=True,
     )
     parser.add_argument(
         "--onshell-rel",
@@ -558,9 +559,10 @@ Examples:
     )
 
     parser.add_argument(
-        "--no-positive-mass",
-        action="store_true",
+        "--positive-mass",
+        action=argparse.BooleanOptionalAction,
         help="Skip positive mass checks",
+        default=True,
     )
     parser.add_argument(
         "--positive-mass-abs",
@@ -595,12 +597,12 @@ Examples:
             sys.exit(1)
 
     lhecargs = LHECheckArgs(
-        positive_mass=not args.no_positive_mass,
+        positive_mass=args.positive_mass,
         positive_mass_abs=args.positive_mass_abs,
-        onshell=not args.no_onshell,
+        onshell=args.onshell,
         onshell_rel=args.onshell_rel,
         onshell_abs=args.onshell_abs,
-        total_momentum=not args.no_total_momentum,
+        total_momentum=args.total_momentum,
         total_momentum_rel=args.total_momentum_rel,
         total_momentum_abs=args.total_momentum_abs,
     )

{lheutils-0.0.2 → lheutils-0.0.4}/src/lheutils/cli/lhediff.py

@@ -16,9 +16,8 @@ from itertools import zip_longest
 from pathlib import Path
 from typing import Any
 
-from typing_extensions import Self
-
 import pylhe
+from typing_extensions import Self
 
 from lheutils.cli.util import create_base_parser
 
@@ -471,12 +470,10 @@ def main() -> None:
         formatter_class=argparse.RawDescriptionHelpFormatter,
         epilog="""
 Examples:
-  lhediff file1.lhe file2.lhe                              # Basic comparison (init + event counts)
-  lhediff file1.lhe file2.lhe --detailed                   # Detailed event-by-event comparison
-  lhediff file1.lhe file2.lhe --detailed -n 100            # Compare only first 100 events
-  lhediff file1.lhe file2.lhe --abs-tol 1e-10              # Allow small absolute differences
+  lhediff file1.lhe file2.lhe                                 # Basic comparison (init + event counts)
+  lhediff file1.lhe file2.lhe --abs-tol 1e-10                 # Allow small absolute differences
   lhediff file1.lhe file2.lhe --rel-tol 1e-6 --abs-tol 1e-12  # Use both relative and absolute tolerance
-  lhediff original.lhe merged.lhe --detailed --rel-tol 1e-10  # Check merge with numeric tolerance
+  lhediff original.lhe merged.lhe --rel-tol 1e-10             # Check merge with numeric tolerance
         """,
     )
 
@@ -485,7 +482,7 @@ Examples:
     parser.add_argument("file2", help="Second LHE file to compare")
 
     parser.add_argument(
-        "--abs-tol",
+        "--abs",
         "-a",
         type=float,
         default=1e-6,
@@ -493,7 +490,7 @@ Examples:
     )
 
     parser.add_argument(
-        "--rel-tol",
+        "--rel",
         "-r",
         type=float,
         default=1e-6,
@@ -501,26 +498,23 @@ Examples:
     )
 
     parser.add_argument(
-        "--no-init",
-        "-ni",
-        action="store_true",
-        default=False,
-        help="Don't compare initialization sections (default: False)",
+        "--init",
+        action=argparse.BooleanOptionalAction,
+        default=True,
+        help="Don't compare initialization sections (default: True)",
     )
 
     parser.add_argument(
-        "--no-events",
-        "-ne",
-        action="store_true",
-        default=False,
-        help="Don't compare events (default: False)",
+        "--events",
+        action=argparse.BooleanOptionalAction,
+        default=True,
+        help="Don't compare events (default: True)",
     )
 
     parser.add_argument(
-        "--no-weights",
-        "-nw",
-        action="store_true",
-        default=False,
+        "--weights",
+        action=argparse.BooleanOptionalAction,
+        default=True,
         help="Don't compare weight groups and weights in detail (default: True)",
     )
 
@@ -540,11 +534,11 @@ Examples:
     lhefilediff = diff_lhe_files(
         args.file1,
         args.file2,
-        init=not args.no_init,
-        weights=not args.no_weights,
-        events=not args.no_events,
-        abs_tol=args.abs_tol,
-        rel_tol=args.rel_tol,
+        init=args.init,
+        weights=args.weights,
+        events=args.events,
+        abs_tol=args.abs,
+        rel_tol=args.rel,
     )
 
     lhead = lhefilediff.print()

lheutils-0.0.4/src/lheutils/cli/lhefix.py

@@ -0,0 +1,161 @@
+#!/usr/bin/env python3
+"""
+CLI tool to fix broken LHE files.
+
+This tool can read from stdin or fix multiple files in place by iterating through
+them as a generator until completion or exception.
+"""
+
+import argparse
+import os
+import sys
+import tempfile
+from collections.abc import Iterable
+from pathlib import Path
+from typing import Optional
+
+import pylhe
+
+from lheutils.cli.util import create_base_parser
+
+
+def fix_file_inplace(
+    filepath: str, compress: bool = False, suffix: Optional[str] = None
+) -> None:
+    """Fix an LHE file in place using temporary file for safety.
+
+    Args:
+        filepath: Path to the LHE file to fix.
+        compress: Whether to gzip-compress the output file.
+        suffix: Suffix to add to the output filename (None means replace original).
+    """
+    try:
+        # Read the original file
+        lhefile = pylhe.LHEFile.fromfile(filepath)
+
+        # Determine output filename
+        filepath_obj = Path(filepath)
+        if suffix is None:
+            # Replace original file
+            output_path = filepath
+            suffix = filepath_obj.suffix
+        else:
+            # Create new filename with prefix/suffix
+            new_name = f"{filepath_obj.stem}{suffix}"
+            output_path = str(filepath_obj.parent / new_name)
+
+        # Create temporary file in same directory as original
+        temp_fd, temp_path = tempfile.mkstemp(
+            suffix=".tmp" + suffix,
+            prefix=filepath_obj.stem + "_",
+            dir=filepath_obj.parent,
+        )
+
+        try:
+            # Close the file descriptor since pylhe will open its own
+            os.close(temp_fd)
+            # Get original file permissions if replacing the file
+            original_stat = os.stat(filepath)
+            # Set temporary file permissions to match original
+            os.chmod(temp_path, original_stat.st_mode)
+
+            # Filter events and write to temporary file
+            def _generator() -> Iterable[pylhe.LHEEvent]:
+                event_count = 0
+                try:
+                    for event in lhefile.events:
+                        event_count += 1
+                        yield event
+                except Exception as e:
+                    print(
+                        f"{filepath} terminating LHE file at event {event_count} due to: {e}"
+                    )
+                    return
+                finally:
+                    print(
+                        f"{filepath} fixed: processed {event_count} events -> {output_path}"
+                    )
+
+            # Write to temporary file
+            pylhe.LHEFile(init=lhefile.init, events=_generator()).tofile(
+                temp_path, gz=compress
+            )
+
+            # Atomically replace/create output file with temporary file
+            os.replace(temp_path, output_path)
+
+        except Exception as e:
+            # Clean up temporary file on error
+            if os.path.exists(temp_path):
+                os.unlink(temp_path)
+            raise e
+
+    except Exception as e:
+        print(f"Error fixing {filepath}: {e}", file=sys.stderr)
+
+
+def fix_from_stdin() -> None:
+    """Fix LHE content from stdin and output to stdout."""
+    try:
+        lhefile = pylhe.LHEFile.frombuffer(sys.stdin)
+
+        # Create generator that handles exceptions gracefully
+        def _generator() -> Iterable[pylhe.LHEEvent]:
+            try:
+                yield from lhefile.events
+            except Exception:
+                # Terminate silently on exception for chaining compatibility
+                return
+
+        # Write fixed LHE to stdout
+        pylhe.LHEFile(init=lhefile.init, events=_generator()).write(sys.stdout)
+
+    except Exception as e:
+        print(f"Error processing stdin: {e}", file=sys.stderr)
+        sys.exit(1)
+
+
+def main() -> None:
+    """Main entry point for lhefix CLI."""
+    parser = create_base_parser(
+        prog="lhefix",
+        description="Fix broken LHE files. Reads from stdin by default or fixes multiple files in place. "
+        "For parallel processing, use GNU parallel: 'parallel -j 8 lhefix ::: *.lhe'.",
+    )
+
+    parser.add_argument(
+        "--suffix",
+        default=".fix.lhe.gz",
+        help="Suffix to add to use for filenames (default: '.fix.lhe.gz').",
+    )
+
+    parser.add_argument(
+        "--compress",
+        "-c",
+        action=argparse.BooleanOptionalAction,
+        help="Compress output files.",
+        default=False,
+    )
+
+    parser.add_argument(
+        "files",
+        nargs="*",
+        help="LHE files to fix in place. If no files provided, reads from stdin.",
+    )
+
+    args = parser.parse_args()
+
+    if not args.files:
+        # No files provided, read from stdin
+        fix_from_stdin()
+    else:
+        # Fix multiple files in place
+        for filepath in args.files:
+            if not Path(filepath).exists():
+                print(f"Error: File not found: {filepath}", file=sys.stderr)
+                continue
+            fix_file_inplace(filepath, args.compress, args.suffix)
+
+
+if __name__ == "__main__":
+    main()