Runtime Warnings for load_file

Author: ax3l

src/python/impactx/extensions/KnownElementsList.py

@@ -13,7 +13,26 @@
 
 
 def load_file(self, filename, nslice=1):
-    """Load and append a lattice file from MAD-X (.madx) or PALS (e.g., .pals.yaml) formats."""
+    """Load and append a lattice file from MAD-X (.madx) or PALS (e.g., .pals.yaml) formats.
+
+    .. warning::
+
+       Our MAD-X and PALS parsers are under active development
+       and provided as a preview. Please check any loaded lattice
+       files very carefully. Please report your experience and bugs
+       on our `issue tracker <https://github.com/BLAST-ImpactX/impactx/issues>`__.
+    """
+
+    import warnings
+
+    warnings.warn(
+        "Our MAD-X and PALS parsers are under active development and provided as a "
+        "preview. Please check any loaded lattice files very carefully. Please "
+        "report your experience and bugs on our issue tracker: "
+        "https://github.com/BLAST-ImpactX/impactx/issues",
+        RuntimeWarning,
+        stacklevel=2,
+    )
 
     # Attempt to strip two levels of file extensions to determine the schema.
     #   Examples: fodo.madx, fodo.pals.yaml, fodo.pals.json, ...

src/python/impactx/madx_to_impactx.py

@@ -1106,10 +1106,28 @@ def beam(particle, charge=None, mass=None, energy=None):
 def read_beam(ref: RefPart, madx_file):
     """
     Function that reads elements from a MAD-X file into a list of ImpactX.KnownElements
+
+    .. warning::
+
+       Our MAD-X parser is under active development and provided
+       as a preview. Please check any loaded MAD-X beams very
+       carefully. Please report your experience and bugs on our
+       `issue tracker <https://github.com/BLAST-ImpactX/impactx/issues>`__.
+
     :param RefPart ref: ImpactX reference particle (passed by reference)
     :param madx_file: file name to MAD-X file with beamline elements
     :return: list of ImpactX.KnownElements
     """
+
+    warnings.warn(
+        "Our MAD-X parser is under active development and provided as a preview. "
+        "Please check any loaded MAD-X beams very carefully. Please report your "
+        "experience and bugs on our issue tracker: "
+        "https://github.com/BLAST-ImpactX/impactx/issues",
+        RuntimeWarning,
+        stacklevel=2,
+    )
+
     madx = MADXParser()
     madx.parse(madx_file)