forked from dftfeDevelopers/dftfe
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
26 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,7 +3,7 @@ \subsection{Obtaining \dftfe{}} | |
\begin{verbatim} | ||
git clone https://[email protected]/dftfedevelopers/dftfe.git | ||
\end{verbatim} | ||
For internal group testing, use the internalGroupTesting | ||
For internal group testing, use the \verb|internalGroupTesting| branch. | ||
\begin{verbatim} | ||
git checkout internalGroupTesting | ||
\end{verbatim} | ||
|
@@ -12,6 +12,7 @@ \subsection{Compiling required external libraries} | |
Not required for internal group testing if trying to run \dftfe{} on flux. | ||
|
||
\subsection{Compiling \dftfe{}} | ||
Following are the steps to compile DFT-FE (only for flux) | ||
\begin{enumerate} | ||
\item \begin{verbatim} | ||
cd dftfe | ||
|
@@ -31,11 +32,22 @@ \subsection{Compiling \dftfe{}} | |
./setup.sh | ||
\end{verbatim} | ||
\end{enumerate} | ||
If \dftfe{} compiled successfully, the following executables will be created in the \verb|build| directory: | ||
, which by default compiles in the release mode (the fast version). If \dftfe{} compiled successfully, the following executables will be created in the \verb|build| directory: | ||
\begin{verbatim} | ||
/build/release/real/main | ||
/build/release/complex/main | ||
\end{verbatim} | ||
One could also set | ||
\begin{verbatim} | ||
optimizedFlag=1 | ||
\end{verbatim} | ||
inside \verb|setup.sh|, and run | ||
\begin{verbatim} | ||
./setup.sh | ||
\end{verbatim} | ||
, which will create debug mode executables (useful for debugging purposes but much slower than the release mode executable) in the folders | ||
\begin{verbatim} | ||
/build/debug/real/main | ||
/build/debug/complex/main | ||
\end{verbatim} | ||
Among the above executables, the ones in the \verb|build/release/| folder are the fast version, which are meant for production runs. For debugging crashes and bugs, use the executables in the \verb|build/debug/| folder. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,9 @@ | ||
The \verb|real/main| executable uses only real data-structures, which are sufficient for fully non-periodic problems, and periodic and semi-periodic problems with only one Brillouin zone sampling point at the origin. The \verb|complex/main| executable uses complex data-structrues which are required for periodic and semi-periodic problems with multiple Brillouin zone sampling points. | ||
After compiling \dftfe{} as described above, we have now the \verb|real/main| executable, which uses real data-structures for the Kohn-Sham DFT eigen solve. This is sufficient for fully non-periodic problems, and periodic and semi-periodic problems with only one Brillouin zone sampling point at the origin. The other executable is \verb|complex/main|, which uses complex data-structrues for the Kohn-Sham DFT eigen solve. This is required for periodic and semi-periodic problems with multiple Brillouin zone sampling points. These executables are to be used as follows: | ||
\begin{verbatim} | ||
./main parameterFile.prm | ||
\end{verbatim} | ||
or, for a parallel program: | ||
\begin{verbatim} | ||
mpirun -n N ./main parameterFile.prm | ||
\end{verbatim} | ||
to run with N processors. In the above, an input file with \verb|.prm| extension is used. This file contains user-defined parameters as described in Section~\ref{sec:parameters}. For the structure of the input \verb|.prm| file, please follow the examples in the \verb|/dftfe/demo/| folder. |