aiida-gromacs
A plugin for using GROMACS with AiiDA for molecular dymanics simulations.
General information
Registry checks
Plugins provided
Entry points
-
gromacs.editconf
class:aiida_gromacs.calculations.editconf:EditconfCalculationAiiDA calculation plugin wrapping the 'gmx editconf' executable. AiiDA plugin wrapper for adding a simulation box to structure file.
Input Required Valid types Description grofiletrue SinglefileDataInput structure file. parameterstrue EditconfParametersCommand line parameters for gmx editconf. bf_filefalse SinglefileData, NoneTypeGeneric data file. 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. commandfalse Str, NoneTypeThe command used to execute the job. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. n_filefalse SinglefileData, NoneTypeIndex 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. Output Required Valid types Description grofiletrue SinglefileDataOutput file containing simulation box. 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`. stdouttrue SinglefileDatastdout mead_filefalse SinglefileDataCoordination file for MEAD 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} 300 Calculation did not produce all expected output files. -
gromacs.genericMD
class:aiida_gromacs.calculations.genericMD:GenericCalculationAiiDA calculation plugin wrapping an executable with user defined input and output files.
Input Required Valid types Description codetrue 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. commandfalse Str, NoneTypeThe command used to execute the job. input_filesfalse SinglefileDataDictionary of input files. metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. output_filesfalse List, NoneTypeList of output file names. 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. 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} 300 Calculation did not produce all expected output files. 301 Specified output file not produced by command. -
gromacs.genion
class:aiida_gromacs.calculations.genion:GenionCalculationAiiDA calculation plugin wrapping the 'gmx genion' executable. AiiDA plugin wrapper for converting PDB files to GRO files.
Input Required Valid types Description parameterstrue GenionParametersCommand line parameters for gmx genion topfiletrue SinglefileDataInput topology file. tprfiletrue SinglefileDataInput tpr file. 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. commandfalse Str, NoneTypeThe command used to execute the job. instructions_filefalse SinglefileData, NoneTypeInstructions for generating index file metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. n_filefalse SinglefileData, NoneTypeIndex 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. Output Required Valid types Description grofiletrue SinglefileDataOutput gro file with ions added. 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`. stdouttrue SinglefileDatastdout topfiletrue SinglefileDataOutput topology with ions added. 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} 300 Calculation did not produce all expected output files. -
gromacs.grompp
class:aiida_gromacs.calculations.grompp:GromppCalculationAiiDA calculation plugin wrapping the 'gmx grompp' executable. AiiDA plugin wrapper for converting PDB files to GRO files.
Input Required Valid types Description grofiletrue SinglefileDataInput structure mdpfiletrue SinglefileDatagrompp run file. parameterstrue GromppParametersCommand line parameters for gmx grompp topfiletrue SinglefileDataInput topology 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. commandfalse Str, NoneTypeThe command used to execute the job. e_filefalse SinglefileData, NoneTypeEnergy file itp_dirsfalse FolderDataForcefield descriptions itp_filesfalse SinglefileDataRestraint files metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. n_filefalse SinglefileData, NoneTypeIndex file qmi_filefalse SinglefileData, NoneTypeQM input file r_filefalse SinglefileData, NoneTypeStructure file rb_filefalse SinglefileData, NoneTypeStructure file ref_filefalse SinglefileData, NoneTypeFull precision trajectory 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. t_filefalse SinglefileData, NoneTypeFull precision trajectory file 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`. stdouttrue SinglefileDatastdout tprfiletrue SinglefileDataOutput gro file ready for adding ions. imd_filefalse SinglefileDataCoordinate file in Gromos-87 format po_filefalse SinglefileDatagrompp input file with MD parameters pp_filefalse SinglefileDataTopology file 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} 300 Calculation did not produce all expected output files. -
gromacs.make_ndx
class:aiida_gromacs.calculations.make_ndx:Make_ndxCalculationAiiDA calculation plugin wrapping the 'gmx make_ndx' executable. AiiDA plugin wrapper for converting PDB files to GRO files.
Input Required Valid types Description parameterstrue Make_ndxParametersCommand line parameters for gmx make_ndx 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. commandfalse Str, NoneTypeThe command used to execute the job. grofilefalse SinglefileData, NoneTypeStructure file: gro g96 pdb brk ent esp tpr instructions_filefalse SinglefileData, NoneTypeInstructions for generating index file metadatafalse monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. n_filefalse SinglefileData, NoneTypeIndex 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. Output Required Valid types Description n_file_outtrue SinglefileDataIndex file 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`. stdouttrue SinglefileDatastdout 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} 300 Calculation did not produce all expected output files. -
gromacs.mdrun
class:aiida_gromacs.calculations.mdrun:MdrunCalculationAiiDA calculation plugin wrapping the 'gmx mdrun' executable. AiiDA plugin wrapper for converting PDB files to GRO files.
Input Required Valid types Description parameterstrue MdrunParametersCommand line parameters for gmx mdrun tprfiletrue SinglefileDataInput structure. awh_filefalse SinglefileData, NoneTypexvgr/xmgr file 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. commandfalse Str, NoneTypeThe command used to execute the job. cpi_filefalse SinglefileData, NoneTypeCheckpoint file ei_filefalse SinglefileData, NoneTypeED sampling input membed_filefalse SinglefileData, NoneTypeGeneric data file metadatafalse mn_filefalse SinglefileData, NoneTypeIndex file monitorsfalse DictAdd monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job. mp_filefalse SinglefileData, NoneTypeTopology file multidir_filefalse SinglefileData, NoneTypeRun directory plumed_dirsfalse FolderDatapath to directory where inputs referenced in plumed input file are plumed_filefalse SinglefileData, NoneTypePlumed file plumed_inpfilesfalse SinglefileDatainputs referenced in plumed input file plumed_outfilesfalse List, NoneTypeList of plumed output file names. 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. rerun_filefalse SinglefileData, NoneTypeTrajectory: xtc trr cpt gro g96 pdb tng table_filefalse SinglefileData, NoneTypexvgr/xmgr file tableb_filefalse SinglefileData, NoneTypexvgr/xmgr file tablep_filefalse SinglefileData, NoneTypexvgr/xmgr file Output Required Valid types Description enfiletrue SinglefileDataOutput energy file. grofiletrue SinglefileDataOutput structure file. logfiletrue SinglefileDataOutput log file. logfile_metadatatrue Dictmetadata extracted from gromacs logfile 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`. stdouttrue SinglefileDatastdout trrfiletrue SinglefileDataOutput trajectory. cpo_filefalse SinglefileDataCheckpoint file. dhdl_filefalse SinglefileDataxvgr/xmgr file eo_filefalse SinglefileDataxvgr/xmgr file field_filefalse SinglefileDataxvgr/xmgr file if_filefalse SinglefileDataxvgr/xmgr file mtx_filefalse SinglefileDataHessian Matrix pf_filefalse SinglefileDataxvgr/xmgr file px_filefalse SinglefileDataxvgr/xmgr file ra_filefalse SinglefileDataLog file remote_stashfalse RemoteStashDataContents of the `stash.source_list` option are stored in this remote folder after job completion. ro_filefalse SinglefileDataxvgr/xmgr file rs_filefalse SinglefileDataLog file rt_filefalse SinglefileDataLog file swap_filefalse SinglefileDataxvgr/xmgr file tpi_filefalse SinglefileDataxvgr/xmgr file tpid_filefalse SinglefileDataxvgr/xmgr file x_filefalse SinglefileDataCompressed trajectory (tng format or portable xdr format) 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} 300 Calculation did not produce all expected output files. -
gromacs.pdb2gmx
class:aiida_gromacs.calculations.pdb2gmx:Pdb2gmxCalculationAiiDA calculation plugin wrapping the 'gmx pdb2gmx' executable. AiiDA plugin wrapper for converting PDB files to GRO files.
Input Required Valid types Description parameterstrue Pdb2gmxParametersCommand line parameters for gmx pdb2gmx pdbfiletrue SinglefileDataInput 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. commandfalse Str, NoneTypeThe command used to execute the job. 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. Output Required Valid types Description grofiletrue SinglefileDataOutput forcefield compliant file. itpfiletrue SinglefileDataOutput forcefield compliant file. 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`. stdouttrue SinglefileDatastdout topfiletrue SinglefileDataOutput forcefield compliant file. n_filefalse SinglefileDataOutput index file q_filefalse SinglefileDataOutput Structure file 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} 300 Calculation did not produce all expected output files. -
gromacs.solvate
class:aiida_gromacs.calculations.solvate:SolvateCalculationAiiDA calculation plugin wrapping the 'gmx solvate' executable. AiiDA plugin wrapper for solvating a molecular system.
Input Required Valid types Description grofiletrue SinglefileDataInput structure parameterstrue SolvateParametersCommand line parameters for gmx solvate. topfiletrue SinglefileDataInput topology 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. commandfalse Str, NoneTypeThe command used to execute the job. 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. Output Required Valid types Description grofiletrue SinglefileDataOutput solvated gro file. 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`. stdouttrue SinglefileDatastdout topfiletrue SinglefileDataOutput topology file. 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} 300 Calculation did not produce all expected output files.
-
gromacs.provenance
aiida_gromacs.commands.provenance:provenance
-
gromacs.editconf
aiida_gromacs.data.editconf:EditconfParameters -
gromacs.genion
aiida_gromacs.data.genion:GenionParameters -
gromacs.grompp
aiida_gromacs.data.grompp:GromppParameters -
gromacs.make_ndx
aiida_gromacs.data.make_ndx:Make_ndxParameters -
gromacs.mdrun
aiida_gromacs.data.mdrun:MdrunParameters -
gromacs.pdb2gmx
aiida_gromacs.data.pdb2gmx:Pdb2gmxParameters -
gromacs.plumed_input
aiida_gromacs.data.plumed_input:PlumedInputData -
gromacs.solvate
aiida_gromacs.data.solvate:SolvateParameters
-
gromacs.editconf
aiida_gromacs.parsers.editconf:EditconfParser -
gromacs.genericMD
aiida_gromacs.parsers.genericMD:GenericParser -
gromacs.genion
aiida_gromacs.parsers.genion:GenionParser -
gromacs.grompp
aiida_gromacs.parsers.grompp:GromppParser -
gromacs.make_ndx
aiida_gromacs.parsers.make_ndx:Make_ndxParser -
gromacs.mdrun
aiida_gromacs.parsers.mdrun:MdrunParser -
gromacs.pdb2gmx
aiida_gromacs.parsers.pdb2gmx:Pdb2gmxParser -
gromacs.solvate
aiida_gromacs.parsers.solvate:SolvateParser
-
gromacs.setup
class:aiida_gromacs.workflows.simsetup:SetupWorkChainWorkChain for setting up a gromacs simulation automatically.
Input Required Valid types Description editconfparameterstrue EditconfParametersCommand line parameters for gmx editconf genionparameterstrue GenionParametersCommand line parameters for gmx genion gromppionsparameterstrue GromppParametersCommand line parameters for gmx grompp gromppminparameterstrue GromppParametersCommand line parameters for gmx grompp minimisation run gromppnptparameterstrue GromppParametersCommand line parameters for gmx grompp npt equilibration run gromppnvtparameterstrue GromppParametersCommand line parameters for gmx grompp nvt equilibration run gromppprodparameterstrue GromppParametersCommand line parameters for gmx grompp production run ionsmdptrue SinglefileDataMD parameters for adding ions. local_codetrue Codemdrunparameterstrue MdrunParametersCommand line parameters for gmx mdrun production run minimiseparameterstrue MdrunParametersCommand line parameters for gmx mdrun minimisation run minmdptrue SinglefileDataMD parameters for minimisation. nptmdptrue SinglefileDataMD parameters for NPT equilibration. nptparameterstrue MdrunParametersCommand line parameters for gmx mdrun npt equilibration run nvtmdptrue SinglefileDataMD parameters for NVT equilibration. nvtparameterstrue MdrunParametersCommand line parameters for gmx mdrun nvt equilibration run pdb2gmxparameterstrue Pdb2gmxParametersCommand line parameters for gmx pdb2gmx pdbfiletrue SinglefileDataInput structure. prodmdptrue SinglefileDataMD parameters for production run. solvateparameterstrue SolvateParametersCommand line parameters for gmx solvate metadatafalse remote_codefalse Code, NoneTypeOutput Required Valid types Description resulttrue 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.
-
createarchive
aiida_gromacs.cli.createarchive:cli -
genericMD
aiida_gromacs.cli.genericMD:cli -
gmx_editconf
aiida_gromacs.cli.editconf:cli -
gmx_genion
aiida_gromacs.cli.genion:cli -
gmx_grompp
aiida_gromacs.cli.grompp:cli -
gmx_make_ndx
aiida_gromacs.cli.make_ndx:cli -
gmx_mdrun
aiida_gromacs.cli.mdrun:cli -
gmx_pdb2gmx
aiida_gromacs.cli.pdb2gmx:cli -
gmx_solvate
aiida_gromacs.cli.solvate:cli