Skip to content

Commit

Permalink
add Chapel installation instructions for Mac, Linux, Windows; Windows…
Browse files Browse the repository at this point in the history
… instructions are more of a placeholder for someone to test
  • Loading branch information
Alex Razoumov committed Sep 16, 2024
1 parent ce5893d commit 9545546
Showing 1 changed file with 47 additions and 15 deletions.
62 changes: 47 additions & 15 deletions learners/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: Setup
---

All hands-on work will likely be done on an HPC cluster with Chapel installed. Alternatively, you can run
Chapel via Docker on your computer.
We highly recommend running Chapel on an HPC cluster. Alternatively, you can run Chapel on your computer, but
don't expect a multi-node speedup since you have only one node.

<!-- ## Data Sets -->

Expand All @@ -20,7 +20,8 @@ Chapel via Docker on your computer.

### Details

To be added.
This section describes installing Chapel on your own computer. Before proceeding, please double-check that
your workshop instructors do not already provide Chapel on an HPC cluster.

<!-- Setup for different systems can be presented in dropdown menus via a `spoiler` -->
<!-- tag. They will join to this discussion block, so you can give a general overview -->
Expand All @@ -29,27 +30,58 @@ To be added.

:::::::::::::::::::::::::::::::::::::::::::::::::::

<!-- :::::::::::::::: spoiler -->
:::::::::::::::: spoiler

<!-- ### Windows -->
### Windows

<!-- Use PuTTY -->
Go to the website https://docs.docker.com/docker-for-windows/install/ and download the Docker Desktop
installation file. Double-click on the `Docker_Desktop_Installer.exe` to run the installer. During the
installation process, enable Hyper-V Windows Feature on the Configuration page, and wait for the installation
to complete. At this point you might need to restart your computer.

<!-- :::::::::::::::::::::::: -->
Eventually you want to run https://hub.docker.com/r/chapel/chapel Docker image.

<!-- :::::::::::::::: spoiler -->
::::::::::::::::::::::::

<!-- ### MacOS -->
:::::::::::::::: spoiler

<!-- Use Terminal.app -->
### MacOS

<!-- :::::::::::::::::::::::: -->
The quickest way to get started with Chapel on MacOS is to install it via Homebrew. If you don't have Homebrew
installed (skip this step if you do), open Terminal.app and type

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

<!-- :::::::::::::::: spoiler -->
Next, proceed to installing Chapel:

<!-- ### Linux -->
```bash
brew update
brew install chapel
```

<!-- Use Terminal -->
<!-- Compile and run a test program: -->

<!-- :::::::::::::::::::::::: -->
<!-- ```bash -->
<!-- chpl $(brew --cellar)/chapel/<chapel-version>/libexec/examples/hello.chpl -->
<!-- ./hello -->
<!-- ``` -->

::::::::::::::::::::::::


:::::::::::::::: spoiler

### Linux

At https://github.com/chapel-lang/chapel/releases scroll to the first "Assets" section (you might need to
click on "Show all assets") and pick the latest precompiled Chapel package for your Linux distribution. For
example, with Ubuntu 22.04 you can do:

```bash
wget https://github.com/chapel-lang/chapel/releases/download/2.0.0/chapel-2.1.0-1.ubuntu22.amd64.deb
sudo apt install ./chapel-2.1.0-1.ubuntu22.amd64.deb
```

::::::::::::::::::::::::

0 comments on commit 9545546

Please sign in to comment.