Skip to content

Latest commit

 

History

History
130 lines (95 loc) · 3.98 KB

MAC_INSTALL.md

File metadata and controls

130 lines (95 loc) · 3.98 KB

MacOS

Prerequisites for Arkouda can be installed using Homebrew or manually. Both installation methods have variances to account for the chipset being run.

Install Chapel

It is recommended to compile Chapel from source. Alternatively, it can be installed via Homebrew.

Build from Source (Recommended)

For convenience, the steps to install Chapel from source are detailed here. If you need more information, please visit the Chapel Quickstart Guide.

Step 1

Download the current version of Chapel from here.

Step 2

Unpack the release

tar xzf chapel-1.31.0.tar.gz

Step 3

Access the directory created when the release was unpacked

cd chapel-1.31.0

Step 4

Configure environment variables. Please Note: This command assumes the use of bash or zsh. Please refer to the Chapel Documentation if you are using another shell.

source util/quickstart/setchplenv.bash

Step 5

Update environment variables to the recommended settings.

brew install llvm@14
export CHPL_LLVM=system

brew install gmp
export CHPL_GMP=system

unset CHPL_DEVELOPER

If you choose to use the packages bundled with Chapel, use the following settings.

export CHPL_GMP=bundled
export CHPL_LLVM=bundled

Step 6

Add the following to your rc file.

export CHPL_LLVM=system # set to the same value as in Step 5
export CHPL_RE2=bundled
export CHPL_GMP=system # set to the same value as CHPL_LLVM

Step 7

Use GNU make to build Chapel

make -j 16

Step 8

Ensure that Chapel was built successfully

chpl examples/hello3-datapar.chpl
./hello3-datapar

Homebrew

Chapel and all supporting dependencies will be installed.

brew install chapel

Python Environment - Anaconda

Arkouda provides 2 .yml files for configuration, one for users and one for developers. The .yml files are configured with a default name for the environment, which is used for example interactions with conda. *Please note that you are able to provide a different name by using the -n or --name parameters when calling conda env create

# we recommend running the full Anaconda 
brew install anaconda3

# Note - the exact path may vary based on the release of Anaconda that is current. Run the script to install Anaconda.
/opt/homebrew/Caskroom/anaconda/2022.10/Anaconda3-2022.10-MacOSX-arm64.sh

# initialize conda
conda init

# User conda env
conda env create -f arkouda-env.yml
conda activate arkouda

# Developer conda env
conda env create -f arkouda-env-dev.yml
conda activate arkouda-dev

#These packages are not required, but nice to have (these are included with Anaconda3)
conda install jupyter

# Install the Arkouda Client Package
pip install -e . --no-deps

Updating Environment

As Arkouda progresses through its life-cycle, dependencies may change. As a result, it is recommended that you keep your development environment in sync with the latest dependencies. The instructions vary depending upon you preferred environment management tool.

Anaconda

If you provided a different name when creating the environment, replace arkouda-dev or arkouda with the name of your Conda environment.

# developer environment update
conda env update -n arkouda-dev -f arkouda-env-dev.yml

# user environment update
conda env update -n arkouda -f arkouda-env.yml

Next Steps

Now that you have Arkouda and its dependencies installed on your machine, you will need to be sure to have the appropriate environment variables configured. A complete list can be found at ENVIRONMENT.md.

Once your environment variables are configured, you are ready to build the server. More information on the build process can be found at BUILD.md