plot3d 1.7.5__tar.gz → 1.7.7__tar.gz

{plot3d-1.7.5 → plot3d-1.7.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plot3d
-Version: 1.7.5
+Version: 1.7.7
 Summary: Plot3D python utilities for reading and writing and also finding connectivity between blocks
 Author: Paht Juangphanich
 Author-email: paht.juangphanich@nasa.gov
@@ -8,9 +8,10 @@ Requires-Python: >=3.10.12,<4.0.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: matplotlib
 Requires-Dist: networkx
 Requires-Dist: numpy
 Requires-Dist: pandas
-Requires-Dist: pymetis
+Requires-Dist: pymetis ; platform_system != "Windows"
 Requires-Dist: scipy
 Requires-Dist: tqdm

{plot3d-1.7.5 → plot3d-1.7.7}/plot3d/graph.py

@@ -4,8 +4,18 @@ from __future__ import annotations
 from pathlib import Path
 from typing import Dict, List, Sequence, Tuple, Optional
 import inspect
-
-import pymetis  # pip install pymetis
+import sys
+
+if sys.platform != "win32":
+    try:
+        import pymetis  # type: ignore
+        HAS_PYMETIS = True
+    except Exception:  # pragma: no cover - optional dependency
+        pymetis = None  # type: ignore
+        HAS_PYMETIS = False
+else:
+    pymetis = None  # type: ignore
+    HAS_PYMETIS = False
 from .block import Block  # <-- use your existing Block
 
 
@@ -139,7 +149,13 @@ def _metis_part_graph_compat(
     Returns:
         (edgecut, parts)
     """
-    sig_params = set(inspect.signature(pymetis.part_graph).parameters.keys())
+    if not HAS_PYMETIS:
+        raise RuntimeError(
+            "pymetis is not available. On Windows it is skipped during install; "
+            "use Linux/macOS to enable METIS-based partitioning."
+        )
+
+    sig_params = set(inspect.signature(pymetis.part_graph).parameters.keys())  # type: ignore[attr-defined]
 
     # Prefer keyword args when supported
     if {"xadj", "adjncy"}.issubset(sig_params):
@@ -194,6 +210,12 @@ def partition_from_face_matches(
     edge_w : Dict[int, Dict[int, int]]
         Edge weights.
     """
+    if not HAS_PYMETIS:
+        raise RuntimeError(
+            "METIS partitioning is disabled because pymetis is unavailable. "
+            "Install pymetis (Linux/macOS) or run on a platform where it is supported."
+        )
+
     n_blocks = len(blocks)
     adj_list, edge_w = build_weighted_graph_from_face_matches(
         face_matches, n_blocks,

{plot3d-1.7.5 → plot3d-1.7.7}/plot3d/gridpro/import_functions.py

@@ -82,23 +82,54 @@ def read_gridpro_connectivity(
     file_path: str,
     sb_zero_based_in_file: bool = True,     # False if sb1/sb2 are 1-based in file
     index_zero_based_in_file: bool = True,  # False if IMIN..KMAX are 1-based in file
+    inlet_ids: Optional[List[int]] = None,
+    outlet_ids: Optional[List[int]] = None,
+    wall_ids: Optional[List[int]] = None,
+    symm_slip_ids: Optional[List[int]] = None,
+    custom_bc_ids: Optional[Dict[str, List[int]]] = None,
 ) -> Dict[str, object]:
-    """
-        Parse a GridPro connectivity file and return dictionaries compatible with
-        plot3d.connectivity_fast-style shapes.
-
-        Expected P-line layout (as provided):
-        P pid sb1 sf1 sb2 sf2 fmap L1i L1j L1k H1i H1j H1k L2i L2j L2k H2i H2j H2k pty lbid
-
-        Returns:
-        {
-            "face_matches":    List[{"block1":{...}, "block2":{...}}],
-            "outer_faces":    List[{... face dict ...}],
-            "bc_group":       {"inlet":[...], "outlet":[...], "symm_slip":[...], "wall":[...]},
-            "gifs":      List[List[face_dict]],  # grouped by sf1
-            "periodic_faces": List[{"block1":{...}, "block2":{...}}],
-            "volume_zones":   List[{"pty":int, "zone":str, "contiguous_index":int}],
-        }
+    """Parse a GridPro connectivity file into plot3d.connectivity_fast-like structures.
+
+    Expected P-line layout (as provided):
+    ``P pid sb1 sf1 sb2 sf2 fmap L1i L1j L1k H1i H1j H1k L2i L2j L2k H2i H2j H2k pty lbid``
+
+    Boundary-condition IDs default to GridPro's PTY values but can be overridden
+    via the provided *_ids lists or extended via ``custom_bc_ids={"name": [ids]}``.
+
+    Args:
+        file_path: Path to the GridPro connectivity file.
+        sb_zero_based_in_file: Set False if ``sb1/sb2`` are 1-based in the file.
+        index_zero_based_in_file: Set False if IMIN..KMAX are 1-based in the file.
+        inlet_ids: PTY ids to treat as inlet; defaults to ``[5]``.
+        outlet_ids: PTY ids to treat as outlet; defaults to ``[6]``.
+        wall_ids: PTY ids to treat as wall; defaults to ``[2]``.
+        symm_slip_ids: PTY ids to treat as symmetry/slip; defaults to ``[4]``.
+        custom_bc_ids: Optional mapping of ``group_name -> [pty ids]`` for any
+            additional boundary-condition groupings (e.g., ``{"cooling": [500]}``).
+
+    Returns:
+        Dict[str, object]: A dictionary with keys:
+            - ``face_matches``: list of face-pair dictionaries for connected blocks.
+            - ``outer_faces``: list of faces on the exterior (no neighbor).
+            - ``bc_group``: mapping of bc name to list of faces (inlet/outlet/etc.).
+            - ``gif_faces``: list of faces tagged as GIF (pty 12..21 or 1000).
+            - ``periodic_faces``: list of paired periodic faces (pty 3).
+            - ``volume_zones``: list describing volume zone type per superblock.
+
+    Examples:
+        Basic usage with defaults::
+
+            data = read_gridpro_connectivity("connectivity.dat")
+            inlet_faces = data["bc_group"]["inlet"]
+
+        Override built-in BC ids and add a custom group::
+
+            data = read_gridpro_connectivity(
+                "connectivity.dat",
+                inlet_ids=[5, 105],
+                custom_bc_ids={"cooling_hole1": [500]},
+            )
+            cooling_faces = data["bc_group"]["cooling_hole1"]
     """
     # ---------------------------- parsing ----------------------------
     superblock_ptys: List[int] = []
@@ -207,18 +238,25 @@ def read_gridpro_connectivity(
             )
 
     # Boundary-condition groups (by pty)
-    def bc_faces_for(pty_val: int) -> List[Dict[str, int]]:
+    def bc_faces_for(pty_vals: List[int]) -> List[Dict[str, int]]:
+        targets = set(pty_vals)
         return [
             face_dict(p["sb1"], p["L1i"], p["L1j"], p["L1k"], p["H1i"], p["H1j"], p["H1k"], p["pty"]) # type: ignore
-            for p in patches if p["pty"] == pty_val
+            for p in patches if p["pty"] in targets
         ]
 
     bc_group = {
-        "inlet":     bc_faces_for(5),
-        "outlet":    bc_faces_for(6),
-        "symm_slip": bc_faces_for(4),
-        "wall":      bc_faces_for(2),
+        "inlet":     bc_faces_for(inlet_ids or [5]),
+        "outlet":    bc_faces_for(outlet_ids or [6]),
+        "symm_slip": bc_faces_for(symm_slip_ids or [4]),
+        "wall":      bc_faces_for(wall_ids or [2]),
     }
+
+    # add any user-defined boundary groups keyed by name -> list of pty ids
+    if custom_bc_ids:
+        for name, ids in custom_bc_ids.items():
+            if ids:
+                bc_group[name] = bc_faces_for(ids)
     
     # Periodic faces: pty == 3 (explicit pairs)
     periodic_faces: List[Dict[str, Dict[str, int]]] = []

{plot3d-1.7.5 → plot3d-1.7.7}/plot3d/periodicity.py

@@ -365,7 +365,7 @@ def rotated_periodicity(blocks:List[Block], matched_faces:List[Dict[str,int]], o
     """
     gcd_array = list()
     # Find the gcd of all the blocks 
-    if ReduceMesh==True:
+    if ReduceMesh:
         for block_indx in range(len(blocks)):
             block = blocks[block_indx]
             gcd_array.append(math.gcd(block.IMAX-1, math.gcd(block.JMAX-1, block.KMAX-1)))
@@ -410,6 +410,7 @@ def rotated_periodicity(blocks:List[Block], matched_faces:List[Dict[str,int]], o
                 #   Rotate Block 1
                 block1_rotated = blocks_rotated[face1.blockIndex]
                 block2 = blocks[face2.blockIndex]
+                print(f'evaluating working blocks: a={face1.blockIndex} b={face2.blockIndex}')
                 #   Check periodicity
                 df, periodic_faces_temp, split_faces_temp = __periodicity_check__(face1,face2,block1_rotated, block2)
                 

{plot3d-1.7.5 → plot3d-1.7.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "plot3d"
-version = "1.7.5"
+version = "1.7.7"
 description = "Plot3D python utilities for reading and writing and also finding connectivity between blocks"
 authors = ["Paht Juangphanich <paht.juangphanich@nasa.gov>"]
 
@@ -11,10 +11,19 @@ scipy = "*"
 pandas = "*"
 tqdm = "*"
 networkx = "*"
-pymetis = "*"
+pymetis = { version = "*", markers = "platform_system != 'Windows'" }
+matplotlib = "*"
 
 [tool.poetry.group.deve.dependencies]
 
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+sphinx = "^7.4"
+sphinx-rtd-theme = "^2.0"
+sphinx-autobuild = "^2024.4"
+
 [build-system]
 requires = ["poetry>=1.1.2"]
 build-backend = "poetry.masonry.api"