2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
36 * Registers command-line modules for pre-5.0 binaries.
38 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 #include "legacymodules.h"
44 #include "gromacs/commandline/cmdlinemodule.h"
45 #include "gromacs/commandline/cmdlinemodulemanager.h"
47 #include "gromacs/gmxana/gmx_ana.h"
49 #include "../view/view.h"
50 #include "../mdrun/mdrun_main.h"
55 int gmx_gmxcheck(int argc, char *argv[]);
56 int gmx_gmxdump(int argc, char *argv[]);
57 int gmx_grompp(int argc, char *argv[]);
58 int gmx_pdb2gmx(int argc, char *argv[]);
59 int gmx_protonate(int argc, char *argv[]);
60 int gmx_tpbconv(int argc, char *argv[]);
61 int gmx_x2top(int argc, char *argv[]);
69 * Command line module that provides information about obsolescence.
71 * Prints a message directing the user to a wiki page describing replacement
74 class ObsoleteToolModule : public gmx::CommandLineModuleInterface
77 //! Creates an obsolete tool module for a tool with the given name.
78 explicit ObsoleteToolModule(const char *name)
83 virtual const char *name() const
87 virtual const char *shortDescription() const
92 virtual int run(int /*argc*/, char * /*argv*/[])
97 virtual void writeHelp(const gmx::CommandLineHelpContext & /*context*/) const
103 void printMessage() const
106 "This tool has been removed from Gromacs 5.0. Please see\n"
107 " http://www.gromacs.org/Documentation/How-tos/Tool_Changes_for_5.0\n"
108 "for ideas how to perform the same tasks with the "
117 * Convenience function for creating and registering a module.
119 * \param[in] manager Module manager to which to register the module.
120 * \param[in] mainFunction Main function to wrap.
121 * \param[in] name Name for the new module.
122 * \param[in] shortDescription One-line description for the new module.
124 void registerModule(gmx::CommandLineModuleManager *manager,
125 gmx::CommandLineModuleManager::CMainFunction mainFunction,
126 const char *name, const char *shortDescription)
128 manager->addModuleCMain(name, shortDescription, mainFunction);
132 * Convenience function for registering a module for an obsolete tool.
134 * \param[in] manager Module manager to which to register the module.
135 * \param[in] name Name for the obsolete tool.
137 void registerObsoleteTool(gmx::CommandLineModuleManager *manager,
140 gmx::CommandLineModulePointer module(new ObsoleteToolModule(name));
141 manager->addModule(move(module));
146 void registerLegacyModules(gmx::CommandLineModuleManager *manager)
148 // Modules from this directory (were in src/kernel/).
149 registerModule(manager, &gmx_gmxcheck, "check",
150 "Check and compare files");
151 registerModule(manager, &gmx_gmxdump, "dump",
152 "Make binary files human readable");
153 registerModule(manager, &gmx_grompp, "grompp",
154 "Make a run input file");
155 registerModule(manager, &gmx_pdb2gmx, "pdb2gmx",
156 "Convert coordinate files to topology and FF-compliant coordinate files");
157 registerModule(manager, &gmx_tpbconv, "tpbconv",
158 "Make a run input file for restarting a crashed run");
160 registerModule(manager, &gmx_protonate, "protonate",
161 "Protonate structures");
162 registerModule(manager, &gmx_x2top, "x2top",
163 "Generate a primitive topology from coordinates");
165 registerModule(manager, &gmx_mdrun, "mdrun",
166 "Perform a simulation, do a normal mode analysis or an energy minimization");
168 // Modules from gmx_ana.h.
169 registerModule(manager, &gmx_do_dssp, "do_dssp",
170 "Assign secondary structure and calculate solvent accessible surface area");
171 registerModule(manager, &gmx_editconf, "editconf",
172 "Convert and manipulates structure files");
173 registerModule(manager, &gmx_eneconv, "eneconv",
174 "Convert energy files");
175 registerModule(manager, &gmx_genbox, "genbox",
177 registerModule(manager, &gmx_genconf, "genconf",
178 "Multiply a conformation in 'random' orientations");
179 registerModule(manager, &gmx_genion, "genion",
180 "Generate monoatomic ions on energetically favorable positions");
181 registerModule(manager, &gmx_genpr, "genrestr",
182 "Generate position restraints or distance restraints for index groups");
183 registerModule(manager, &gmx_make_edi, "make_edi",
184 "Generate input files for essential dynamics sampling");
185 registerModule(manager, &gmx_make_ndx, "make_ndx",
187 registerModule(manager, &gmx_mk_angndx, "mk_angndx",
188 "Generate index files for 'gmx angle'");
189 registerModule(manager, &gmx_trjcat, "trjcat",
190 "Concatenate trajectory files");
191 registerModule(manager, &gmx_trjconv, "trjconv",
192 "Convert and manipulates trajectory files");
193 registerModule(manager, &gmx_trjorder, "trjorder",
194 "Order molecules according to their distance to a group");
195 registerModule(manager, &gmx_xpm2ps, "xpm2ps",
196 "Convert XPM (XPixelMap) matrices to postscript or XPM");
198 registerModule(manager, &gmx_anadock, "anadock",
199 "Cluster structures from Autodock runs");
200 registerModule(manager, &gmx_anaeig, "anaeig",
201 "Analyze eigenvectors/normal modes");
202 registerModule(manager, &gmx_analyze, "analyze",
203 "Analyze data sets");
204 registerModule(manager, &gmx_g_angle, "angle",
205 "Calculate distributions and correlations for angles and dihedrals");
206 registerModule(manager, &gmx_bar, "bar",
207 "Calculate free energy difference estimates through Bennett's acceptance ratio");
208 registerObsoleteTool(manager, "bond");
209 registerObsoleteTool(manager, "dist");
210 registerObsoleteTool(manager, "sgangle");
212 registerModule(manager, &gmx_bundle, "bundle",
213 "Analyze bundles of axes, e.g., helices");
214 registerModule(manager, &gmx_chi, "chi",
215 "Calculate everything you want to know about chi and other dihedrals");
216 registerModule(manager, &gmx_cluster, "cluster",
217 "Cluster structures");
218 registerModule(manager, &gmx_clustsize, "clustsize",
219 "Calculate size distributions of atomic clusters");
220 registerModule(manager, &gmx_confrms, "confrms",
221 "Fit two structures and calculates the RMSD");
222 registerModule(manager, &gmx_covar, "covar",
223 "Calculate and diagonalize the covariance matrix");
224 registerModule(manager, &gmx_current, "current",
225 "Calculate dielectric constants and current autocorrelation function");
226 registerModule(manager, &gmx_density, "density",
227 "Calculate the density of the system");
228 registerModule(manager, &gmx_densmap, "densmap",
229 "Calculate 2D planar or axial-radial density maps");
230 registerModule(manager, &gmx_densorder, "densorder",
231 "Calculate surface fluctuations");
232 registerModule(manager, &gmx_dielectric, "dielectric",
233 "Calculate frequency dependent dielectric constants");
234 registerModule(manager, &gmx_dipoles, "dipoles",
235 "Compute the total dipole plus fluctuations");
236 registerModule(manager, &gmx_disre, "disre",
237 "Analyze distance restraints");
238 registerModule(manager, &gmx_dos, "dos",
239 "Analyze density of states and properties based on that");
240 registerModule(manager, &gmx_dyecoupl, "dyecoupl",
241 "Extract dye dynamics from trajectories");
242 registerModule(manager, &gmx_dyndom, "dyndom",
243 "Interpolate and extrapolate structure rotations");
244 registerModule(manager, &gmx_enemat, "enemat",
245 "Extract an energy matrix from an energy file");
246 registerModule(manager, &gmx_energy, "energy",
247 "Writes energies to xvg files and display averages");
248 registerModule(manager, &gmx_filter, "filter",
249 "Frequency filter trajectories, useful for making smooth movies");
250 registerModule(manager, &gmx_gyrate, "gyrate",
251 "Calculate the radius of gyration");
252 registerModule(manager, &gmx_h2order, "h2order",
253 "Compute the orientation of water molecules");
254 registerModule(manager, &gmx_hbond, "hbond",
255 "Compute and analyze hydrogen bonds");
256 registerModule(manager, &gmx_helix, "helix",
257 "Calculate basic properties of alpha helices");
258 registerModule(manager, &gmx_helixorient, "helixorient",
259 "Calculate local pitch/bending/rotation/orientation inside helices");
260 registerModule(manager, &gmx_hydorder, "hydorder",
261 "Compute tetrahedrality parameters around a given atom");
262 registerModule(manager, &gmx_kinetics, "kinetics",
263 "Analyze kinetic constants from properties based on the Eyring model");
264 registerModule(manager, &gmx_lie, "lie",
265 "Estimate free energy from linear combinations");
266 registerModule(manager, &gmx_mdmat, "mdmat",
267 "Calculate residue contact maps");
268 registerModule(manager, &gmx_mindist, "mindist",
269 "Calculate the minimum distance between two groups");
270 registerModule(manager, &gmx_morph, "morph",
271 "Interpolate linearly between conformations");
272 registerModule(manager, &gmx_msd, "msd",
273 "Calculates mean square displacements");
274 registerModule(manager, &gmx_nmeig, "nmeig",
275 "Diagonalize the Hessian for normal mode analysis");
276 registerModule(manager, &gmx_nmens, "nmens",
277 "Generate an ensemble of structures from the normal modes");
278 registerModule(manager, &gmx_nmtraj, "nmtraj",
279 "Generate a virtual oscillating trajectory from an eigenvector");
280 registerModule(manager, &gmx_options, "options", NULL);
281 registerModule(manager, &gmx_order, "order",
282 "Compute the order parameter per atom for carbon tails");
283 registerModule(manager, &gmx_pme_error, "pme_error",
284 "Estimate the error of using PME with a given input file");
285 registerModule(manager, &gmx_polystat, "polystat",
286 "Calculate static properties of polymers");
287 registerModule(manager, &gmx_potential, "potential",
288 "Calculate the electrostatic potential across the box");
289 registerModule(manager, &gmx_principal, "principal",
290 "Calculate principal axes of inertia for a group of atoms");
291 registerModule(manager, &gmx_rama, "rama",
292 "Compute Ramachandran plots");
293 registerModule(manager, &gmx_rdf, "rdf",
294 "Calculate radial distribution functions");
295 registerModule(manager, &gmx_rms, "rms",
296 "Calculate RMSDs with a reference structure and RMSD matrices");
297 registerModule(manager, &gmx_rmsdist, "rmsdist",
298 "Calculate atom pair distances averaged with power -2, -3 or -6");
299 registerModule(manager, &gmx_rmsf, "rmsf",
300 "Calculate atomic fluctuations");
301 registerModule(manager, &gmx_rotacf, "rotacf",
302 "Calculate the rotational correlation function for molecules");
303 registerModule(manager, &gmx_rotmat, "rotmat",
304 "Plot the rotation matrix for fitting to a reference structure");
305 registerModule(manager, &gmx_saltbr, "saltbr",
306 "Compute salt bridges");
307 registerModule(manager, &gmx_sans, "sans",
308 "Compute small angle neutron scattering spectra");
309 registerModule(manager, &gmx_sas, "sas",
310 "Compute solvent accessible surface area");
311 registerModule(manager, &gmx_saxs, "saxs",
312 "Compute small angle X-ray scattering spectra");
313 registerModule(manager, &gmx_sham, "sham",
314 "Compute free energies or other histograms from histograms");
315 registerModule(manager, &gmx_sigeps, "sigeps",
316 "Convert c6/12 or c6/cn combinations to and from sigma/epsilon");
317 registerModule(manager, &gmx_sorient, "sorient",
318 "Analyze solvent orientation around solutes");
319 registerModule(manager, &gmx_spatial, "spatial",
320 "Calculate the spatial distribution function");
321 registerModule(manager, &gmx_spol, "spol",
322 "Analyze solvent dipole orientation and polarization around solutes");
323 registerModule(manager, &gmx_tcaf, "tcaf",
324 "Calculate viscosities of liquids");
325 registerModule(manager, &gmx_traj, "traj",
326 "Plot x, v, f, box, temperature and rotational energy from trajectories");
327 registerModule(manager, &gmx_tune_pme, "tune_pme",
328 "Time mdrun as a function of PME nodes to optimize settings");
329 registerModule(manager, &gmx_vanhove, "vanhove",
330 "Compute Van Hove displacement and correlation functions");
331 registerModule(manager, &gmx_velacc, "velacc",
332 "Calculate velocity autocorrelation functions");
333 registerModule(manager, &gmx_wham, "wham",
334 "Perform weighted histogram analysis after umbrella sampling");
335 registerModule(manager, &gmx_wheel, "wheel",
336 "Plot helical wheels");
337 registerModule(manager, &gmx_view, "view",
338 "View a trajectory on an X-Windows terminal");
341 gmx::CommandLineModuleGroup group =
342 manager->addModuleGroup("Generating topologies and coordinates");
343 group.addModuleWithDescription("editconf", "Edit the box and write subgroups");
344 group.addModule("protonate");
345 group.addModule("x2top");
346 group.addModule("genbox");
347 group.addModule("genconf");
348 group.addModule("genion");
349 group.addModule("genrestr");
350 group.addModule("pdb2gmx");
353 gmx::CommandLineModuleGroup group =
354 manager->addModuleGroup("Running a simulation");
355 group.addModule("grompp");
356 group.addModule("mdrun");
357 group.addModule("tpbconv");
360 gmx::CommandLineModuleGroup group =
361 manager->addModuleGroup("Viewing trajectories");
362 group.addModule("nmtraj");
363 group.addModule("view");
366 gmx::CommandLineModuleGroup group =
367 manager->addModuleGroup("Processing energies");
368 group.addModule("enemat");
369 group.addModule("energy");
370 group.addModuleWithDescription("mdrun", "(Re)calculate energies for trajectory frames with -rerun");
373 gmx::CommandLineModuleGroup group =
374 manager->addModuleGroup("Converting files");
375 group.addModule("editconf");
376 group.addModule("eneconv");
377 group.addModule("sigeps");
378 group.addModule("trjcat");
379 group.addModule("trjconv");
380 group.addModule("xpm2ps");
383 gmx::CommandLineModuleGroup group =
384 manager->addModuleGroup("Tools");
385 group.addModule("analyze");
386 group.addModule("dyndom");
387 group.addModule("filter");
388 group.addModule("lie");
389 group.addModule("morph");
390 group.addModule("pme_error");
391 group.addModule("sham");
392 group.addModule("spatial");
393 group.addModule("traj");
394 group.addModule("tune_pme");
395 group.addModule("wham");
396 group.addModule("check");
397 group.addModule("dump");
398 group.addModule("make_ndx");
399 group.addModule("mk_angndx");
400 group.addModule("trjorder");
401 group.addModule("xpm2ps");
404 gmx::CommandLineModuleGroup group =
405 manager->addModuleGroup("Distances between structures");
406 group.addModule("cluster");
407 group.addModule("confrms");
408 group.addModule("rms");
409 group.addModule("rmsf");
412 gmx::CommandLineModuleGroup group =
413 manager->addModuleGroup("Distances in structures over time");
414 group.addModule("mindist");
415 group.addModule("mdmat");
416 group.addModule("polystat");
417 group.addModule("rmsdist");
420 gmx::CommandLineModuleGroup group =
421 manager->addModuleGroup("Mass distribution properties over time");
422 group.addModule("gyrate");
423 group.addModule("msd");
424 group.addModule("polystat");
425 group.addModule("rdf");
426 group.addModule("rotacf");
427 group.addModule("rotmat");
428 group.addModule("sans");
429 group.addModule("saxs");
430 group.addModule("traj");
431 group.addModule("vanhove");
434 gmx::CommandLineModuleGroup group =
435 manager->addModuleGroup("Analyzing bonded interactions");
436 group.addModule("angle");
437 group.addModule("mk_angndx");
440 gmx::CommandLineModuleGroup group =
441 manager->addModuleGroup("Structural properties");
442 group.addModule("anadock");
443 group.addModule("bundle");
444 group.addModule("clustsize");
445 group.addModule("disre");
446 group.addModule("hbond");
447 group.addModule("order");
448 group.addModule("principal");
449 group.addModule("rdf");
450 group.addModule("saltbr");
451 group.addModule("sas");
452 group.addModule("sorient");
453 group.addModule("spol");
456 gmx::CommandLineModuleGroup group =
457 manager->addModuleGroup("Kinetic properties");
458 group.addModule("bar");
459 group.addModule("current");
460 group.addModule("dos");
461 group.addModule("dyecoupl");
462 group.addModule("kinetics");
463 group.addModule("principal");
464 group.addModule("tcaf");
465 group.addModule("traj");
466 group.addModule("vanhove");
467 group.addModule("velacc");
470 gmx::CommandLineModuleGroup group =
471 manager->addModuleGroup("Electrostatic properties");
472 group.addModule("current");
473 group.addModule("dielectric");
474 group.addModule("dipoles");
475 group.addModule("potential");
476 group.addModule("spol");
477 group.addModule("genion");
480 gmx::CommandLineModuleGroup group =
481 manager->addModuleGroup("Protein-specific analysis");
482 group.addModule("do_dssp");
483 group.addModule("chi");
484 group.addModule("helix");
485 group.addModule("helixorient");
486 group.addModule("rama");
487 group.addModule("wheel");
490 gmx::CommandLineModuleGroup group =
491 manager->addModuleGroup("Interfaces");
492 group.addModule("bundle");
493 group.addModule("density");
494 group.addModule("densmap");
495 group.addModule("densorder");
496 group.addModule("h2order");
497 group.addModule("hydorder");
498 group.addModule("order");
499 group.addModule("potential");
502 gmx::CommandLineModuleGroup group =
503 manager->addModuleGroup("Covariance analysis");
504 group.addModuleWithDescription("anaeig", "Analyze the eigenvectors");
505 group.addModule("covar");
506 group.addModule("make_edi");
509 gmx::CommandLineModuleGroup group =
510 manager->addModuleGroup("Normal modes");
511 group.addModuleWithDescription("anaeig", "Analyze the normal modes");
512 group.addModule("nmeig");
513 group.addModule("nmtraj");
514 group.addModule("nmens");
515 group.addModule("grompp");
516 group.addModuleWithDescription("mdrun", "Find a potential energy minimum and calculate the Hessian");