Skip to content

Commit

Permalink
Updates for installing v2.1
Browse files Browse the repository at this point in the history
  • Loading branch information
behoppe committed Jan 17, 2024
1 parent 8ec8ba1 commit a895a43
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 48 deletions.
12 changes: 6 additions & 6 deletions src/doc/users-guide/build-opencilk-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ OpenCilk is available as source code in
[three Git repositories](https://github.com/OpenCilk). We provide an
[infrastructure facilities repository](https://github.com/OpenCilk/infrastructure)
with scripts for downloading and building OpenCilk from source.
OpenCilk 2.0 is only guaranteed to support 64-bit x86 on Linux and other Unix-like
OpenCilk 2.1 is only guaranteed to support 64-bit x86 on Linux and other Unix-like
operating systems, although prototype support for 64-bit ARM is
included.

Expand Down Expand Up @@ -38,7 +38,7 @@ source on a compatible system with prerequisite software installed.
1. Clone the OpenCilk infrastructure repository:

```shell-session
$ git clone -b opencilk/v2.0 https://github.com/OpenCilk/infrastructure
$ git clone -b opencilk/v2.1 https://github.com/OpenCilk/infrastructure
```

2. Run the `get` script to get the OpenCilk source code:
Expand All @@ -63,9 +63,9 @@ Cheetah runtime and OpenCilk tool repositories must be cloned into specific
subdirectories of the OpenCilk project directory:

```shell-session
$ git clone -b opencilk/v2.0 https://github.com/OpenCilk/opencilk-project
$ git clone -b opencilk/v2.0 https://github.com/OpenCilk/cheetah opencilk-project/cheetah
$ git clone -b opencilk/v2.0 https://github.com/OpenCilk/productivity-tools opencilk-project/cilktools
$ git clone -b opencilk/v2.1 https://github.com/OpenCilk/opencilk-project
$ git clone -b opencilk/v2.1 https://github.com/OpenCilk/cheetah opencilk-project/cheetah
$ git clone -b opencilk/v2.1 https://github.com/OpenCilk/productivity-tools opencilk-project/cilktools
```

Note that, because these commands clone specific tags of the OpenCilk
Expand All @@ -76,7 +76,7 @@ Clone the OpenCilk infrastructure repository, which contains the OpenCilk build
script:

```shell-session
$ git clone -b opencilk/v2.0 https://github.com/OpenCilk/infrastructure
$ git clone -b opencilk/v2.1 https://github.com/OpenCilk/infrastructure
```

## Building OpenCilk (detailed instructions)
Expand Down
83 changes: 41 additions & 42 deletions src/doc/users-guide/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,37 @@ eleventyNavigation:
order: -3
download:
host: https://github.com/OpenCilk/opencilk-project/
release: opencilk/v2.0
ubuntu_2004_x86:
shell: OpenCilk-2.0.0-x86_64-Linux-Ubuntu-20.04.sh
binary: OpenCilk-2.0.0-x86_64-Linux-Ubuntu-20.04.tar.gz
size: 764 MB
release: opencilk/v2.1
ubuntu_2204_aarch64:
shell: opencilk-2.1.0-aarch64-linux-gnu-ubuntu-22.04.sh
binary: opencilk-2.1.0-aarch64-linux-gnu-ubuntu-22.04.tar.gz
size: 1.04 GB
ubuntu_2204_x86:
shell: OpenCilk-2.0.0-x86_64-Linux-Ubuntu-22.04.sh
binary: OpenCilk-2.0.0-x86_64-Linux-Ubuntu-22.04.tar.gz
size: 782 MB
shell: opencilk-2.1.0-x86_64-linux-gnu-ubuntu-22.04.sh
binary: opencilk-2.1.0-x86_64-linux-gnu-ubuntu-22.04.tar.gz
size: 1.07 GB
macos_x86:
shell: OpenCilk-2.0.0-x86_64-Apple-Darwin.sh
binary: OpenCilk-2.0.0-x86_64-Apple-Darwin.tar.gz
size: 767 MB
shell: openCilk-2.1.0-x86_64-apple-darwin21.6.0.sh
binary: openCilk-2.1.0-x86_64-apple-darwin21.6.0.tar.gz
size: 1.04 GB
macos_arm:
shell: OpenCilk-2.0.0-arm64-Apple-Darwin.sh
binary: OpenCilk-2.0.0-arm64-Apple-Darwin.tar.gz
size: 695 MB
shell: opencilk-2.1.0-arm64-apple-darwin21.6.0.sh
binary: openCilk-2.1.0-arm64-apple-darwin21.6.0.tar.gz
size: 979 MB
docker:
binary: docker-opencilk-v2.0.tar.gz
size: 1.05 GB
binary: docker-opencilk-v2.1.tar.gz
size: 1.17 GB
---

## System requirements

OpenCilk 2.0 runs on Intel x86 64-bit processors (Haswell and newer), AMD x86
64-bit processors (Excavator and newer), and Apple M1 and other 64-bit
ARM processors. It has been tested on the following operating systems:
OpenCilk 2.1 runs on Intel x86 64-bit processors (Haswell and newer), AMD x86
64-bit processors (Excavator and newer), and various 64-bit ARM processors, including Apple M1 and M2. It has been tested on the following operating systems:

- Ubuntu (18.04, 20.04, 22.04), including via WSL2 (Windows Subsystem for Linux 2)
- FreeBSD (13)
- Fedora (34, 36)
- macOS (10.15, 11.6, 12.4)
- Recent versions of Ubuntu, including via the Windows Subsystem for Linux v2 (WSL2) on Windows 10
- Recent versions of macOS
- FreeBSD 13
- Recent versions of Fedora

{% alert "note", "Prerequisites:" %}
The OpenCilk binaries assume that system header files and system libraries
Expand All @@ -49,7 +48,7 @@ the necessary system files.

## Methods of installation

Precompiled binaries for OpenCilk 2.0 can be installed in several ways:
Precompiled binaries for OpenCilk 2.1 can be installed in several ways:
- Using a [shell archive (`.sh`)](#installing-using-a-shell-archive) built for the target hardware and operating system.
- Using a [tarball (`.tar.gz`)](#installing-using-a-tarball) built for the target hardware and operating system.
- Using a [docker image](#docker-image).
Expand All @@ -60,16 +59,16 @@ which precompiled binaries are not available.

## Installing using a shell archive

To install OpenCilk 2.0 using a shell archive, first download the appropriate shell
To install OpenCilk 2.1 using a shell archive, first download the appropriate shell
archive for your system, then follow the installation instructions.

### Download

Download the appropriate shell archive for your system using one of the following links:

***Linux:***
- [{{ download.ubuntu_2004_x86.shell }}]({{ download.host }}releases/download/{{ download.release }}/{{ download.ubuntu_2004_x86.shell }})
({{ download.ubuntu_2004_x86.size }})
- [{{ download.ubuntu_2204_aarch64.shell }}]({{ download.host }}releases/download/{{ download.release }}/{{ download.ubuntu_2204_aarch64.shell }})
({{ download.ubuntu_2204_aarch64.size }})
- [{{ download.ubuntu_2204_x86.shell }}]({{ download.host }}releases/download/{{ download.release }}/{{ download.ubuntu_2204_x86.shell }})
({{ download.ubuntu_2204_x86.size }})

Expand All @@ -84,7 +83,7 @@ Download the appropriate shell archive for your system using one of the followin
Execute the shell script to extract OpenCilk 2.0 into the current directory. For example:

```shell-session
$ sh OpenCilk-2.0.0-x86_64-Linux-Ubuntu-20.04.sh
$ sh opencilk-2.1.0-x86_64-linux-gnu-ubuntu-22.04.sh
```

You will be prompted to accept the OpenCilk license and whether or not to
Expand All @@ -105,7 +104,7 @@ compilers (e.g., by setting your `PATH` environment variable or installing syste
{% alert "Note", "<span id='example'>Example:</span>" %}

The following example shows the
process on Ubuntu 20.04 to install OpenCilk into `/opt/opencilk` without adding
process on Ubuntu 22.04 to install OpenCilk into `/opt/opencilk` without adding
a version-specific subdirectory. The installation and setup process is
analogous for macOS and other Linux systems.

Expand All @@ -116,8 +115,8 @@ system.

```shell-session
$ mkdir -p /opt/opencilk
$ sh OpenCilk-2.0.0-x86_64-Linux-Ubuntu-20.04.sh --prefix=/opt/opencilk --exclude-subdir
OpenCilk Installer Version: 2.0.0, Copyright (c) OpenCilk
$ sh opencilk-2.1.0-x86_64-linux-gnu-ubuntu-22.04.sh --prefix=/opt/opencilk --exclude-subdir
OpenCilk Installer Version: 2.1.0, Copyright (c) OpenCilk
This is a self-extracting archive.
The archive will be extracted to: /opt/opencilk
Using target directory: /opt/opencilk
Expand All @@ -134,16 +133,16 @@ system-wide symbolic links.

## Installing using a tarball

To install OpenCilk 2.0 using a tarball, first download the appropriate tarball
To install OpenCilk 2.1 using a tarball, first download the appropriate tarball
for your system, then follow the installation instructions.

### Download

Download the appropriate tarball for your system using one of the following links:

***Linux:***
- <a id="{{ download.release }} ubuntu 2004 x86" href="{{ download.host }}releases/download/{{ download.release }}/{{ download.ubuntu_2004_x86.binary }}">{{ download.ubuntu_2004_x86.binary }}</a>
({{ download.ubuntu_2004_x86.size }})
- <a id="{{ download.release }} ubuntu 2204 aarch86" href="{{ download.host }}releases/download/{{ download.release }}/{{ download.ubuntu_2204_aarch64.binary }}">{{ download.ubuntu_2204_aarch64.binary }}</a>
({{ download.ubuntu_2204_aarch64.size }})
- <a id="{{ download.release }} ubuntu 2204 x86" href="{{ download.host }}releases/download/{{ download.release }}/{{ download.ubuntu_2204_x86.binary }}">{{ download.ubuntu_2204_x86.binary }}</a>
({{ download.ubuntu_2204_x86.size }})

Expand All @@ -155,12 +154,12 @@ Download the appropriate tarball for your system using one of the following link

### Install

Extract OpenCilk 2.0 from the downloaded tarball. For example:
Extract OpenCilk 2.1 from the downloaded tarball. For example:
```shell-session
$ tar xvzf OpenCilk-2.0.0-x86_64-Linux-Ubuntu-20.04.tar.gz
$ tar xvzf opencilk-2.1.0-x86_64-linux-gnu-ubuntu-22.04.tar.gz
```
will extract the OpenCilk installation into a subdirectory
`OpenCilk-2.0.0-x86_64-Linux-Ubuntu-20.04/` within the current working directory.
`opencilk-2.0.0-x86_64-linux-gnu-ubuntu-22.04/` within the current working directory.

{% alert "Note", "Note:" %}
Extracting the tarball as above is equivalent to running the corresponding
Expand All @@ -171,25 +170,25 @@ software license.

## Docker image

OpenCilk 2.0 is also available as a [docker](https://www.docker.com/) image based on Ubuntu 20.04.
OpenCilk 2.1 is also available as a [docker](https://www.docker.com/) image based on Ubuntu 22.04.
You can download the docker image here:

- <a id="{{ download.release }} docker" href="{{ download.host }}releases/download/{{ download.release }}/{{ download.docker.binary }}">{{ download.docker.binary }}</a>
({{ download.docker.size }})

The OpenCilk C and C++ compilers are available as `clang` and `clang++` in the
image. To use the OpenCilk 2.0 Docker image, download the
image. To use the OpenCilk 2.1 Docker image, download the
`docker-opencilk-v2.0.tar.gz` file, load the image, and run a container. For
example:

```shell-session
$ docker load -i docker-opencilk-v2.0.tar.gz
$ docker run -it opencilk:v2.0 /bin/bash
$ docker load -i docker-opencilk-v2.1.tar.gz
$ docker run -it opencilk:v2.1 /bin/bash
```

## Next steps

The OpenCilk 2.0 installation includes LLVM 14 with the following OpenCilk
The OpenCilk 2.1 installation includes LLVM 16 with the following OpenCilk
components:

- OpenCilk compiler (with the `clang` and `clang++` front-ends)
Expand Down

0 comments on commit a895a43

Please sign in to comment.