Skip to content

Commit

Permalink
add INSTALL
Browse files Browse the repository at this point in the history
  • Loading branch information
WeiqunZhang committed Apr 23, 2017
1 parent 63a2ee0 commit 8ba64d9
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions INSTALL
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

There are three ways to use AMReX.

(1) Use AMReX's GNU Make build system. There is no installation step
in this approach. Application codes are compiled together with
AMReX codes. Most of the examples in Tutorials can be built this
way. See `Tools/GNUMake/README.md` for more details.

(2) Build and install static library libamrex.a, AMReX headers and
Fortran modules via `./configure` followed by `make` and `make
install`. Type `./configure -h` to show help message. An
application code uses its build system to compile and link to the
AMReX library. See `Tutorials/libamrex_C` for an example. Note
that this approach relies the make system in `Tools/GNUMake/`.
See `Tools/GNUMake/README.md` for more details on the make system.

(3) CMake.

2 changes: 1 addition & 1 deletion Tools/libamrex/configure.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ def configure(argv):
argv[0] = "configure" # So the help message print it
parser = argparse.ArgumentParser()
parser.add_argument("--prefix",
help="Install libarmex, headers and modules in PREFIX directory [default=tmp_install_dir]",
help="Install libarmex, headers and Fortran modules in PREFIX directory [default=tmp_install_dir]",
default="tmp_install_dir")
parser.add_argument("--dim",
help="Dimension [default=3]",
Expand Down

0 comments on commit 8ba64d9

Please sign in to comment.