Go to file
giannozz 50d1c488aa Merge branch 'develop_omp5' into 'develop_omp5'
Rename macro for flang+mpi and restore roctx api

See merge request QEF/q-e!2644
2025-06-21 07:28:50 +00:00
.ci
.github
COUPLE Add installation of libqecouple.h 2024-11-26 17:31:23 +00:00
CPV input and initialization of nose hoover thermostat for variable cell dynamics 2025-01-17 10:21:24 +01:00
Doc Updated 2025-02-20 13:55:39 +01:00
EPW DFT+U interface with Wannier90 & visualization of Hubbard projectors 2024-11-29 16:53:23 +00:00
FFTXlib change in macro to avoid conflicts with cmake 2025-06-20 11:05:39 +02:00
GUI End PPCG support 2024-12-12 16:32:36 +01:00
GWW Minor cleanup 2024-12-12 09:15:23 +01:00
HP Check on do_cutoff_2D in the HP code 2025-01-28 11:22:43 +01:00
KCW Remove dep of ups tool on PP 2025-02-09 20:52:54 +01:00
KS_Solvers protect omp target data map 2025-05-03 09:26:40 -05:00
LAXlib
LR_Modules PHONON minimal porting 2025-04-08 18:01:08 +02:00
Modules change in macro to avoid conflicts with cmake 2025-06-20 11:05:39 +02:00
NEB Path interpolation updates 2025-02-18 18:23:23 +01:00
PHonon PHONON minimal porting 2025-04-08 18:01:08 +02:00
PP Workaround for picky compilers 2025-01-18 19:25:34 +01:00
PW not needed in non openmpi gpu path 2025-05-03 09:42:25 -05:00
PWCOND Version updated in documentation 2024-10-16 19:37:50 +02:00
QEHeat Version updated in documentation 2024-10-16 19:37:50 +02:00
TDDFPT Minor cleanup 2024-12-12 09:15:23 +01:00
UtilXlib fix missing call to roctx API 2025-06-20 15:17:47 +02:00
XClib omp5 - XC lda and gga ported 2025-04-08 18:01:07 +02:00
XSpectra
archive
atomic Version updated in documentation 2024-10-16 19:37:50 +02:00
cmake omp5 - CMake updates 2025-04-08 18:01:06 +02:00
dev-tools handling alpha_mix(*) exception for hp.x 2024-10-28 08:24:37 +01:00
dft-d3 DFT-D3 documentation 2024-08-19 12:14:01 +02:00
external Reverted bad commit 2024-11-22 22:24:19 +01:00
include Time to update the version number 2025-02-11 10:22:22 +01:00
install PHONON minimal porting 2025-04-08 18:01:08 +02:00
pseudo Fixing buildbot error in test-suite/epw_2D 2025-01-23 14:57:06 +00:00
test-suite omp5 - XC lda and gga ported 2025-04-08 18:01:07 +02:00
upflib protect with macro 2025-04-30 09:37:00 -05:00
.cmake-format
.editorconfig
.gitignore omp5 - install stuff rebased 2025-03-27 19:45:26 +02:00
.gitlab-ci-main.yml
.gitlab-ci.yml Update CI 2025-01-15 15:27:46 +00:00
.gitmodules
.travis.yml
CMakeLists.txt omp5 - fix in CMakeLists.txt 2025-04-10 14:22:48 +02:00
CONTRIBUTING.md
License
Makefile EPWv5.9 2024-09-15 16:41:41 +00:00
README.md
README_GPU.md
configure
environment_variables
logo.jpg

README.md

q-e-logo

This is the distribution of the Quantum ESPRESSO suite of codes (ESPRESSO: opEn-Source Package for Research in Electronic Structure, Simulation, and Optimization)

License: GPL v2

USAGE

Quick installation instructions for CPU-based machines. For GPU execution, see file README_GPU.md. Go to the directory where this file is.

Using "make" ([] means "optional"):

./configure [options]
make all

"make" alone prints a list of acceptable targets. Optionally, make -jN runs parallel compilation on N processors. Link to binaries are found in bin/.

Using "CMake" (v.3.14 or later):

mkdir ./build
cd ./build
cmake -DCMAKE_Fortran_COMPILER=mpif90 -DCMAKE_C_COMPILER=mpicc [-DCMAKE_INSTALL_PREFIX=/path/to/install] ..
make [-jN]
[make install]

Although CMake has the capability to guess compilers, it is strongly recommended to specify the intended compilers or MPI compiler wrappers as CMAKE_Fortran_COMPILER and CMAKE_C_COMPILER. "make" builds all targets. Link to binaries are found in build/bin. If make install is invoked, directory CMAKE_INSTALL_PREFIX is prepended onto all install directories.

For more information, see the general documentation in directory Doc/, package-specific documentation in */Doc/, and the web site http://www.quantum-espresso.org/. Technical documentation for users and developers can be found on Wiki page on gitlab.

PACKAGES

  • PWscf: structural optimisation and molecular dynamics on the electronic ground state, with self-consistent solution of DFT equations;
  • CP: Car-Parrinello molecular dynamics;
  • PHonon: vibrational and dielectric properties from DFPT (Density-Functional Perturbation Theory);
  • TD-DFPT: spectra from Time-dependent DFPT;
  • HP: calculation of Hubbard parameters from DFPT;
  • EPW: calculation of electron-phonon coefficients, carrier transport, phonon-limited superconductivity and phonon-assisted optical processes;
  • PWCOND: ballistic transport;
  • XSpectra: calculation of X-ray absorption spectra;
  • PWneb: reaction pathways and transition states with the Nudged Elastic Band method;
  • GWL: many-body perturbation theory in the GW approach using ultra-localised Wannier functions and Lanczos chains;
  • QEHeat: energy current in insulators for thermal transport calculations in DFT.
  • KCW: Koopmans-compliant functionals in a Wannier representation

Modular libraries

The following libraries have been isolated and partially encapsulated in view of their release for usage in other codes as well:

  • UtilXlib: performing basic MPI handling, error handling, timing handling.
  • FFTXlib: parallel (MPI and OpenMP) distributed three-dimensional FFTs, performing also load-balanced distribution of data (plane waves, G-vectors and real-space grids) across processors.
  • LAXlib: parallel distributed dense-matrix diagonalization, using ELPA, SCALapack, or a custom algorithm.
  • KS Solvers: parallel iterative diagonalization for the Kohn-Sham Hamiltonian (represented as an operator),using block Davidson and band-by-band or block Conjugate-Gradient algorithms.
  • LRlib: performs a variety of tasks connected with (time-dependent) DFPT, to be used also in connection with Many-Body Perturbation Theory.
  • upflib: pseudopotential-related code.
  • devXlib: low-level utilities for GPU execution

Contributing

Quantum ESPRESSO is an open project: contributions are welcome. Read the Contribution Guidelines to see how you can contribute.

LICENSE

All the material included in this distribution is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

These programs are distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.