Skip to content

Commit 74b5fff

Browse files
authored
update README instructions for download (#1006)
1 parent cb30446 commit 74b5fff

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,16 @@ Getting Started
88

99
To compile and run `PeleC`, one needs a C++ compiler that supports the C++17 standard. A hierarchical strategy for parallelism is supported, based on MPI, MPI + OpenMP, or MPI + GPU (CUDA/HIP/DPC++). The code should work with all major MPI and OpenMP implementations. PeleC should build and run with no modifications to the `make` system if using a Linux system with the GNU compilers, version 7 and above. The preferred build strategy for most users is to use GNU Make to build executables for individual cases as needed, from the directory containing the case files. CMake, although used mostly for testing, is also an option for building the code.
1010

11-
To build `PeleC` (using the default submodules for AMReX, PelePhysics, and SUNDIALS) and run a sample 3D flame problem::
11+
The best way to download `PeleC` and its necessary dependencies AMReX, PelePhysics, and SUNDIALS (as git submodules) is through a recursive
12+
git clone. To reduce the download size, the ``--shallow-submodules`` and ``--single-branch`` flags can be added to the clone command to omit
13+
extraneous parts of the git history. By default, you will download the latest version of PeleC. If you'd like to use a specific
14+
`released version <https://github.com/AMReX-Combustion/PeleC/releases/>`_
15+
of PeleC, you can add the option ``--branch=<version>``, e.g. ``--branch=v25.04``, to your clone command. ::
16+
17+
git clone --recursive https://github.com/AMReX-Combustion/PeleC.git
18+
19+
To run `PeleC` for a sample 3D flame problem::
1220

13-
git clone --recursive [email protected]:AMReX-Combustion/PeleC.git
1421
cd PeleC/Exec/RegTests/PMF
1522
make TPLrealclean && make realclean && make TPL && make -j
1623
./Pele3d.xxx.yyy.ex example.inp

0 commit comments

Comments
 (0)