aiida-quantumespresso
The official AiiDA plugin for Quantum ESPRESSO
General information
Registry checks
Plugins provided
Entry points
-
aiida-quantumespresso
aiida_quantumespresso.cli:cmd_root
-
quantumespresso.bands
class:aiida_quantumespresso.calculations.bands:BandsCalculation`CalcJob` implementation for the bands.x code of Quantum ESPRESSO. bands.x code of the Quantum ESPRESSO distribution, re-orders bands, and computes band-related properties. It computes for instance the expectation value of the momentum operator: <Psi(n,k) | i * m * [H, x] | Psi(m,k)>. For more information, refer to http://www.quantum-espresso.org/
Input Required Valid types Description parent_foldertrue RemoteData, FolderDatacodefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parametersfalse Dict, NoneTypeParameters for the namelists in the input file. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeUse an additional node for special settings Output Required Valid types Description output_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 302 The retrieved folder did not contain the required stdout output file. 310 An exception was raised while reading the `stdout` file: {exception} 311 An exception was raised while parsing the `stdout` file: {exception} 312 The stdout output file was incomplete probably because the calculation got interrupted. -
quantumespresso.cp
class:aiida_quantumespresso.calculations.cp:CpCalculation`CalcJob` implementation for the cp.x code of Quantum ESPRESSO.
Input Required Valid types Description parameterstrue DictThe input parameters that are to be used to construct the input file. pseudostrue UpfData, UpfDataA mapping of `UpfData` nodes onto the kind name to which they should apply. structuretrue StructureDataThe input structure. codefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parallelizationfalse Dict, NoneTypeParallelization options. The following flags are allowed: parent_folderfalse RemoteData, NoneTypeAn optional working directory of a previously completed calculation to restart from. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeOptional parameters to affect the way the calculation job and the parsing are performed. vdw_tablefalse SinglefileData, NoneTypeOptional van der Waals table contained in a `SinglefileData`. Output Required Valid types Description output_parameterstrue Dictoutput_trajectorytrue TrajectoryDataremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 301 The retrieved temporary folder could not be accessed. 302 The retrieved folder did not contain the required stdout output file. 303 The required XML file is not present in the retrieved folder. 304 The retrieved folder contains multiple XML files. 310 The stdout output file could not be read. 311 The stdout output file could not be parsed. 312 The stdout output file was incomplete probably because the calculation got interrupted. 320 The required XML file could not be read. 330 The required POS file could not be read. 340 The required trajectory data could not be read. 400 The calculation stopped prematurely because it ran out of walltime. -
quantumespresso.create_kpoints_from_distance
class:aiida_quantumespresso.calculations.functions.create_kpoints_from_distance:create_kpoints_from_distanceGenerate a uniformly spaced kpoint mesh for a given structure. The spacing between kpoints in reciprocal space is guaranteed to be at least the defined distance. :param structure: the StructureData to which the mesh should apply :param distance: a Float with the desired distance between kpoints in reciprocal space :param force_parity: a Bool to specify whether the generated mesh should maintain parity :returns: a KpointsData with the generated mesh
Input Required Valid types Description distancetrue Dataa Float with the desired distance between kpoints in reciprocal space force_paritytrue Dataa Bool to specify whether the generated mesh should maintain parity structuretrue Datathe StructureData to which the mesh should apply metadatafalse Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. -
quantumespresso.create_magnetic_configuration
class:aiida_quantumespresso.calculations.functions.create_magnetic_configuration:create_magnetic_configurationCreate a new magnetic configuration from the given structure based on a list of magnetic moments per site. To create the new list of kinds, the algorithm loops over all the elements in the structure and makes a list of the sites with that element and their corresponding magnetic moment. Next, it splits this list in three lists: * Zero magnetic moments: Any site that has an absolute magnetic moment lower than ``ztol`` * Positive magnetic moments * Negative magnetic moments The algorithm then sorts the positive and negative lists from large to small absolute value, and loops over each of list. New magnetic kinds will be created when the absolute difference between the magnetic moment of the current kind and the site exceeds ``atol``. The positive and negative magnetic moments are handled separately to avoid assigning two sites with opposite signs in their magnetic moment to the same kind and make sure that each kind has the correct magnetic moment, i.e. the largest magnetic moment in absolute value of the sites corresponding to that kind. .. important:: the function currently does not support alloys. :param structure: a `StructureData` instance. :param magnetic_moment_per_site: list of magnetic moments for each site in the structure. :param atol: the absolute tolerance on determining if two sites have the same magnetic moment. :param ztol: threshold for considering a kind to have non-zero magnetic moment.
Input Required Valid types Description magnetic_moment_per_sitetrue Datalist of magnetic moments for each site in the structure. structuretrue Dataa `StructureData` instance. atolfalse Datathe absolute tolerance on determining if two sites have the same magnetic moment. metadatafalse ztolfalse Datathreshold for considering a kind to have non-zero magnetic moment. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. -
quantumespresso.dos
class:aiida_quantumespresso.calculations.dos:DosCalculation`CalcJob` implementation for the dos.x code of Quantum ESPRESSO.
Input Required Valid types Description parent_foldertrue RemoteData, FolderDatacodefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parametersfalse Dict, NoneTypeParameters for the namelists in the input file. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeUse an additional node for special settings Output Required Valid types Description output_dostrue XyDataoutput_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 302 The retrieved folder did not contain the required stdout output file. 310 An exception was raised while reading the `stdout` file: {exception} 311 An exception was raised while parsing the `stdout` file: {exception} 312 The stdout output file was incomplete probably because the calculation got interrupted. 330 The dos file could not be read from the retrieved folder. -
quantumespresso.matdyn
class:aiida_quantumespresso.calculations.matdyn:MatdynCalculation`CalcJob` implementation for the matdyn.x code of Quantum ESPRESSO.
Input Required Valid types Description force_constantstrue ForceConstantsDatakpointstrue KpointsDataKpoints on which to calculate the phonon frequencies. codefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parametersfalse Dict, NoneTypeParameters for the namelists in the input file. parent_folderfalse RemoteData, NoneTyperemote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeUse an additional node for special settings Output Required Valid types Description output_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. output_phonon_bandsfalse BandsDataoutput_phonon_dosfalse XyDataremote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 302 The retrieved folder did not contain the required stdout output file. 310 An exception was raised while reading the `stdout` file: {exception} 311 An exception was raised while parsing the `stdout` file: {exception} 312 The stdout output file was incomplete probably because the calculation got interrupted. 330 The output frequencies file could not be read from the retrieved folder. 334 The output DOS file could not be read from the retrieved folder. 410 Number of kpoints not found in the output data 411 Number of kpoints in the inputs is not commensurate with those in the output -
quantumespresso.merge_ph_outputs
class:aiida_quantumespresso.calculations.functions.merge_ph_outputs:merge_ph_outputsCalcfunction to merge outputs from multiple `ph.x` calculations with different q-points.
Input Required Valid types Description metadatafalse Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. -
quantumespresso.namelists
class:aiida_quantumespresso.calculations.namelists:NamelistsCalculation`CalcJob` implementation to serve as base class for simple post-processing tools of Quantum ESPRESSO.
Input Required Valid types Description codefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parametersfalse Dict, NoneTypeParameters for the namelists in the input file. parent_folderfalse RemoteData, FolderData, SinglefileData, NoneTypeUse a local or remote folder as parent folder (for restarts and similar) remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeUse an additional node for special settings Output Required Valid types Description remote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 302 The retrieved folder did not contain the required stdout output file. 310 An exception was raised while reading the `stdout` file: {exception} 311 An exception was raised while parsing the `stdout` file: {exception} 312 The stdout output file was incomplete probably because the calculation got interrupted. -
quantumespresso.neb
class:aiida_quantumespresso.calculations.neb:NebCalculationNudged Elastic Band code (neb.x) of Quantum ESPRESSO distribution.
Input Required Valid types Description parameterstrue DictNEB-specific input parameters pwtrue Datacodefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. imagesfalse TrajectoryData, NoneTypeOrdered trajectory of all NEB images along the reaction path, includinginitial, intermediate, and final configurations. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parent_folderfalse RemoteData, NoneTypeAn optional working directory of a previously completed calculation to restart from. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeOptional parameters to affect the way the calculation job and the parsing are performed. Output Required Valid types Description output_meptrue ArrayDataThe original and interpolated energy profiles along the minimum-energy path (mep) output_parameterstrue DictThe output parameters dictionary of the NEB calculation output_trajectorytrue TrajectoryDataremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. iteration_arrayfalse ArrayDataremote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 303 The required XML file is not present in the retrieved folder. 304 The retrieved folder contained multiple XML files. 305 Both the stdout and XML output files could not be read or parsed. 310 The stdout output file could not be read. 320 The XML output file could not be read. 321 The XML output file could not be parsed. 322 The XML output file has an unsupported format. 350 The parser raised an unexpected exception: {exception} 400 The calculation stopped prematurely because it ran out of walltime. 410 The electronic minimization cycle did not reach self-consistency. 461 The code failed with negative dexx in the exchange calculation. 462 The code failed during the cholesky factorization. 463 Too many bands failed to converge during the diagonalization. 464 The S matrix was found to be not positive definite. 465 The `zhegvd` failed in the PPCG diagonalization. 466 The `[Q, R] = qr(X, 0)` failed in the PPCG diagonalization. 467 The eigenvector failed to converge. 468 The factorization in the Broyden routine failed. 502 The NEB minimization cycle did not converge after the maximum number of steps. 503 The NEB minimization cycle did not finish because the calculation was interrupted but a partial trajectory and output structure was successfully parsed which can be used for a restart. -
quantumespresso.open_grid
class:aiida_quantumespresso.calculations.open_grid:OpenGridCalculation``CalcJob`` implementation for the ``open_grid.x`` code of Quantum ESPRESSO.
Input Required Valid types Description parent_foldertrue RemoteData, FolderDataThe output folder of a completed `PwCalculation` on an irreducible Brillouin zone codefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parametersfalse Dict, NoneTypeParameters for the namelists in the input file. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeUse an additional node for special settings Output Required Valid types Description kpointstrue KpointsDataThe explicit list of kpoints of the unfolded kmesh kpoints_meshtrue KpointsDataThe dimensions of the unfolded kmesh output_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 300 The retrieved folder data node could not be accessed. 302 The retrieved folder did not contain the required stdout output file. 310 An exception was raised while reading the `stdout` file: {exception} 311 An exception was raised while parsing the `stdout` file: {exception} 312 The stdout output file was incomplete probably because the calculation got interrupted. 312 Found rotation or fractional translation not compatible with FFT grid. 350 Mismatch between kmesh dimensions and number of kpoints. -
quantumespresso.ph
class:aiida_quantumespresso.calculations.ph:PhCalculation`CalcJob` implementation for the ph.x code of Quantum ESPRESSO.
Input Required Valid types Description parameterstrue Dictparent_foldertrue RemoteDatathe folder of a completed `PwCalculation` qpointstrue KpointsDataqpoint mesh codefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeOutput Required Valid types Description output_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 302 The retrieved folder did not contain the required stdout output file. 305 Both the stdout and XML output files could not be read or parsed. 310 The stdout output file could not be read. 311 The stdout output file could not be parsed. 312 The stdout output file was incomplete probably because the calculation got interrupted. 350 The parser raised an unexpected exception: {exception} 360 The FFT grid is incompatible with the detected symmetries. Try using the lattice-specific `ibrav` != 0 in the parent `pw.x` calculation. 361 The representation found seems to be wrong according to the detected symmetries. Try using the lattice-specific `ibrav` != 0 in the parent `pw.x` calculation. 400 The calculation stopped prematurely because it ran out of walltime. 410 The minimization cycle did not reach self-consistency. 462 The code failed during the cholesky factorization. -
quantumespresso.pp
class:aiida_quantumespresso.calculations.pp:PpCalculation`CalcJob` implementation for the pp.x code of Quantum ESPRESSO.
Input Required Valid types Description parameterstrue DictUse a node that specifies the input parameters for the namelists parent_foldertrue RemoteData, FolderDataOutput folder of a completed `PwCalculation` codefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeOptional parameters to affect the way the calculation job is performed. Output Required Valid types Description output_datatrue ArrayDataoutput_data_multipletrue ArrayDataoutput_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 301 The retrieved temporary folder could not be accessed. 302 The retrieved folder did not contain the required stdout output file. 303 The parent folder did not contain the required XML output file. 310 The stdout output file could not be read. 311 The stdout output file could not be parsed. 312 The stdout output file was incomplete. 330 The formatted data output file `{filename}` was not present in the retrieved (temporary) folder. 331 The formatted data output file `{filename}` could not be read. 332 The data file format is not supported by the parser 333 The formatted data output file `{filename}` could not be parsed: {exception} 340 The calculation stopped prematurely because it ran out of walltime but the job was killed by the scheduler before the files were safely written to disk for a potential restart. 350 The parser raised an unexpected exception: {exception} -
quantumespresso.projwfc
class:aiida_quantumespresso.calculations.projwfc:ProjwfcCalculation`CalcJob` implementation for the projwfc.x code of Quantum ESPRESSO. Projwfc.x code of the Quantum ESPRESSO distribution, handles the the computation of projections of bloch wavefunctions onto atomic orbitals. <Psi(n,k) | Y(theta,phi)R(r) >. For more information, refer to http://www.quantum-espresso.org/
Input Required Valid types Description parent_foldertrue RemoteData, FolderDataThe output folder of a pw.x calculation codefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parametersfalse Dict, NoneTypeParameters for the namelists in the input file. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeUse an additional node for special settings Output Required Valid types Description Dostrue XyDataTotal DOS output_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. Ldosfalse XyDataLDOS for each box in same XyData node Pdosfalse XyDataTotal Projected DOS (on all orbitals or on all boxes if LDOS) bandsfalse BandsDatabands_downfalse BandsDatabands_upfalse BandsDataprojectionsfalse ProjectionDataprojections_downfalse ProjectionDataprojections_upfalse ProjectionDataremote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 301 The retrieved temporary folder could not be accessed. 302 The retrieved folder did not contain the required stdout output file. 303 The retrieved folder did not contain the required XML file. 310 The stdout output file could not be read. 311 The stdout output file could not be parsed. 312 The stdout output file was incomplete probably because the calculation got interrupted. 320 The XML output file could not be read. 321 The XML output file could not be parsed. 322 The XML output file has an unsupported format. 330 The pdos_tot file could not be read from the retrieved folder. 331 The ldos_boxes file could not be read from the retrieved folder. 332 The pdos_tot file is missing from the retrieved folder. 333 The ldos_boxes file is missing from the retrieved folder. 340 An exception was raised parsing bands and projections. 350 The parser raised an unexpected exception: {exception} -
quantumespresso.pw
class:aiida_quantumespresso.calculations.pw:PwCalculation`CalcJob` implementation for the pw.x code of Quantum ESPRESSO.
Input Required Valid types Description kpointstrue KpointsDatakpoint mesh or kpoint path parameterstrue DictThe input parameters that are to be used to construct the input file. pseudostrue UpfData, UpfDataA mapping of `UpfData` nodes onto the kind name to which they should apply. structuretrue StructureDataThe input structure. codefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. hubbard_filefalse SinglefileData, NoneTypeSinglefileData node containing the output Hubbard parameters from a HpCalculation metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parallelizationfalse Dict, NoneTypeParallelization options. The following flags are allowed: npool : The number of 'pools', each taking care of a group of k-points. nband : The number of 'band groups', each taking care of a group of Kohn-Sham orbitals. ntg : The number of 'task groups' across which the FFT planes are distributed. ndiag : The number of 'linear algebra groups' used when parallelizing the subspace diagonalization / iterative orthonormalization. By default, no parameter is passed to Quantum ESPRESSO, meaning it will use its default. parent_folderfalse RemoteData, NoneTypeAn optional working directory of a previously completed calculation to restart from. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeOptional parameters to affect the way the calculation job and the parsing are performed. vdw_tablefalse SinglefileData, NoneTypeOptional van der Waals table contained in a `SinglefileData`. Output Required Valid types Description output_parameterstrue DictThe `output_parameters` output node of the successful calculation. remote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. output_atomic_occupationsfalse Dictoutput_bandfalse BandsDataThe `output_band` output node of the successful calculation if present. output_kpointsfalse KpointsDataoutput_structurefalse StructureDataThe `output_structure` output node of the successful calculation if present. output_trajectoryfalse TrajectoryDataremote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 301 The retrieved temporary folder could not be accessed. 302 The retrieved folder did not contain the required stdout output file. 303 The retrieved folder did not contain the required XML file. 304 The retrieved folder contained multiple XML files. 305 Both the stdout and XML output files could not be read or parsed. 310 The stdout output file could not be read. 311 The stdout output file could not be parsed. 312 The stdout output file was incomplete probably because the calculation got interrupted. 320 The XML output file could not be read. 321 The XML output file could not be parsed. 322 The XML output file has an unsupported format. 340 The calculation stopped prematurely because it ran out of walltime but the job was killed by the scheduler before the files were safely written to disk for a potential restart. 350 The parser raised an unexpected exception: {exception} 360 The code failed in finding a valid reciprocal lattice vector. 400 The calculation stopped prematurely because it ran out of walltime. 410 The electronic minimization cycle did not reach self-consistency. 461 The code failed with negative dexx in the exchange calculation. 462 The code failed during the cholesky factorization. 463 Too many bands failed to converge during the diagonalization. 464 The S matrix was found to be not positive definite. 465 The `zhegvd` failed in the PPCG diagonalization. 466 The `[Q, R] = qr(X, 0)` failed in the PPCG diagonalization. 467 The eigenvector failed to converge. 468 The factorization in the Broyden routine failed. 481 The k-point parallelization "npools" is too high, some nodes have no k-points. 500 The ionic minimization cycle did not converge for the given thresholds. 501 The ionic minimization cycle converged but the thresholds are exceeded in the final SCF. 502 The ionic minimization cycle did not converge after the maximum number of steps. 503 The ionic minimization cycle did not finish because the calculation was interrupted but a partial trajectory and output structure was successfully parsed which can be used for a restart. 510 The electronic minimization cycle failed during an ionic minimization cycle. 511 The ionic minimization cycle converged, but electronic convergence was not reached in the final SCF. 520 The ionic minimization cycle terminated prematurely because of two consecutive failures in the BFGS algorithm. 521 The ionic minimization cycle terminated prematurely because of two consecutive failures in the BFGS algorithm and electronic convergence failed in the final SCF. 531 The difference between the total charge and the number of electrons exceeds the threshold. Smearing might be required, check the output file for details. 541 The variable cell optimization broke the symmetry of the k-points. 542 The cell relaxation caused a significant volume contraction and there is not enough space allocated for radial FFT. 710 The electronic minimization cycle did not reach self-consistency, but `scf_must_converge` is `False` and/or `electron_maxstep` is 0. -
quantumespresso.pw2gw
class:aiida_quantumespresso.calculations.pw2gw:Pw2gwCalculation`CalcJob` implementation for the pw2gw.x code of Quantum ESPRESSO.
Input Required Valid types Description parent_foldertrue RemoteDataOutput folder of a completed `PwCalculation` codefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parametersfalse Dict, NoneTypeParameters for the namelists in the input file. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeUse an additional node for special settings Output Required Valid types Description epstrue ArrayDataThe `eps` output node containing 5 arrays `energy`, `epsX`, `epsY`, `epsZ`, `epsTOT` output_parameterstrue DictThe `output_parameters` output node of the successful calculation.` remote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 302 The retrieved folder did not contain the required stdout output file. 305 The eps*.dat output files could not be read or parsed. 310 An exception was raised while reading the `stdout` file: {exception} 311 An exception was raised while parsing the `stdout` file: {exception} 312 The stdout output file was incomplete probably because the calculation got interrupted. 330 The eps*.dat output files do not have the expected shape (N, 2). 331 The eps*.dat output files contains different values of energies. 350 The parser raised an unexpected exception: {exception} -
quantumespresso.pw2wannier90
class:aiida_quantumespresso.calculations.pw2wannier90:Pw2wannier90Calculation`CalcJob` implementation for the pw2wannier.x code of Quantum ESPRESSO. For more information, refer to http://www.quantum-espresso.org/ and http://www.wannier.org/
Input Required Valid types Description nnkp_filetrue SinglefileDataA SinglefileData containing the .nnkp file generated by wannier90.x -pp parent_foldertrue RemoteData, FolderDataThe output folder of a pw.x calculation codefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. external_projectors_listfalse Dict, NoneTypeDict of projectors with kind name and element symbol. external_projectors_pathfalse RemoteData, NoneTypePath to the external projectors. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parametersfalse Dict, NoneTypeParameters for the namelists in the input file. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeUse an additional node for special settings Output Required Valid types Description output_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 302 The retrieved folder did not contain the required stdout output file. 310 An exception was raised while reading the `stdout` file: {exception} 311 An exception was raised while parsing the `stdout` file: {exception} 312 The stdout output file was incomplete probably because the calculation got interrupted. 340 Encountered a generic error message 350 The parser raised an unexpected exception: {exception} -
quantumespresso.pwimmigrant
class:aiida_quantumespresso.calculations.pwimmigrant:PwimmigrantCalculationCreate a PwCalculation object that can be used to import old jobs. This is a sublass of aiida_quantumespresso.calculations.PwCalculation with slight modifications to some of the class variables and additional methods that a. parse the job's input file to create the calculation's input nodes that would exist if the calculation were submitted using AiiDa, b. bypass the functions of the daemon, and prepare the node's attributes such that all the processes (copying of the files to the repository, results parsing, ect.) can be performed .. note:: The keyword arguments of PwCalculation are also available. :param remote_workdir: Absolute path to the directory where the job was run. The transport of the computer you link ask input to the calculation is the transport that will be used to retrieve the calculation's files. Therefore, ``remote_workdir`` should be the absolute path to the job's directory on that computer. :type remote_workdir: str :param input_file_name: The file name of the job's input file. :type input_file_name: str :param output_file_name: The file name of the job's output file (i.e. the file containing the stdout of QE). :type output_file_name: str
Input Required Valid types Description kpointstrue KpointsDatakpoint mesh or kpoint path parameterstrue DictThe input parameters that are to be used to construct the input file. pseudostrue UpfData, UpfDataA mapping of `UpfData` nodes onto the kind name to which they should apply. structuretrue StructureDataThe input structure. codefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. hubbard_filefalse SinglefileData, NoneTypeSinglefileData node containing the output Hubbard parameters from a HpCalculation metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parallelizationfalse Dict, NoneTypeParallelization options. The following flags are allowed: npool : The number of 'pools', each taking care of a group of k-points. nband : The number of 'band groups', each taking care of a group of Kohn-Sham orbitals. ntg : The number of 'task groups' across which the FFT planes are distributed. ndiag : The number of 'linear algebra groups' used when parallelizing the subspace diagonalization / iterative orthonormalization. By default, no parameter is passed to Quantum ESPRESSO, meaning it will use its default. parent_folderfalse RemoteData, NoneTypeAn optional working directory of a previously completed calculation to restart from. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeOptional parameters to affect the way the calculation job and the parsing are performed. vdw_tablefalse SinglefileData, NoneTypeOptional van der Waals table contained in a `SinglefileData`. Output Required Valid types Description output_parameterstrue DictThe `output_parameters` output node of the successful calculation. remote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. output_atomic_occupationsfalse Dictoutput_bandfalse BandsDataThe `output_band` output node of the successful calculation if present. output_kpointsfalse KpointsDataoutput_structurefalse StructureDataThe `output_structure` output node of the successful calculation if present. output_trajectoryfalse TrajectoryDataremote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 301 The retrieved temporary folder could not be accessed. 302 The retrieved folder did not contain the required stdout output file. 303 The retrieved folder did not contain the required XML file. 304 The retrieved folder contained multiple XML files. 305 Both the stdout and XML output files could not be read or parsed. 310 The stdout output file could not be read. 311 The stdout output file could not be parsed. 312 The stdout output file was incomplete probably because the calculation got interrupted. 320 The XML output file could not be read. 321 The XML output file could not be parsed. 322 The XML output file has an unsupported format. 340 The calculation stopped prematurely because it ran out of walltime but the job was killed by the scheduler before the files were safely written to disk for a potential restart. 350 The parser raised an unexpected exception: {exception} 360 The code failed in finding a valid reciprocal lattice vector. 400 The calculation stopped prematurely because it ran out of walltime. 410 The electronic minimization cycle did not reach self-consistency. 461 The code failed with negative dexx in the exchange calculation. 462 The code failed during the cholesky factorization. 463 Too many bands failed to converge during the diagonalization. 464 The S matrix was found to be not positive definite. 465 The `zhegvd` failed in the PPCG diagonalization. 466 The `[Q, R] = qr(X, 0)` failed in the PPCG diagonalization. 467 The eigenvector failed to converge. 468 The factorization in the Broyden routine failed. 481 The k-point parallelization "npools" is too high, some nodes have no k-points. 500 The ionic minimization cycle did not converge for the given thresholds. 501 The ionic minimization cycle converged but the thresholds are exceeded in the final SCF. 502 The ionic minimization cycle did not converge after the maximum number of steps. 503 The ionic minimization cycle did not finish because the calculation was interrupted but a partial trajectory and output structure was successfully parsed which can be used for a restart. 510 The electronic minimization cycle failed during an ionic minimization cycle. 511 The ionic minimization cycle converged, but electronic convergence was not reached in the final SCF. 520 The ionic minimization cycle terminated prematurely because of two consecutive failures in the BFGS algorithm. 521 The ionic minimization cycle terminated prematurely because of two consecutive failures in the BFGS algorithm and electronic convergence failed in the final SCF. 531 The difference between the total charge and the number of electrons exceeds the threshold. Smearing might be required, check the output file for details. 541 The variable cell optimization broke the symmetry of the k-points. 542 The cell relaxation caused a significant volume contraction and there is not enough space allocated for radial FFT. 710 The electronic minimization cycle did not reach self-consistency, but `scf_must_converge` is `False` and/or `electron_maxstep` is 0. -
quantumespresso.q2r
class:aiida_quantumespresso.calculations.q2r:Q2rCalculation`CalcJob` implementation for the q2r.x code of Quantum ESPRESSO.
Input Required Valid types Description parent_foldertrue RemoteData, FolderDatacodefalse AbstractCode, NoneTypeThe `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. parametersfalse Dict, NoneTypeParameters for the namelists in the input file. remote_folderfalse RemoteData, NoneTypeRemote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual. settingsfalse Dict, NoneTypeUse an additional node for special settings Output Required Valid types Description force_constantstrue ForceConstantsDataoutput_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 100 The process did not have the required `retrieved` output. 110 The job ran out of memory. 120 The job ran out of walltime. 131 The specified account is invalid. 140 The node running the job failed. 150 {message} 160 {message} 302 The retrieved folder did not contain the required stdout output file. 310 An exception was raised while reading the `stdout` file: {exception} 311 An exception was raised while parsing the `stdout` file: {exception} 312 The stdout output file was incomplete probably because the calculation got interrupted. 330 The force constants file could not be read. -
quantumespresso.seekpath_structure_analysis
class:aiida_quantumespresso.calculations.functions.seekpath_structure_analysis:seekpath_structure_analysisPrimitivize the structure with SeeKpath and generate the high symmetry k-point path through its Brillouin zone. This calcfunction will take a structure and pass it through SeeKpath to get the normalized primitive cell and the path of high symmetry k-points through its Brillouin zone. Note that the returned primitive cell may differ from the original structure in which case the k-points are only congruent with the primitive cell. The keyword arguments can be used to specify various Seekpath parameters, such as: with_time_reversal: True reference_distance: 0.025 recipe: 'hpkot' threshold: 1e-07 symprec: 1e-05 angle_tolerance: -1.0 Note that exact parameters that are available and their defaults will depend on your Seekpath version.
Input Required Valid types Description structuretrue Datametadatafalse Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output.
-
quantumespresso.force_constants
aiida_quantumespresso.data.force_constants:ForceConstantsData -
quantumespresso.hubbard_structure
aiida_quantumespresso.data.hubbard_structure:HubbardStructureData
-
quantumespresso.bands
aiida_quantumespresso.parsers.bands:BandsParser -
quantumespresso.cp
aiida_quantumespresso.parsers.cp:CpParser -
quantumespresso.dos
aiida_quantumespresso.parsers.dos:DosParser -
quantumespresso.matdyn
aiida_quantumespresso.parsers.matdyn:MatdynParser -
quantumespresso.neb
aiida_quantumespresso.parsers.neb:NebParser -
quantumespresso.open_grid
aiida_quantumespresso.parsers.open_grid:OpenGridParser -
quantumespresso.ph
aiida_quantumespresso.parsers.ph:PhParser -
quantumespresso.pp
aiida_quantumespresso.parsers.pp:PpParser -
quantumespresso.projwfc
aiida_quantumespresso.parsers.projwfc:ProjwfcParser -
quantumespresso.pw
aiida_quantumespresso.parsers.pw:PwParser -
quantumespresso.pw2gw
aiida_quantumespresso.parsers.pw2gw:Pw2gwParser -
quantumespresso.pw2wannier90
aiida_quantumespresso.parsers.pw2wannier90:Pw2wannier90Parser -
quantumespresso.q2r
aiida_quantumespresso.parsers.q2r:Q2rParser
-
quantumespresso.pw
aiida_quantumespresso.tools.calculations.pw:PwCalculationTools
-
noncollinearhydrogen
aiida_quantumespresso.tools.data.orbital.noncollinearhydrogen:NoncollinearHydrogenOrbital -
spinorbithydrogen
aiida_quantumespresso.tools.data.orbital.spinorbithydrogen:SpinorbitHydrogenOrbital
-
quantumespresso.bands.base
class:aiida_quantumespresso.workflows.bands.base:BandsBaseWorkChainWorkchain to run a Quantum ESPRESSO bands.x calculation with automated error handling and restarts.
Input Required Valid types Description bandstrue Dataclean_workdirfalse BoolIf `True`, work directories of all called calculation jobs will be cleaned at the end of execution. handler_overridesfalse Dict, NoneTypeMapping where keys are process handler names and the values are a dictionary, where each dictionary can define the ``enabled`` and ``priority`` key, which can be used to toggle the values set on the original process handler declaration. max_iterationsfalse IntMaximum number of iterations the work chain will restart the process to finish successfully. metadatafalse on_unhandled_failurefalse Str, NoneTypeAction to take when an unhandled failure occurs. Options: "abort" (default, fail immediately), "pause" (pause the workchain for inspection), "restart_once" (restart once then abort), "restart_and_pause" (restart once then pause if still failing). pause_on_max_iterationsfalse Bool, NoneTypeIf True, pause the workchain for inspection when max_iterations is reached (either globally or for a specific handler) instead of aborting. When resumed, iteration counters are reset to zero. Output Required Valid types Description output_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 300 [deprecated] The calculation failed with an unrecoverable error. 301 The sub process excepted. 302 The sub process was killed. 401 The maximum number of iterations was exceeded. 402 The process failed with an unhandled failure. -
quantumespresso.matdyn.base
class:aiida_quantumespresso.workflows.matdyn.base:MatdynBaseWorkChainWorkchain to run a Quantum ESPRESSO matdyn.x calculation with automated error handling and restarts.
Input Required Valid types Description matdyntrue Dataclean_workdirfalse BoolIf `True`, work directories of all called calculation jobs will be cleaned at the end of execution. handler_overridesfalse Dict, NoneTypeMapping where keys are process handler names and the values are a dictionary, where each dictionary can define the ``enabled`` and ``priority`` key, which can be used to toggle the values set on the original process handler declaration. max_iterationsfalse IntMaximum number of iterations the work chain will restart the process to finish successfully. metadatafalse on_unhandled_failurefalse Str, NoneTypeAction to take when an unhandled failure occurs. Options: "abort" (default, fail immediately), "pause" (pause the workchain for inspection), "restart_once" (restart once then abort), "restart_and_pause" (restart once then pause if still failing). pause_on_max_iterationsfalse Bool, NoneTypeIf True, pause the workchain for inspection when max_iterations is reached (either globally or for a specific handler) instead of aborting. When resumed, iteration counters are reset to zero. Output Required Valid types Description output_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. output_phonon_bandsfalse BandsDataoutput_phonon_dosfalse XyDataremote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 300 [deprecated] The calculation failed with an unrecoverable error. 301 The sub process excepted. 302 The sub process was killed. 401 The maximum number of iterations was exceeded. 402 The process failed with an unhandled failure. -
quantumespresso.neb.base
class:aiida_quantumespresso.workflows.neb.base:NebBaseWorkChainWorkchain to run a Quantum ESPRESSO neb.x calculation with automated error handling and restarts.
Input Required Valid types Description nebtrue Dataclean_workdirfalse BoolIf `True`, work directories of all called calculation jobs will be cleaned at the end of execution. handler_overridesfalse Dict, NoneTypeMapping where keys are process handler names and the values are a dictionary, where each dictionary can define the ``enabled`` and ``priority`` key, which can be used to toggle the values set on the original process handler declaration. kpointsfalse KpointsData, NoneTypeAn explicit k-points list or mesh. Either this or `kpoints_distance` has to be provided. kpoints_distancefalse Float, NoneTypeThe minimum desired distance in 1/Å between k-points in reciprocal space. The explicit k-points will be generated automatically by a calculation function based on the input structure. kpoints_force_parityfalse Bool, NoneTypeOptional input when constructing the k-points based on a desired `kpoints_distance`. Setting this to `True` will force the k-point mesh to have an even number of points along each lattice vector except for any non-periodic directions. max_iterationsfalse IntMaximum number of iterations the work chain will restart the process to finish successfully. metadatafalse on_unhandled_failurefalse Str, NoneTypeAction to take when an unhandled failure occurs. Options: "abort" (default, fail immediately), "pause" (pause the workchain for inspection), "restart_once" (restart once then abort), "restart_and_pause" (restart once then pause if still failing). pause_on_max_iterationsfalse Bool, NoneTypeIf True, pause the workchain for inspection when max_iterations is reached (either globally or for a specific handler) instead of aborting. When resumed, iteration counters are reset to zero. Output Required Valid types Description output_meptrue ArrayDataThe original and interpolated energy profiles along the minimum-energy path (mep) output_parameterstrue DictThe output parameters dictionary of the NEB calculation output_trajectorytrue TrajectoryDataremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. iteration_arrayfalse ArrayDataremote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 202 Neither the `kpoints` nor the `kpoints_distance` input was specified. 300 The calculation failed with an unidentified unrecoverable error. 301 The sub process excepted. 302 The sub process was killed. 310 The calculation failed with a known unrecoverable error. 401 The maximum number of iterations was exceeded. 402 The process failed with an unhandled failure. -
quantumespresso.pdos
class:aiida_quantumespresso.workflows.pdos:PdosWorkChainA WorkChain to compute Total & Partial Density of States of a structure, using Quantum Espresso.
Input Required Valid types Description dostrue DataInput parameters for the `dos.x` calculation. Note that the `emin`, `emax` and `deltae` values have to match with those in the `projwfc` inputs. nscftrue DataInputs for the `PwBaseWorkChain` of the `nscf` calculation. projwfctrue DataInput parameters for the `projwfc.x` calculation. Note that the `emin`, `emax` and `deltae` values have to match with those in the `dos` inputs. structuretrue StructureDataThe input structure. clean_workdirfalse BoolIf ``True``, work directories of all called calculation will be cleaned at the end of execution. dry_runfalse Bool, NoneTypeTerminate workchain steps before submitting calculations (test purposes only). energy_range_vs_fermifalse List, NoneTypeEnergy range with respect to the Fermi level that should be covered in DOS and PROJWFC calculation.If not specified but emin and emax are specified in the input parameters, these values will be used.Otherwise, the default values are extracted from the NSCF calculation. metadatafalse nbands_factorfalse Float, NoneTypeThe number of bands for the NSCF calculation is that used for the SCF multiplied by this factor. scffalse DataInputs for the `PwBaseWorkChain` of the `scf` calculation. serial_cleanfalse Bool, NoneTypeIf ``True``, calculations will be run in serial, and work directories will be cleaned before the next step. Output Required Valid types Description dostrue nscftrue projwfctrue Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 202 Neither the `kpoints` nor the `kpoints_distance` input was specified for base or nscf namespaces. 401 the SCF sub process failed 402 the NSCF sub process failed 403 the DOS sub process failed 404 the PROJWFC sub process failed 404 both the DOS and PROJWFC sub process failed 405 Cannot specify both `nbands_factor` and `nscf.pw.parameters.SYSTEM.nbnd`. -
quantumespresso.ph.base
class:aiida_quantumespresso.workflows.ph.base:PhBaseWorkChainWorkchain to run a Quantum ESPRESSO ph.x calculation with automated error handling and restarts.
Input Required Valid types Description phtrue Dataclean_workdirfalse BoolIf `True`, work directories of all called calculation jobs will be cleaned at the end of execution. handler_overridesfalse Dict, NoneTypeMapping where keys are process handler names and the values are a dictionary, where each dictionary can define the ``enabled`` and ``priority`` key, which can be used to toggle the values set on the original process handler declaration. max_iterationsfalse IntMaximum number of iterations the work chain will restart the process to finish successfully. metadatafalse on_unhandled_failurefalse Str, NoneTypeAction to take when an unhandled failure occurs. Options: "abort" (default, fail immediately), "pause" (pause the workchain for inspection), "restart_once" (restart once then abort), "restart_and_pause" (restart once then pause if still failing). only_initializationfalse Boolpause_on_max_iterationsfalse Bool, NoneTypeIf True, pause the workchain for inspection when max_iterations is reached (either globally or for a specific handler) instead of aborting. When resumed, iteration counters are reset to zero. qpointsfalse KpointsData, NoneTypeAn explicit qpoints list or mesh. Either this or `qpoints_distance` should to be provided. qpoints_distancefalse Float, NoneTypeThe minimum desired distance in 1/Å between qpoints in reciprocal space. The explicit qpoints will be generated automatically by a calculation function based on the input structure. qpoints_force_parityfalse Bool, NoneTypeOptional input when constructing the qpoints based on a desired `qpoints_distance`. Setting this to `True` will force the qpoint mesh to have an even number of points along each lattice vector except for any non-periodic directions. Output Required Valid types Description output_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 204 The `metadata.options` did not specify both `resources.num_machines` and `max_wallclock_seconds`. This exit status has been deprecated as the check it corresponded to was incorrect. 300 The calculation failed with an unrecoverable error. 301 The sub process excepted. 302 The sub process was killed. 401 The maximum number of iterations was exceeded. 401 The work chain failed to merge the q-points data from multiple `PhCalculation`s because not all q-points were parsed. 402 The process failed with an unhandled failure. -
quantumespresso.pw.bands
class:aiida_quantumespresso.workflows.pw.bands:PwBandsWorkChainWorkchain to compute a band structure for a given structure using Quantum ESPRESSO pw.x. The logic for the computation of various parameters for the BANDS step is as follows: Number of bands: One can specify the number of bands to be used in the BANDS step either directly through the input parameters `bands.pw.parameters.SYSTEM.nbnd` or through `nbands_factor`. Note that specifying both is not allowed. When neither is specified nothing will be set by the work chain and the default of Quantum ESPRESSO will end up being used. If the `nbands_factor` is specified the maximum value of the following values will be used: * `nbnd` of the preceding SCF calculation * 0.5 * nelectrons * nbands_factor * 0.5 * nelectrons + 4 Kpoints: There are three options; specify either an existing `KpointsData` through `bands_kpoints`, or specify the `bands_kpoints_distance`, or specify neither. For the former those exact kpoints will be used for the BANDS step. In the two other cases, the structure will first be normalized using SeekPath and the path along high-symmetry k-points will be generated on that structure. The distance between kpoints for the path will be equal to that of `bands_kpoints_distance` or the SeekPath default if not specified.
Input Required Valid types Description bandstrue DataInputs for the `PwBaseWorkChain` for the BANDS calculation. scftrue DataInputs for the `PwBaseWorkChain` for the SCF calculation. structuretrue StructureDataThe inputs structure. bands_kpointsfalse KpointsData, NoneTypeExplicit kpoints to use for the BANDS calculation. Specify either this or `bands_kpoints_distance`. bands_kpoints_distancefalse Float, NoneTypeMinimum kpoints distance for the BANDS calculation. Specify either this or `bands_kpoints`. clean_workdirfalse BoolIf `True`, work directories of all called calculation will be cleaned at the end of execution. metadatafalse nbands_factorfalse Float, NoneTypeThe number of bands for the BANDS calculation is that used for the SCF multiplied by this factor. Output Required Valid types Description band_parameterstrue DictThe output parameters of the BANDS `PwBaseWorkChain`. band_structuretrue BandsDataThe computed band structure. scf_parameterstrue DictThe output parameters of the SCF `PwBaseWorkChain`. primitive_structurefalse StructureDataThe normalized and primitivized structure for which the bands are computed. seekpath_parametersfalse DictThe parameters used in the SeeKpath call to normalize the input or relaxed structure. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 201 Cannot specify both `nbands_factor` and `bands.pw.parameters.SYSTEM.nbnd`. 202 Cannot specify both `bands_kpoints` and `bands_kpoints_distance`. 401 [deprecated] The PwRelaxWorkChain sub process failed 402 The scf PwBasexWorkChain sub process failed 403 The bands PwBasexWorkChain sub process failed -
quantumespresso.pw.base
class:aiida_quantumespresso.workflows.pw.base:PwBaseWorkChainWorkchain to run a Quantum ESPRESSO pw.x calculation with automated error handling and restarts.
Input Required Valid types Description pwtrue Dataclean_workdirfalse BoolIf `True`, work directories of all called calculation jobs will be cleaned at the end of execution. handler_overridesfalse Dict, NoneTypeMapping where keys are process handler names and the values are a dictionary, where each dictionary can define the ``enabled`` and ``priority`` key, which can be used to toggle the values set on the original process handler declaration. kpointsfalse KpointsData, NoneTypeAn explicit k-points list or mesh. Either this or `kpoints_distance` has to be provided. kpoints_distancefalse Float, NoneTypeThe minimum desired distance in 1/Å between k-points in reciprocal space. The explicit k-points will be generated automatically by a calculation function based on the input structure. kpoints_force_parityfalse Bool, NoneTypeOptional input when constructing the k-points based on a desired `kpoints_distance`. Setting this to `True` will force the k-point mesh to have an even number of points along each lattice vector except for any non-periodic directions. max_iterationsfalse IntMaximum number of iterations the work chain will restart the process to finish successfully. metadatafalse on_unhandled_failurefalse Str, NoneTypeAction to take when an unhandled failure occurs. Options: "abort" (default, fail immediately), "pause" (pause the workchain for inspection), "restart_once" (restart once then abort), "restart_and_pause" (restart once then pause if still failing). pause_on_max_iterationsfalse Bool, NoneTypeIf True, pause the workchain for inspection when max_iterations is reached (either globally or for a specific handler) instead of aborting. When resumed, iteration counters are reset to zero. Output Required Valid types Description output_parameterstrue DictThe `output_parameters` output node of the successful calculation. remote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. output_atomic_occupationsfalse Dictoutput_bandfalse BandsDataThe `output_band` output node of the successful calculation if present. output_kpointsfalse KpointsDataoutput_structurefalse StructureDataThe `output_structure` output node of the successful calculation if present. output_trajectoryfalse TrajectoryDataremote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 201 The explicit `pseudos` or `pseudo_family` could not be used to get the necessary pseudos. 202 Neither the `kpoints` nor the `kpoints_distance` input was specified. 203 Neither the `options` nor `automatic_parallelization` input was specified. This exit status has been deprecated as the check it corresponded to was incorrect. 204 The `metadata.options` did not specify both `resources.num_machines` and `max_wallclock_seconds`. This exit status has been deprecated as the check it corresponded to was incorrect. 210 Required key for `automatic_parallelization` was not specified.This exit status has been deprecated as the automatic parallellization feature was removed. 211 Unrecognized keys were specified for `automatic_parallelization`.This exit status has been deprecated as the automatic parallellization feature was removed. 300 [deprecated] The calculation failed with an unidentified unrecoverable error. 301 The sub process excepted. 302 The sub process was killed. 310 The calculation failed with a known unrecoverable error. 320 The initialization calculation failed. 401 The maximum number of iterations was exceeded. 402 The process failed with an unhandled failure. 501 Then ionic minimization cycle converged but the thresholds are exceeded in the final SCF. 710 The electronic minimization cycle did not reach self-consistency, but `scf_must_converge` is `False` and/or `electron_maxstep` is 0. -
quantumespresso.pw.relax
class:aiida_quantumespresso.workflows.pw.relax:PwRelaxWorkChainWorkchain to relax a structure using Quantum ESPRESSO pw.x.
Input Required Valid types Description base_relaxtrue DataInputs for the `PwBaseWorkChain` for the main relax loop. structuretrue StructureDataThe inputs structure. base_init_relaxfalse DataInputs for the `PwBaseWorkChain` that runs an initial geometry optimization, typically with looserprecision settings to find a geometry that is already closer to the final one quickly. clean_workdirfalse BoolIf `True`, work directories of all called calculation will be cleaned at the end of execution. max_meta_convergence_iterationsfalse IntThe maximum number of variable cell relax iterations in the meta convergence cycle. meta_convergencefalse BoolIf `True` the workchain will perform a meta-convergence, checking for Pulay stresses and k-point mesh density after each relaxation. metadatafalse Output Required Valid types Description output_parameterstrue DictThe `output_parameters` output node of the successful calculation. remote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. output_atomic_occupationsfalse Dictoutput_bandfalse BandsDataThe `output_band` output node of the successful calculation if present. output_kpointsfalse KpointsDataoutput_structurefalse StructureDataThe successfully relaxed structure. output_trajectoryfalse TrajectoryDataremote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 The maximum number of meta convergence iterations was exceeded. 401 the relax `PwBaseWorkChain` sub process failed 402 the final scf PwBaseWorkChain sub process failed (deprecated since the final SCF has been removed) 403 the initial relaxation `PwBaseWorkChain` sub process failed -
quantumespresso.q2r.base
class:aiida_quantumespresso.workflows.q2r.base:Q2rBaseWorkChainWorkchain to run a Quantum ESPRESSO q2r.x calculation with automated error handling and restarts.
Input Required Valid types Description q2rtrue Dataclean_workdirfalse BoolIf `True`, work directories of all called calculation jobs will be cleaned at the end of execution. handler_overridesfalse Dict, NoneTypeMapping where keys are process handler names and the values are a dictionary, where each dictionary can define the ``enabled`` and ``priority`` key, which can be used to toggle the values set on the original process handler declaration. max_iterationsfalse IntMaximum number of iterations the work chain will restart the process to finish successfully. metadatafalse on_unhandled_failurefalse Str, NoneTypeAction to take when an unhandled failure occurs. Options: "abort" (default, fail immediately), "pause" (pause the workchain for inspection), "restart_once" (restart once then abort), "restart_and_pause" (restart once then pause if still failing). pause_on_max_iterationsfalse Bool, NoneTypeIf True, pause the workchain for inspection when max_iterations is reached (either globally or for a specific handler) instead of aborting. When resumed, iteration counters are reset to zero. Output Required Valid types Description force_constantstrue ForceConstantsDataoutput_parameterstrue Dictremote_foldertrue RemoteDataInput files necessary to run the process will be stored in this folder node. retrievedtrue FolderDataFiles that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`. remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 300 [deprecated] The calculation failed with an unrecoverable error. 301 The sub process excepted. 302 The sub process was killed. 401 The maximum number of iterations was exceeded. 402 The process failed with an unhandled failure.