Chapel Quickstart Instructions

These instructions are designed to help users get started with a single-locale (shared-memory) implementation of Chapel from the source distribution of the release as quickly as possible. If you want to understand Chapel’s configuration options, build process, and installation more thoroughly, please refer to Setting up Your Environment for Chapel and Building Chapel instead.

These instructions first have you build a minimal, low-performance configuration of Chapel to reduce build times and the potential for third-party portability issues. Once you are interested in getting better performance or using a full-featured version of Chapel, refer to Using Chapel in its Preferred Configuration below.

  1. See Chapel Prerequisites for information about system tools and packages you should have available to build and run Chapel.

  2. If you don’t already have the Chapel 2.2 source release, see https://chapel-lang.org/download.html.

  3. Build Chapel in its ‘Quickstart’ configuration:

    1. Unpack the source release if you haven’t already:

      tar xzf chapel-2.2.0.tar.gz

    2. Make sure that you are in the directory that was created when unpacking the source release, for example:

      cd chapel-2.2.0

    3. Set up your environment for Chapel’s Quickstart mode. If you are using a shell other than bash or zsh, see Quickstart with Other Shells below.

      source util/quickstart/setchplenv.bash

    4. Use GNU make to build Chapel. On some systems, you may have to use gmake if make is not a GNU version.

      make

  4. Compile an example program, which uses a forall loop to print messages:

    chpl examples/hello3-datapar.chpl

  5. Run the resulting executable, which will print 100 messages in parallel:

    ./hello3-datapar

  6. Experiment with Chapel in this Quickstart mode to your heart’s content. If you’d like to use this build of Chapel in a different shell / terminal session, see Using Chapel in a Different Shell or Terminal below. Once you are comfortable with Chapel and interested in using a full-featured version in the preferred configuration, see the next section.

Using Chapel in its Preferred Configuration

To use Chapel in its preferred, full-featured mode, you will need to rebuild Chapel from source in a different configuration:

  • Open up a new shell to avoid inheriting the previous environment settings.

  • The Quickstart configuration attempts to detect if you have a compatible system installation of LLVM and clang. If you do not, it will set CHPL_LLVM=none for simplicity and to save time. This causes the Chapel compiler to use its C back-end, which is not the preferred option; LLVM is the default back-end, which needs to be available for full functionality. There are a few options for using LLVM:

    • Ensure that you have a compatible version of LLVM installed on your system and enable it with export CHPL_LLVM=system. Once you have it working, you can leave CHPL_LLVM unset and Chapel should detect it if it is in your path. See Chapel Prerequisites for details on the currently supported LLVM versions.

    • Or, use export CHPL_LLVM=bundled to have Chapel build and use the bundled version of LLVM. Note that building the bundled version of LLVM can take a long time and requires CMake version 3.13.4 or higher.

    • Use export CHPL_LLVM=none to continue using the C back-end rather than LLVM

    Please see CHPL_LLVM for more information about CHPL_LLVM and related configuration.

  • If you are interested in building Chapel to support multiple compute nodes (locales), refer to Multilocale Chapel Execution for other settings to enable that.

  • Repeat steps 2-5 above, but in step 2, source util/setchplenv.bash instead of util/quickstart/setchplenv.bash. This will set up your environment to use Chapel in the preferred configuration. Note that building this configuration involves compiling third-party packages, which will increase the overall build time.

    # Set environment variables to preferred configuration
source util/setchplenv.bash

# re-build Chapel
make

# compile a sample program
chpl examples/hello3-datapar.chpl

# run the sample program
./hello3-datapar

    If you run into any portability issues, please see Reporting Chapel Issues.

Using Chapel in a Different Shell or Terminal

Note that in both the Quickstart and preferred modes above, any environment settings made by setchplenv.bash will not persist beyond your current shell/terminal session. One easy way to use Chapel from a different shell or terminal is to re-source the setchplenv.bash script that you used when building Chapel. However since this can quickly become annoying, other strategies are available including a ./configure + make install option. See Using Chapel in a Different Shell / Terminal / Session for details.

Using Chapel in Multi-Locale Mode

All of the instructions above describe how to run Chapel programs in a single-locale (shared-memory) mode. To run using multiple locales (multiple compute nodes with distributed memory), please refer to Multilocale Chapel Execution.

Notes on Performance

If you plan to do performance studies of Chapel programs, be sure to use the full-featured version above, to compile with --fast once your program is correct, and to refer to https://chapel-lang.org/perf-tips.html for other tips.

Quickstart with Other Shells

Use the table below to identify the location of an appropriate Quickstart setchplenv script, based on the shell you use.

If you use:

then type:

a bash-compatible shell (bash/zsh)

source util/quickstart/setchplenv.bash

a csh-compatible shell (csh/tcsh)

source util/quickstart/setchplenv.csh

the fish shell (fish)

. util/quickstart/setchplenv.fish

the Bourne shell (sh)

. util/quickstart/setchplenv.sh

Scripts that set the preferred environment for each shell can be located by removing quickstart/ from the paths above.

What’s next?

For further information about Chapel, refer to the following resources:

Online documentation:

chapel-lang.org/docs

Platform-specific notes:

../platforms

Example Chapel programs:

$CHPL_HOME/examples/README

Setting Chapel env vars:

chplenv.rst

Building the compiler:

building.rst

Compiling Chapel programs:

compiling.rst

Executing Chapel programs:

executing.rst

Debugging Chapel programs:

debugging.rst

Reporting bugs:

bugs.rst

Performance:

https://chapel-lang.org/performance.html

Chapel Editor Support:

editor-support.rst

Chapel’s file/dir structure:

$CHPL_HOME/README.files

Changes since last release:

$CHPL_HOME/CHANGES.md