Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
WeiqunZhang committed Sep 21, 2024
1 parent b5b168d commit 8c6307a
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 3 deletions.
1 change: 1 addition & 0 deletions .codespell-ignore-words
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
amrexpr
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AMReX's Mathematical Expression Parser
# amrexpr: AMReX's Mathematical Expression Parser

## Overview

Expand All @@ -8,7 +8,7 @@ is designed for high-performance computing applications that solve partial
differential equations on block-structured adaptive meshes. This library is
for users who wish to utilize the parser functionality without incorporating
the full AMReX framework. It supports both CPU and GPU architectures,
including Nvidia, AMD, and Intel GPUs.
including Nvidia, AMD, and Intel GPUs. It requires C++17 or later.

## Features

Expand Down Expand Up @@ -65,6 +65,28 @@ Note that an assignment to an automatic variable must be terminated with
the constants set by `setConstant` and the variables registered by
`registerVariables`.

## Installation

There two ways to install amrexpr.

### Option 1: Using GNU Make

In the `amrexpr` root directory, follow these steps:

```console
$ ./configure
$ make -j8
$ make install
```

To see the list of options, run `./configure -h`. These options allow you to
configure installation directory, choose the compiler, specify GPU backends,
and more.

### Option 2: Using CMake

CMake support is still under development.

## Copyright Notice

AMReX Copyright (c) 2024, The Regents of the University of California,
Expand Down
2 changes: 1 addition & 1 deletion Tools/libamrexpr/configure.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ def configure(argv):
parser.add_argument("--cuda-arch",
help="Specify CUDA architecture. Required when CUDA is enabled.")
parser.add_argument("--amd-arch",
help="Specify AMD GPU architecture. Requried when HIP is enabled.")
help="Specify AMD GPU architecture. Required when HIP is enabled.")
parser.add_argument("--intel-arch",
help="Specify Intel GPU architecture. Optional.")
args = parser.parse_args()
Expand Down

0 comments on commit 8c6307a

Please sign in to comment.