Merge branch 'main' of https://github.com/nasa/Plot3D_utilities

Author: pjuangph

README.md

@@ -6,6 +6,30 @@ To install simply do a `pip install plot3d`
 
 > [Link to documentation](https://nasa.github.io/Plot3D_utilities/_build/html/)
 
+## Metis
+Metis is used to group the blocks to be evaluated. So say you have 1000 blocks and 8 CPU. The blocks are split up and sent to the CPU or GPU. The split is done with weighting to block size and connectivity this way each processor is evaluating similar number of nodes. Plot3D Library will work without metis but metis functionality wont be available. 
+
+### Ubuntu 
+Metis needs to be installed and configured as part of your METIS_DLL or LD_LIBRARY path 
+
+1. Download Metis http://glaros.dtc.umn.edu/gkhome/metis/metis/download 
+2. Follow the compiling instructions
+
+Add to your profile for Ubuntu
+```bash
+    # metis
+    export PATH="/home/[username]/metis:$PATH"
+    export LD_LIBRARY_PATH="/home/[username]/metis:$LD_LIBRARY_PATH"
+```
+### Mac
+For Mac. install homebrew and do `brew install metis` then add this to your ~/.zprofile 
+```bash
+    # Metis
+    export METIS_DLL=/opt/homebrew/Cellar/metis/5.1.0/lib/libmetis.dylib
+```
+
+3. Install metis python library `pip install metis`
+
 # Tutorials
 [Reading Writing and Viewing Plot3D files](https://colab.research.google.com/github/nasa/Plot3D_utilities/blob/main/colab/Plot3D_SplitBlocksExample.ipynb)
 

python/examples/metis-block-graph/readme.md

@@ -6,13 +6,20 @@ Metis needs to be installed and configured as part of your METIS_DLL or LD_LIBRA
 1. Download Metis http://glaros.dtc.umn.edu/gkhome/metis/metis/download 
 2. Follow the compiling instructions
 
-Add to your profile 
+Add to your profile for Ubuntu
 ```bash
     # metis
     export PATH="/home/[username]/metis:$PATH"
     export LD_LIBRARY_PATH="/home/[username]/metis:$LD_LIBRARY_PATH"
 ```
 
+For Mac. install homebrew and do `brew install metis` then add this to your ~/.zprofile 
+```bash
+    # Metis
+    PATH=/Users/[username]/.cargo/bin:$PATH
+    export PATH="/Users/[username]/.local/share/solana/install/active_release/bin:$PATH"
+```
+
 3. Install metis python library `pip install metis`
 
 Now you are ready to run the test code.

python/plot3d/__init__.py

@@ -1,3 +1,7 @@
+from __future__ import absolute_import
+from importlib import import_module     
+import os, warnings
+
 from .block import Block, reduce_blocks
 from .blockfunctions import rotate_block,get_outer_bounds,block_connection_matrix
 from .connectivity import find_matching_blocks, get_face_intersection, connectivity_fast, face_matches_to_dict
@@ -10,4 +14,11 @@
 from .point_match import point_match
 from .split_block import split_blocks, Direction
 from .listfunctions import unique_pairs
-from .graph import block_to_graph,get_face_vertex_indices,get_starting_vertex,add_connectivity_to_graph, block_connectivity_to_graph
+
+# Try importing metis
+if os.getenv('METIS_DLL') is not None:
+    if import_module('metis') is not None:
+        import metis
+        from .graph import block_to_graph,get_face_vertex_indices,get_starting_vertex,add_connectivity_to_graph, block_connectivity_to_graph
+else:
+    print("METIS_DLL is not set. metis may not be configured. plot3D will function without metis")