readme updates, build script updates

Author: euphoricpoptarts

README.md

@@ -2,7 +2,8 @@
 
 The Jet Partitioner is a parallel graph partitioner that runs on most CPU and GPU systems (via Kokkos, a required dependency).
 This partitioner was developed in a collaboration between Sandia National Labs and Pennsylvania State University.
-For details about the algorithm, please see https://arxiv.org/abs/2304.13194
+For details about the algorithm, please see https://arxiv.org/abs/2304.13194 
+If you intend to cite this partitioner in a publication, please cite https://doi.org/10.1137/23M1559129
 
 ## Dependencies
 
@@ -15,7 +16,7 @@ Metis (https://github.com/KarypisLab/METIS): Used for initial partitioning of co
 
 ### Building
 
-Standard CMake build process. CMake version >= 3.23 required. If your Metis build requires GKlib, add `-DLINK_GKLIB=True` to your cmake command when building Jet. Example build scripts are provided for macOS with OpenMP and Linux systems with Cuda. These scripts handle all required dependencies.
+Standard CMake build process. CMake version >= 3.23 required. If your Metis build requires GKlib, add `-DLINK_GKLIB=True` to your cmake command when building Jet. You can add `-DMETIS_HINT=<metis install location>` to help cmake find metis (and gklib if it has the same install location) if you have not added metis to your relevant path variables. Example build scripts are provided for macOS with OpenMP and Linux systems with Cuda. These scripts handle all required dependencies.
 
 ### Executables
 
@@ -30,13 +31,18 @@ jet\_serial: jet but runs on the host on a single thread.
 pstat: Given a metis graph file, partition file, and k-value, will print out quality information on the partition.
 
 ### Using Jet Partitioner in Your Code
-We provide a cmake package that you can install on your system. Add `find_package(jet CONFIG REQUIRED)` in your project's CMakeLists.txt file and link your executable/s to `jet::jet`. Include `jet.h` in your code to use one of the provided partitioning functions. Each function is distinguished by the target Kokkos execution space it will run in and the type of KokkosKernels CrsMatrix which it accepts. Reference `jet_defs.h` for the relevant template definitions of these parameters. You can set the desired part count and imbalance values on the input config_t struct.
+We provide a cmake package that you can install on your system. Add `find_package(jet CONFIG REQUIRED)` to your project's CMakeLists.txt file and link your executable/s to `jet::jet`. Include `jet.h` in your code to use one of the provided partitioning functions. Each function is distinguished by the target Kokkos execution space it will run in and the type of KokkosKernels CrsMatrix which it accepts. Reference `jet_defs.h` for the relevant template definitions of these parameters. You can set the desired part count and imbalance values on the input config_t struct (see `jet_config.h` for other parameters).
+
+#### Tips
+On Linux systems, you can create a file `~/.cmake/packages/jet/find.txt` that cmake will automatically use to find the jet cmake package.
+Inside this file, add the full path to the jet install directory.
 
 ### Input Format
-We do not yet support vertex weights within metis graph files.
+The partitioner executables accept graphs stored in the metis graph file format. We do not yet support vertex weights within metis graph files.
 
 ### Config File format:  
 \<Coarsening algorithm\> (0 for 2-hop matching)/(1 for HEC)/(2 for pure matching)/(default is 2-hop matching)  
 \<Number of parts\>  
 \<Partitioning attempts\>  
 \<Imbalance value\>  
+\<Ultra quality settings\> (Optional) 1 to enable, 0 to disable (default)

setup_gpu.sh

@@ -44,4 +44,4 @@ cd build
 cmake $ipwd -DCMAKE_PREFIX_PATH=$loc/install/kokkos-kernels/lib/cmake/KokkosKernels \
 -DCMAKE_BUILD_TYPE=Release \
 -DLINK_GKLIB=True -DMETIS_HINT="$loc/local" -DCMAKE_INSTALL_PREFIX="$ipwd/install"
-make -j
+make install -j

setup_mac.sh

@@ -42,4 +42,4 @@ cd build
 cmake $ipwd -DCMAKE_PREFIX_PATH=$loc/install/kokkos-kernels/lib/cmake/KokkosKernels \
 -DCMAKE_CXX_COMPILER=$compiler -DCMAKE_BUILD_TYPE=Release \
 -DLINK_GKLIB=True -DMETIS_HINT="$loc/local" -DCMAKE_INSTALL_PREFIX="$ipwd/install"
-make -j
+make install -j