/arkouda-njit

Home of Arachne and other Arkouda functionality provided by researchers at NJIT

Primary LanguageChapelMIT LicenseMIT

Arkouda-NJIT

This is an external repository to build functionality for Arkouda with a focus on advanced graph processing. It is built with the same structure as arkouda-contrib to manage modules and easily swap between the production (arachne) and development (arachne_development) directories.

Prerequisites

  1. Download and build Chapel. Chapel version 1.32.0 and 1.33.0 are supported.
  2. Download but do not build Arkouda. We recommend using the most recent release v2023.11.15.
  3. Follow instructions to activate the Arkouda environment and install all prerequisites. We recommend using Anaconda to manage all dependencies.

Installation

Installation is performed through running the module_configuration.py file. The complete path to the location of arkouda must be specified through ak_loc and the complete path to the location of arachne should be specified through pkg_path.

# Print usage instructions.
python module_configuration.py --help

# Command to execute to build the Arkouda server with Arachne.
python module_configuration.py --ak_loc=/complete/path/to/arkouda/ --pkg_path=/complete/path/to/arkouda-njit/arachne/ | bash

The above command will pipe the following three commands to terminal that installs Arachne using pip, copies the Arkouda server modules to a temporary file, and combines them with the Arachne server modules to build the enhanced arkouda_server.

pip install -U /complete/path/to/arkouda-njit/arachne/client
cp /complete/path/to/arkouda/ServerModules.cfg ~/TmpServerModules.cfg.1683320760
ARKOUDA_SERVER_USER_MODULES=" /complete/path/to/arkouda-njit/arachne/server/BuildGraphMsg.chpl  /complete/path/to/arkouda-njit/arachne/server/PropertyGraphMsg.chpl  /complete/path/to/arkouda-njit/arachne/server/GraphInfoMsg.chpl  /complete/path/to/arkouda-njit/arachne/server/BFSMsg.chpl  /complete/path/to/arkouda-njit/arachne/server/TriCtrMsg.chpl  /complete/path/to/arkouda-njit/arachne/server/TriCntMsg.chpl  /complete/path/to/arkouda-njit/arachne/server/TrussMsg.chpl  /complete/path/to/arkouda-njit/arachne/server/CCMsg.chpl" ARKOUDA_CONFIG_FILE=~/TmpServerModules.cfg.1683320760 ARKOUDA_SKIP_CHECK_DEPS=true make -C /Users/alvaradoo/Research/arkouda

The server can be started as specified in the Arkouda documentation. To run a simple test file as well as pytests please proceed to the arachne folder for those instructions.

Installing Development Arachne

If you are interested in installing the development version of Arachne, please follow the same instructions as above, but for pkg_path include /complete/path/to/arkouda-njit/arachne_development/.

Usage Notes

import arkouda as ak
import arachne as ar
# code using arachne and arkouda below

Common Issues

  • Issue: Unrecognized HDF5, Apache Arrow, etc. installations. Fix: Ensure Makefile.paths was properly added to the base Arkouda directory. More information can be found in the Arkouda build instructions.
  • Issue: Arkouda or Arachne functions are not recognized when executing scripts. Fix: Make sure to run pip3 install -e . at both /complete/path/to/arkouda-njit/arachne/client/. and /complete/path/to/arkouda/. This issue should not pop up for Arachne if the commands generated by module_configuration.py are piped to the terminal.