Update example gallery (#315)

APN-Pucky · web-flow · commit 8be7663fb551 · 2025-03-17T12:20:53.000+01:00
* Add coment * Add wikipedia like examples Closes: #85 * Add feynmf examples * Update gallery * Fix serializer config indent
diff --git a/.gitignore b/.gitignore
@@ -153,3 +153,4 @@ tests/out.pdf
 
 .vscode/*
 tmp-*
+pyfeyn2/version.py
diff --git a/docs/source/feynml/attributes/style/label-side.rst b/docs/source/feynml/attributes/style/label-side.rst
@@ -0,0 +1,12 @@
+.. _label-side:
+
+label-side
+=========
+| Valid on: :ref:`leg`, :ref:`propagator`
+| Format: String
+| Values: left, right
+| Default: left
+
+Put the label to the left in the direction of the line or right.
+
+.. include:: ../../../shared/style/label-side.rst
diff --git a/docs/source/gallery/all/all.ipynb b/docs/source/gallery/all/all.ipynb
diff --git a/docs/source/gallery/feynman/feynman.ipynb b/docs/source/gallery/feynman/feynman.ipynb
@@ -27,9 +27,7 @@
    "cell_type": "code",
    "execution_count": 2,
    "id": "ee2b54da",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -218,7 +216,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.16"
+   "version": "3.12.9"
   }
  },
  "nbformat": 4,
diff --git a/docs/source/gallery/feynmf/feynmf.ipynb b/docs/source/gallery/feynmf/feynmf.ipynb
diff --git a/docs/source/gallery/overleaf/overleaf.ipynb b/docs/source/gallery/overleaf/overleaf.ipynb
@@ -26,9 +26,7 @@
    "cell_type": "code",
    "execution_count": 3,
    "id": "0a179236",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -250,9 +248,7 @@
    "cell_type": "code",
    "execution_count": 4,
    "id": "6446cf50",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -474,9 +470,7 @@
    "cell_type": "code",
    "execution_count": 5,
    "id": "ede56f63",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -769,7 +763,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.4"
+   "version": "3.13.2"
   }
  },
  "nbformat": 4,
diff --git a/docs/source/gallery/pyfeyn/pyfeyn.ipynb b/docs/source/gallery/pyfeyn/pyfeyn.ipynb
@@ -29,9 +29,7 @@
    "cell_type": "code",
    "execution_count": 2,
    "id": "d4b571dd",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -507,7 +505,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.4"
+   "version": "3.13.2"
   }
  },
  "nbformat": 4,
diff --git a/docs/source/gallery/wikipedia/wikipedia.ipynb b/docs/source/gallery/wikipedia/wikipedia.ipynb
diff --git a/pyfeyn2/__init__.py b/pyfeyn2/__init__.py
@@ -1,6 +1,5 @@
 """PyFeyn2: A Python package for drawing Feynman diagrams."""
-from importlib.metadata import version
+# Convenient access to the version number
+from .version import version as __version__  # noqa: F401
 
 package = "pyfeyn2"
-
-__version__ = version(package)
diff --git a/pyfeyn2/auto/__init__.py b/pyfeyn2/auto/__init__.py
@@ -0,0 +1,39 @@
+import numpy as np
+
+from pyfeyn2.auto.bend import auto_bend
+from pyfeyn2.auto.debug import auto_debug
+from pyfeyn2.auto.label import auto_label
+from pyfeyn2.auto.position import (
+    auto_align_legs,
+    auto_remove_intersections_by_permuting_legs,
+    auto_vdw,
+)
+
+
+def auto_default(
+    fd,
+    auto_position=True,
+    auto_position_legs=True,
+    debug=False,
+):
+    if auto_position:
+        # remove all unpositioned vertices
+        if auto_position_legs:
+            fd = auto_align_legs(
+                fd,
+                incoming=[(0, i) for i in np.linspace(0, 10, len(fd.get_incoming()))],
+                outgoing=[(10, i) for i in np.linspace(0, 10, len(fd.get_outgoing()))],
+            )
+        p = [v for v in fd.vertices if v.x is None or v.y is None]
+        if len(p) > 0:
+            fd = auto_vdw(fd, points=p)
+        if auto_position_legs:
+            auto_remove_intersections_by_permuting_legs(fd, adjust_points=True)
+            if len(p) > 0:
+                fd = auto_vdw(fd, points=p)
+    auto_label([*fd.propagators, *fd.legs])
+    fd = auto_bend(fd)
+    # Last step enable debug
+    if debug:
+        auto_debug(fd)
+    return fd
diff --git a/pyfeyn2/auto/debug.py b/pyfeyn2/auto/debug.py
@@ -0,0 +1,7 @@
+def auto_debug(fd):
+    for v in fd.vertices:
+        v.with_label(f"{v.id} {{\\{{{v.x:.2g},{v.y:.2g}\\}}}}")
+    for p in fd.propagators:
+        p.with_label(f"{p.id}")
+    for leg in fd.legs:
+        leg.with_label(f"{leg.id} {{\\{{{leg.x:.2g},{leg.y:.2g}\\}}}}")
diff --git a/pyfeyn2/auto/position.py b/pyfeyn2/auto/position.py
@@ -109,11 +109,10 @@ def _compute_number_of_intersects(fd):
     return ci
 
 
-def auto_remove_intersections_by_align_legs(fd, adjust_points=False, size=5):
+def auto_remove_intersections_by_permuting_legs(fd, adjust_points=False, size=10):
     """
     Automatically remove intersections by aligning the legs and reshufffling (permuting) them.
     """
-    fd = auto_align_legs(fd)
     if adjust_points:
         fd = feynman_adjust_points(fd, size=size, clear_vertices=True)
     min_intersections = np.inf
@@ -135,14 +134,14 @@ def auto_remove_intersections_by_align_legs(fd, adjust_points=False, size=5):
         if adjust_points:
             fd = feynman_adjust_points(fd, size=size, clear_vertices=True)
         ci = _compute_number_of_intersects(fd)
-        print(ci)
-        logging.debug(f"auto_remove_intersections_by_align_legs: {ci}")
+        # print(ci)
+        logging.debug(f"auto_remove_intersections_by_align_legs: {ci=}")
         if ci < min_intersections:
             min_intersections = ci
             min_perm = (i, o)
-            logging.debug(f"auto_remove_intersections_by_align_legs: {ci}")
-            logging.debug(f"auto_remove_intersections_by_align_legs: {i} {o}")
-            logging.debug(f"auto_remove_intersections_by_align_legs: {xyin} {xyout}")
+            logging.debug(f"auto_remove_intersections_by_align_legs: {ci=}")
+            logging.debug(f"auto_remove_intersections_by_align_legs: {i=} {o=}")
+            logging.debug(f"auto_remove_intersections_by_align_legs: {xyin=} {xyout=}")
     # use/return best permutation
     for xyi, l in zip(xyin, min_perm[0]):
         inc[l].x = xyi[0]
@@ -155,6 +154,16 @@ def auto_remove_intersections_by_align_legs(fd, adjust_points=False, size=5):
     return fd
 
 
+def auto_remove_intersections_by_align_legs(fd, adjust_points=False, size=10):
+    """
+    Automatically remove intersections by aligning the legs and reshufffling (permuting) them.
+    """
+    fd = auto_align_legs(fd)
+    return auto_remove_intersections_by_permuting_legs(
+        fd, adjust_points=adjust_points, size=size
+    )
+
+
 def auto_align_legs(fd, incoming=None, outgoing=None):
     """
     Automatically reshuffle the legs of a Feynman diagram.
@@ -318,7 +327,7 @@ def scale_positions(fd, scale):
     return fd
 
 
-def feynman_adjust_points(feyndiag, size=5, clear_vertices=False):
+def feynman_adjust_points(feyndiag, size=10, clear_vertices=False):
     """Adjust the points of the vertices and legs using Dot language algorithms."""
     fd = feyndiag
     if clear_vertices:
diff --git a/pyfeyn2/render/latex/tikzfeynman.py b/pyfeyn2/render/latex/tikzfeynman.py
@@ -82,6 +82,7 @@ def stylize_connect(fd: FeynmanDiagram, c: Connector):
                 f"No type or style set for connector  {c.id} {c.type} {c.pdgid}"
             )
             rets += ["plain"]
+    # TODO labels could be in general in {   } to allow commas in general
     for ret in rets:
         if c.label is not None:
             if label_side == "left":
diff --git a/pyfeyn2/version.pyi b/pyfeyn2/version.pyi
@@ -0,0 +1,4 @@
+from __future__ import annotations
+
+version: str
+version_tuple: tuple[int, int, int] | tuple[int, int, int, str, str]
diff --git a/pyproject.toml b/pyproject.toml
@@ -11,7 +11,11 @@ dynamic = ["version"]
 description = 'PyFeyn is a package which makes drawing Feynman diagrams simple and programmatic.  Feynman diagrams are important constructs in perturbative field theory, so being able to draw them in a programmatic fashion is important if attempting to enumerate a large number of diagram configurations is important. The output quality of PyFeyn diagrams (into PDF or EPS formats) is very high, and special effects can be obtained by using constructs from PyX, which PyFeyn is based around'
 readme = "README.md"
 requires-python = ">=3.8"
-keywords = []
+keywords = [
+    "HEP",
+    "feynman",
+    "diagram",
+]
 authors = [
   { name = "Alexander Puck Neuwirth", email = "alexander@neuwirth-informatik.de" },
 ]
@@ -46,7 +50,7 @@ dependencies = [
     "graphviz",
     "ipyparallel",
     "iminuit",
-    "feynml[interfaces]>=0.2.24",
+    "feynml[interfaces]>=0.3.0",
     "asciidraw>=0.1.2",
 ]
 
@@ -81,6 +85,9 @@ dev = [
     "jupyterlab",
 ]
 
+[tool.hatch.metadata]
+allow-direct-references = true
+
 [tool.hatch.envs.all]
 features = [
   "dev",
@@ -90,6 +97,7 @@ features = [
 
 [tool.hatch]
 version.source = "vcs"
+build.hooks.vcs.version-file = "pyfeyn2/version.py"
 
 [tool.hatch.scripts]
 mkfeyndiag = "pyfeyn2.mkfeyndiag:main"
diff --git a/tests/test_fml.py b/tests/test_fml.py
@@ -39,7 +39,7 @@ def test_fml_print():
         ),
         diagrams=[fd],
     )
-    config = SerializerConfig(pretty_print=True)
+    config = SerializerConfig(indent="  ")
     serializer = XmlSerializer(config=config)
     print(serializer.render(fml))
 
@@ -75,7 +75,7 @@ def test_fml_css():
             print("NE", l.style.opacity)
             print(l.style)
             print("tot", l.style.cssText)
-    config = SerializerConfig(pretty_print=True)
+    config = SerializerConfig(indent="  ")
     serializer = XmlSerializer(config=config)
     print(serializer.render(fml))
 
diff --git a/tests/test_xml.py b/tests/test_xml.py
@@ -22,7 +22,7 @@ def test_print_as_xml():
     fd.vertices.append(v2)
     fd.legs.append(l1)
 
-    config = SerializerConfig(pretty_print=True)
+    config = SerializerConfig(indent="  ")
     serializer = XmlSerializer(config=config)
     print(serializer.render(fd))
 

Original file line number	Diff line number	Diff line change
`@@ -153,3 +153,4 @@ tests/out.pdf`
`153`	`153`
`154`	`154`	`.vscode/*`
`155`	`155`	`tmp-*`
	`156`	`+pyfeyn2/version.py`