physpyx 0.2.0__tar.gz → 1.0.0__tar.gz

{physpyx-0.2.0 → physpyx-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: physpyx
-Version: 0.2.0
+Version: 1.0.0
 Summary: Provides a way to use python code in LaTeX
 Author: Jérôme Dufour
 Author-email: Jérôme Dufour <jerome.dufour@eduvaud.ch>

{physpyx-0.2.0 → physpyx-1.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "physpyx"
-version = "0.2.0"
+version = "1.0.0"
 authors = [
 	{ name="Jérôme Dufour", email="jerome.dufour@eduvaud.ch" },
 ]
@@ -33,6 +33,7 @@ docs = [
 	"myst-parser>=4.0.1",
 	"sphinx-autodoc2>=0.5.0",
 	"sphinx-autobuild>=2025.8.25",
+	"sphinx-design>=0.7.0",
 ]
 
 [build-system]

{physpyx-0.2.0 → physpyx-1.0.0}/src/physpyx/__init__.py

@@ -1,5 +1,6 @@
+from .astronomy import Orbit
 from .nuclide import NuclideTable
 from .physpyx import PhysPyX
 from .qty import Qty
 
-__all__ = ["NuclideTable", "PhysPyX", "Qty"]
+__all__ = ["NuclideTable", "PhysPyX", "Qty", "Orbit"]

{physpyx-0.2.0 → physpyx-1.0.0}/src/physpyx/manager.py

@@ -52,6 +52,6 @@ class PTManager(ABC):
             outfile.write("\\ExplSyntaxOn\n")
             error = str(exc_val).replace(" ", "~ ")
             outfile.write(
-                f"\\msg_error:nnnnn {{physpython}} {{python_error}} {{{lineno}}} {{{error}}} {{{faulty_line}}}"
+                f"\\msg_error:nnnnn {{physpyx}} {{python_error}} {{{lineno}}} {{{error}}} {{{faulty_line}}}"
             )
             outfile.write("\n\\ExplSyntaxOff\n")

{physpyx-0.2.0 → physpyx-1.0.0}/src/physpyx/nuclide.py

@@ -99,7 +99,7 @@ class DecayChannels:
                     self.channels = [B]
                     look_for_C = True
                 elif A.prob + B.prob > 100:
-                    logger.warning(f"{symbol} skip 2nd (>100%)")
+                    logger.warning(f"{symbol} skip 2nd ({A.prob + B.prob:.0f}%>100%)")
                     look_for_C = False
                 else:
                     self.channels.append(B)
@@ -110,7 +110,9 @@ class DecayChannels:
                         if C.prob < 1:
                             logger.warning(f"{symbol} skip 3rd (<1% | none)")
                         elif A.prob + B.prob + C.prob > 100:
-                            logger.warning(f"{symbol} skip 3rd (>100%)")
+                            logger.warning(
+                                f"{symbol} skip 3rd ({A.prob + B.prob + C.prob:.0f}%>100%)"
+                            )
                         else:
                             self.channels.append(C)
 

{physpyx-0.2.0 → physpyx-1.0.0}/src/physpyx/qty.py

@@ -11,7 +11,17 @@ logger = getLogger(__name__)
 
 
 class Qty(PTManager):
+    """
+    This class should be used as a context manager.
+    """
+
     def __init__(self, fname: str, context: str = ""):
+        """
+        :param fname: name of the ".pyx" file saved on exit
+        :param context: `Pint` feature that allows unit conversion. For Instance, if
+        the parameter is set to "energy", it will be possible to convert mass to
+        energy and vice-versa.
+        """
         super().__init__(fname)
         self._ureg = SiunitxUnitRegistry()
         self._ureg.define("jour = day")
@@ -35,22 +45,29 @@ class Qty(PTManager):
         else:
             active = {}
         with self._fname.open("w") as outfile:
-            outfile.write("\\ExplSyntaxOn\n")
-            outfile.write("\\prop_gset_from_keyval:Nn \\g_pdb_pytotex_prop {\n")
+            outfile.write("\\prop_gset_from_keyval:Nn \\g_physpyx_pty_prop {\n")
             for name, qty in sys._getframe(2).f_locals.items():
                 if isinstance(qty, SiunitxQuantity):
                     if name == "mu0":
                         qty = r"\qty[input-digits = 0123456789\pi]{4\pi e-7}{\tesla\meter\per\ampere}"
-                    outfile.write(f"\t{{{name}}} = {{{str(qty)}}},\n")
-                    if old := active.pop(name, None):
-                        if old != str(qty):
-                            logger.info(f"update {name}: {old} -> {qty}")
-                    else:
-                        logger.info(f"add {name}: {qty}")
+                    try:
+                        outfile.write(f"\t{{{name}}} = {{{str(qty)}}},\n")
+                        if old := active.pop(name, None):
+                            if old != str(qty):
+                                logger.info(f"update {name}: {old} -> {qty}")
+                        else:
+                            logger.info(f"add {name}: {qty}")
+                    except ValueError as e:
+                        # TODO: report the correct error in
+                        # PTManager.write_errorfile, not the one raised in
+                        # PTManager.__exit__
+                        logger.error(f"exporting {name} failed, {qty._fmt}")
+                        e.add_note(f"exporting {name} failed")
+                        raise e
 
             for name, qty in active.items():
                 logger.info(f"remove {name}: {qty}")
-            outfile.write("}\n\\ExplSyntaxOff\n")
+            outfile.write("}\n")
 
     def __call__(
         self,
@@ -62,6 +79,25 @@ class Qty(PTManager):
         compact: bool = False,
         preferred: bool = False,
     ) -> SiunitxQuantity:
+        """
+        Return an instance of SiunitxQuantity
+
+        :param value: Behaves differently according to its type:
+
+            - Scalar: defines the magnitude of a scalar quantity
+            - list[Scalar]: defines the magnitudes of a numpy.NDArray quantity
+            - str: look for a constant whose name matches value
+
+        :param unit: Assigns the unit if any (ignored for constants).
+        :param to: Immediately converts unit.
+        :param fmt: Sets the amplitude "f-string" format.
+        :param base: If true, converts the unit into SI units.
+        :param compact: As described in the "Pint" documentation "returns a
+        rescaled to compact, human-readable units".
+        :param preferred: If true, attempts to convert unit into simpler one.
+        For instance (kg.m/s2 will be converted to N). Note that, this defaults
+        to "False" only here.
+        """
         if isinstance(value, str):
             if unit is not None:
                 logger.warning("Units are ignored when instanciating a constant")
@@ -80,4 +116,4 @@ class Qty(PTManager):
         q = self._ureg.Quantity(
             value, unit, fmt=fmt, base=base, compact=compact, preferred=preferred
         )
-        return q if to is None else q.out(to=to)
+        return q if to is None else q.fmtex(to=to)

{physpyx-0.2.0 → physpyx-1.0.0}/src/physpyx/quantity.py

@@ -1,4 +1,4 @@
-from typing import cast
+from typing import cast, overload
 from numpy import cross, ndarray, linalg
 
 from logging import getLogger
@@ -85,6 +85,20 @@ class SiunitxQuantity(Quantity):
         compact: bool = False,
         preferred: bool = True,
     ) -> "SiunitxQuantity":
+        """
+        Return an instance of SiunitxQuantity
+
+        :param value: defines the magnitudes of the quantity
+        :param unit: Assigns the unit if any.
+        :param fmt: Sets the amplitude "f-string" format.
+        :param base: If true, converts the unit into SI units.
+        :param compact: As described in the "Pint" documentation "returns a
+        rescaled to compact, human-readable units".
+        :param preferred: If true, attempts to convert unit into simpler one.
+        For instance (kg.m/s2 will be converted to N). Note that, this defaults
+        to "True" which means that all SiunitxQuantity resulting from
+        mathematical operations, will be converted.
+        """
         quantity = cast(SiunitxQuantity, super().__new__(cls, value, units))
         quantity._fmt = fmt
         quantity._base = base
@@ -151,6 +165,11 @@ class SiunitxQuantity(Quantity):
             else:
                 return rf"\num{{{out}}}"
 
+    def __neg__(self) -> "SiunitxQuantity":
+        # NOTE: only useful to fix typing warning Cannot access attribute "???"
+        # for class "PlainQuantity[Unknown]"
+        return cast(SiunitxQuantity, super().__neg__())
+
     def _format_unit(self) -> str:
         num = ""
         den = ""
@@ -183,7 +202,7 @@ class SiunitxQuantity(Quantity):
                 den += r"\per" + tmp
         return num + den
 
-    def out(
+    def fmtex(
         self,
         *,
         to: str | None = None,