Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
slaizet committed Apr 18, 2024
1 parent caee9a6 commit 93260df
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 2 deletions.
12 changes: 10 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ $ git config --global url."https://".insteadOf git@
Be sure to also configure your system to use the appropriate proxy settings,
e.g. by setting the `https_proxy` and `http_proxy` variables.

## Minimum requirements

**cmake version 3.20 and above**

**a recent modern Fortran compiler (ie, gfortran 9 and above**

### The compiling process

The build system for Xcompact3d is based on CMake.
Expand Down Expand Up @@ -125,8 +131,10 @@ $ export decomp2d_DIR=/path/to/2decomp/install/opt/lib/decomp2d
```
Depending on the system *lib* can be *lib64*.

***Note***
Some of the alternative options for FFT and IO backends required additional input
**Note**

Some of the alternative options for FFT and IO backends required additional input.

* For MKL FFT the location of the MKL libraires needs to be passed to the configure as
for the 2DECOMP&FFT installation with
```
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,10 @@ it is possible to customise the coefficients of the second derivative schemes (u
to add extra numerical dissipation in the simulation as a substitute of the missing dissipation
from the small turbulent scales that are not resolved.

Documentation
=============

[Readthedocs](https://xcompact3d.readthedocs.io/en/latest/)



6 changes: 6 additions & 0 deletions docs/pages/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ Installation
The latest version of Xcompact3d only supports `cmake` based builds. The only requirements is a Fortran 90-compatible compiler and a working `MPI` library.


Minimum requirements
====================
**cmake version 3.20 and above**

**a recent modern Fortran compiler (ie, gfortran 9 and above**

Source Download and Compilation
===============================

Expand Down

0 comments on commit 93260df

Please sign in to comment.