Go to file
giannozz 10ab5eb6da Merge branch 'userguide' into 'develop'
Badly needed update of the user guide

See merge request QEF/q-e!2637
2025-06-23 06:15:52 +00:00
.ci Update .ci/cineca.yml 2022-07-08 07:26:07 +00:00
.github Misspell (just to test the buildbot) 2022-07-29 09:36:14 +02:00
COUPLE Add installation of libqecouple.h 2024-11-26 17:31:23 +00:00
CPV Removal of a lot of unused code in CP 2025-04-15 09:35:19 +02:00
Doc Badly needed update of the user guide 2025-06-16 22:55:08 +02:00
EPW Fix for serial compilation of EPW 2025-06-19 17:46:32 +00:00
FFTXlib fix fft_interpolate and rebase on develop 2025-06-11 09:26:07 +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 HP bugfix 2025-03-26 08:53:29 +00:00
KCW Kcw bugfix occupation matrix 2025-06-13 05:24:07 +00:00
KS_Solvers more reverts 2025-04-23 15:44:14 +02:00
LAXlib Comment correction. 2025-04-04 20:03:17 -05:00
LR_Modules Fix typo in LR_Modules/ccgsolve_all 2025-06-19 22:24:42 +02:00
Modules First implementation of orbital-resolved DFT+U for SOC/NC 2025-05-08 19:10:44 +02:00
NEB Ready to push added citations and README. 2025-04-23 14:54:51 +02:00
PHonon Add warning in matdyn.x for asr = all with read_lr = false 2025-06-20 12:05:40 +02:00
PIOUD Removed repeated kinds modules. 2025-04-28 11:44:21 +02:00
PP Small cleanup 2025-06-08 12:30:04 +02:00
PW Fix broken DFT+U with debug flags 2025-06-13 08:59:07 +02:00
PWCOND Cleanup; newd_gpu renamed newd_acc 2025-04-28 19:18:34 +02:00
QEHeat Version updated in documentation 2024-10-16 19:37:50 +02:00
TDDFPT Merge branch 'qe_dav' into 'develop' 2025-06-15 08:11:32 +00:00
UtilXlib Merge branch 'mpi_int8' into 'develop' 2025-02-18 20:57:48 +00:00
XClib Move use of dft_setting_params from modules to subroutines in XClib/qe_drivers_XX.f90 2025-06-07 12:35:34 -05:00
XSpectra Example for XANES does not do what it should 2024-05-30 13:57:55 +02:00
archive Keep tracking the archive folder for storing temporary downloaded files needed by install_utils and specific plugins. 2022-02-24 14:39:45 +08:00
atomic Version updated in documentation 2024-10-16 19:37:50 +02:00
cmake More robust MKL DFTI/FFTW3 detection. 2025-06-09 01:08:43 -05: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 Bring d3q plugin up-to-date 2025-06-07 17:25:40 -05:00
include Time to update the version number 2025-02-11 10:22:22 +01:00
install Configure aligned to configure.ac 2025-06-12 09:54:20 +02:00
pseudo Fixing buildbot error in test-suite/epw_2D 2025-01-23 14:57:06 +00:00
test-suite EPW v6.0 2025-06-18 12:55:20 +00:00
upflib Names and numbers for super-heavy atoms added 2025-04-22 17:17:43 +02:00
.cmake-format Add cmake-format config file. 2021-06-14 09:00:43 -05:00
.editorconfig Add editorconfig file 2018-07-19 09:11:34 +02:00
.gitignore adding patterns to .gitignore 2025-01-17 10:21:24 +01:00
.gitlab-ci-main.yml Update 2 files 2024-05-31 13:53:22 +00:00
.gitlab-ci.yml Update CI 2025-01-15 15:27:46 +00:00
.gitmodules included pioud in cmakelist and makefile 2025-04-23 16:06:02 +02:00
.travis.yml Travis CI runs over a Ubuntu distro which does not support MPI-3. 2017-02-12 23:02:49 +00:00
CMakeLists.txt Print Flags in CMake. 2025-05-10 19:02:09 -05:00
CONTRIBUTING.md Fix spelling error 2023-01-03 10:38:53 +00:00
License O-sesame 2003-01-19 21:58:50 +00:00
Makefile added pioud section in the makefile 2025-05-02 09:17:12 +02:00
README.md [skip-CI] More small doc updates 2022-06-22 19:35:46 +02:00
README_GPU.md Updated 2024-06-13 21:37:44 +02:00
configure configure script fixed 2021-10-25 06:51:04 +02:00
environment_variables KCW update pseudo URL 2025-04-10 07:00:05 +00:00
logo.jpg Update Readme 2018-01-28 11:11:52 +00:00

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.