scnc
/
quantum-espresso
mirror of https://gitlab.com/QEF/q-e.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[skip-CI] Small documentation fixes

This commit is contained in:
Paolo Giannozzi 2022-06-16 16:32:47 +02:00
parent 564a7b4866
commit 2607c398b9
2 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Doc/release-notes
View File

@ -8,10 +8,9 @@ New in 7.1 version:
* If no explicit parallelization options -nk, -nt, -nd are provided,
pw.x will figure out suitable values for optimal, or at least, not
too bad, parallelization
* EPW:
(1) The full-bandwidth approach to the Eliashberg equations and the sparse sampling in the superconductivity module
For the full list of new features, bug fixes, and changes leading to backward incompatibility issues,
please visit the Releases page of the EPW documentation site [https://docs.epw-code.org/doc/Releases.html].
* EPW v.5.5. For the full list of new features, bug fixes, and changes leading
to backward incompatibility issues, please visit the Releases page of the
EPW documentation site [https://docs.epw-code.org/doc/Releases.html].
Incompatible changes in 7.1 version:
* Source files previously found in FFTXLIB/ moved to FFTXLIB/src/

41
Doc/user_guide.tex
View File

@ -370,21 +370,22 @@ The \qe\ distribution contains several directories. Some of them are
common to all packages:
\begin{tabular}{ll}
\texttt{Modules/} & Fortran modules and utilities used by all programs\\
\texttt{upflib/} & pseudopotential-related code, plus conversion tools\\
\texttt{include/} & files *.h included by fortran and C source files\\
\texttt{clib/} & libraries and utilities written in C\\
\texttt{FFTXlib/} & FFT libraries\\
\texttt{LAXlib/} & Linear Algebra (parallel) libraries\\
\texttt{KS\_Solvers/} & Iterative diagonalization routines\\
\texttt{UtilXlib/}& Miscellaneous timing, error handling, MPI utilites\\
\texttt{XClib/} & Exchange-correlation functionals (excepted van der Waals)\\
\texttt{install/} & installation scripts and utilities\\
\texttt{pseudo}/ & pseudopotential files used by examples\\
\texttt{Doc/} & general documentation\\
\texttt{archive/} & external libraries in .tar.gz form\\
\texttt{external/}& external libraries downloaded by CMake\\
\texttt{test-suite/} & automated tests\\
\texttt{Modules/} & Fortran modules and utilities used by all programs\\
\texttt{upflib/} & pseudopotential-related code, plus conversion tools\\
\texttt{include/} & files *.h included by fortran and C source files\\
\texttt{FFTXlib/} & FFT libraries\\
\texttt{LAXlib/} & Linear Algebra (parallel) libraries\\
\texttt{KS\_Solvers/}& Iterative diagonalization routines\\
\texttt{UtilXlib/} & Miscellaneous timing, error handling, MPI utilites\\
\texttt{XClib/} & Exchange-correlation functionals (excepted van der Waals)\\
\texttt{MBD/} & Routines for many-body dispersions
\texttt{LR\_Modules/}& Fortran modules and utilities used by linear-response codes\\
\texttt{install/} & installation scripts and utilities\\
\texttt{pseudo}/ & pseudopotential files used by examples\\
\texttt{Doc/} & general documentation\\
\texttt{archive/} & external libraries in .tar.gz form\\
\texttt{external/} & external libraries downloaded by CMake\\
\texttt{test-suite/} & automated tests
\end{tabular}
\\
while others are specific to a single package:
@ -399,14 +400,14 @@ while others are specific to a single package:
\texttt{CPV/} & \CP\ package\\
\texttt{atomic/} & \texttt{atomic} package\\
\texttt{GUI/} & \texttt{PWGui} package\\
\texttt{QEHeat/} & \texttt{QEHeat} package\\
\texttt{HP/} & \texttt{HP} package
\texttt{QEHeat/} & \texttt{QEHeat} package\\
\texttt{KCW/} & \texttt{KCW} package
\end{tabular}
\\
Finally, directory \texttt{COUPLE/} contains code and documentation
that is useful to call \qe\ programs from external codes; directory
\texttt{LR\_Modules/} contains source files for modules that are common
to all linear-response codes.
that is useful to call \qe\ programs from external codes.
\subsection{Prerequisites}
\label{Sec:Installation}
@ -450,7 +451,7 @@ software). Note that most commercial compilers are also available
free of charge under some conditions (e.g. academic or personal usage, no
support) and may provide MPI libraries and run-time software as well.
\subsection{Building with cMake}
\subsection{Building with CMake}
See \texttt{https://gitlab.com/QEF/q-e/-/wikis/Developers/CMake-build-system}.