Quickstart¶

This guide is intended to instruct users on the installation Arkouda. It will also walk through launching and shutting down the server. For usage information, visit our Usage Guide

Install Dependencies¶

Follow the Chapel Quickstart Guide
Follow the Anaconda Installation Guide
Configure your conda environment
```
conda env create -f arkouda-env.yml
```

Install Arkouda¶

Download Arkouda v2023.05.05
Unpack the source files:
```
tar xzf arkouda-2023.05.05.tar.gz
```
Change to the arkouda directory
```
cd arkouda-2023.05.05
```
Build Arkouda
```
make
```
Test Arkouda functionality
```
make test
```

Launching the Server¶

In a terminal, run the arkouda server program with one locale

You should see a startup message like

$ ./arkouda_server -nl 1
server listening on tcp://<your_machine>.local:5555
arkouda server version = 
built with chapel version <chapel_version>
memory limit = 15461882265
bytes of memory used = 0

or with authentication turned on

$ ./arkouda_server -nl 1 --authenticate
server listening on tcp://<your_machine>:5555?token=<token_string>
arkouda server version = 
built with chapel version <chapel_version>
memory limit = 15461882265
bytes of memory used = 0

The first output line is the most important, because it contains the connection url with the hostname and port required for the client to connect to the server.

Connect the Python 3 Client¶

In another terminal window, launch an interactive Python 3 session, such as ipython or jupyter notebook (both included with the Anaconda distribution). To connect to the arkouda server, you must import the arkouda module and call connect with the connection url from the server startup messages. In Python, run

>>> import arkouda as ak
# default way to connect is
>>> ak.connect(connect_url='tcp://node01:5555')
...
connected to tcp://node01:5555

Substituting the hostname and port appropriately (defaults are ‘localhost’ and 5555).

When working on machines running macOS, the code block above may cause the program to hang. This problem is resolved by running the command without the optional argument: ak.connect().

Shutdown/Disconnect¶

If desired, you can disconnect from the arkouda server from a connected client with

>>> ak.disconnect()

or shutdown

>>> ak.shutdown()

This command will delete all server-side arrays and cause the arkouda_server process in the first terminal to exit.

Using Arkouda¶

Want to learn more about using Arkouda? See the Usage Guide section for the full list of operations supported on arkouda arrays. These operations are quite composable and can be used to implement more complex algorithms as in the Examples section.