Skip to content

Documentation: Replace flang-new with flang #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rouson wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Documentation: Replace flang-new with flang #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
63ad950
doc: replace flang-new with flang
rouson Feb 20, 2026
5f6f104
doc(demo/README): replace flang-new with flang
rouson Feb 20, 2026
354389b
doc(parallel-testing-with-flang.md): bump caffeine version
rouson Mar 5, 2026
b1643a8
doc(parallel-testing-with-flang.md): bump julienne version
rouson Mar 5, 2026
570f7e5
doc(parallel-testing-with-flang): fix caffeine install info
rouson Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,15 +186,15 @@ Building and Testing
--------------------
With the Fortran Package Manager ([`fpm`]) installed and in your `PATH`, the
commands in the table below will build and run the Julienne test suite. With
`fpm` versions higher than 0.12.0, `flang-new` can be replaced with `flang`.
`fpm` versions lower than 0.13.0, replace `flang` with `flang-new` in the commands below.
For additional information on setting up parallel builds with LLVM, please see
[parallel-testing-with-flang.md](./doc/parallel-testing-with-flang.md).

Compiler/Runtime |Tested Versions|Run Type|Example build/test commands (parallel examples use 2 images)
Vendor/Runtime |Tested Versions|Run Type|Example build/test commands (parallel examples use 2 images)
------------------|---------------|--------|------------------------------------------------------------
LLVM/[Caffeine] |22.0.0git |parallel|`fpm test --compiler flang-new --flag "-O3 -DHAVE_MULTI_IMAGE_SUPPORT -fcoarray" --link-flag "-lcaffeine -lgasnet-smp-seq -L<caffeine-path> -L<gasnet-path>"`
LLVM |20-22 |serial |`fpm test --compiler flang-new --flag -O3`
LLVM |19 |serial |`fpm test --compiler flang-new --flag "-O3 -mmlir -allow-assumed-rank"`
LLVM/[Caffeine] |22.0.0git |parallel|`fpm test --compiler flang --flag "-O3 -DHAVE_MULTI_IMAGE_SUPPORT -fcoarray" --link-flag "-lcaffeine -lgasnet-smp-seq -L<caffeine-path> -L<gasnet-path>"`
LLVM |20-22 |serial |`fpm test --compiler flang --flag -O3`
LLVM |19 |serial |`fpm test --compiler flang --flag "-O3 -mmlir -allow-assumed-rank"`
NAG |7.2, Build 7235|parallel|`NAGFORTRAN_NUM_IMAGES=2 fpm test --compiler nagfor --flag "-fpp -O3 -coarray"`
Intel |2025.2.{0-1} |parallel|`FOR_COARRAY_NUM_IMAGES=2 fpm test --compiler ifx --flag "-fpp -O3 -coarray" --profile release`
GCC/[OpenCoarrays]|14-15 |serial |`fpm test --compiler gfortran --profile release`
Expand Down
7 changes: 4 additions & 3 deletions demo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,11 @@ Running the demonstration tests
With the Fortran Package Manager (`fpm`) installed, please set the `demo`
subdirectory as your present working directory in a shell. Then run the
demonstration test suite using the command below for your compiler.
With `fpm` versions lower than 0.13.0, replace `flang` with `flang-new` below.

|Vendor | Version(s) Tested | Example shell command |
|Vendor | Version(s) Tested | Example shell command |
|-------|-------------------------|--------------------------------------------------|
|LLVM | 20-21 | `fpm test --compiler flang-new --flag "-O3"` |
|LLVM | 20-21 | `fpm test --compiler flang --flag "-O3"` |
Copy link
Copy Markdown
Member

@bonachea bonachea Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|LLVM | 20-21 | `fpm test --compiler flang --flag "-O3"` |
|LLVM | 20-22 | `fpm test --compiler flang --flag "-O3"` |

|GCC | 13-15<sup>1</sup> | `fpm test --compiler gfortran --profile release` |
|NAG | 7.2 Build 7235 | `fpm test --compiler nagfor --flag "-O3 -fpp"` |
|Intel | 2025.2.1 Build 20250806 | `fpm test --compiler ifx --flag "-fpp -O3"` |
Expand All @@ -114,7 +115,7 @@ Please run following command in a `bash` or `zsh` shell with Julienne's root
directory as your present working directory:
```
fpm run scaffold \
--compiler flang-new \
--compiler flang \ # with `fpm` 0.12.0 or older, replace "flang" with "flang-new"
Copy link
Copy Markdown
Member

@bonachea bonachea Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bash comments (as suggested by the # above) don't work like this, you cannot insert them in the middle of a command. If a naive user literally pasted this block into bash the "comment" would cause failure.

Suggest instead putting the comment before or after the command.

-- --json-file demo/test-suite.json \
--suite-path demo/test
```
Expand Down
13 changes: 7 additions & 6 deletions doc/parallel-testing-with-flang.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ LLVM Flang 22 supports the native Fortran parallel programming model used by
Julienne: features that enable launching multiple images, which are instances
of a program. As of this writing, "Flang 22" refers to the main branch of
[llvm-project](https://github.com/llvm/llvm-project), which when built from
source, responds to `flang-new --version` with text that includes `22.0.0git`.
source, responds to `flang --version` with text that includes `22.0.0git`.
Comment on lines 6 to +8
Copy link
Copy Markdown
Member

@bonachea bonachea Feb 20, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Flang 22 is released, this final sentence should probably just be deleted.


To launch multi-image runs, Flang generates calls to the Parallel Runtime
Interface for Fortran [(PRIF)](https://go.lbl.gov/prif). Using these features
Expand Down Expand Up @@ -33,12 +33,12 @@ cd ..
where angular brackets denote variables to replace with your chosen value.

### Build Caffeine and GASNet
An `.install.sh` invocation of the form below _should_ install Caffeine and
An `install.sh` invocation of the form below _should_ install Caffeine and
GASNet in `<caffeine-install-path>/lib`.
```bash
git clone -b 0.6.0 https://github.com/BerkeleyLab/caffeine.git
git clone -b 0.7.0 https://github.com/BerkeleyLab/caffeine.git
cd caffeine
FC=<llvm-install-path>/bin/flang-new \
FC=<llvm-install-path>/bin/flang \
CC=<llvm-install-path>/bin/clang \
CXX=<llvm-install-path>/bin/clang++ \
./install.sh --prefix=<caffeine-install-path>
Expand All @@ -53,11 +53,12 @@ find build -name libcaffeine.a
Then move `libcaffeine.a` to the `<caffeine-install-path>/lib` directory.

### Build and Test Julienne
With `fpm` versions lower than 0.13.0, replace `flang` with `flang-new` below.
```
git clone -b 3.2.0 https://github.com/BerkeleyLab/julienne.git
git clone -b 3.6.1 https://github.com/BerkeleyLab/julienne.git
cd julienne
fpm test \
--compiler flang-new \
--compiler flang \
--flag "-O3 -DHAVE_MULTI_IMAGE_SUPPORT -fcoarray" \
--link-flag "-lcaffeine -lgasnet-smp-seq -L<caffeine-install-path>/lib"
```
Expand Down