2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2016,2017,2018,2019, 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>
42 #include "legacymodules.h"
46 #include "gromacs/commandline/cmdlinemodule.h"
47 #include "gromacs/commandline/cmdlinemodulemanager.h"
48 #include "gromacs/commandline/cmdlineoptionsmodule.h"
49 #include "gromacs/gmxana/gmx_ana.h"
50 #include "gromacs/gmxpreprocess/editconf.h"
51 #include "gromacs/gmxpreprocess/genconf.h"
52 #include "gromacs/gmxpreprocess/genion.h"
53 #include "gromacs/gmxpreprocess/genrestr.h"
54 #include "gromacs/gmxpreprocess/grompp.h"
55 #include "gromacs/gmxpreprocess/insert_molecules.h"
56 #include "gromacs/gmxpreprocess/pdb2gmx.h"
57 #include "gromacs/gmxpreprocess/solvate.h"
58 #include "gromacs/gmxpreprocess/x2top.h"
59 #include "gromacs/tools/check.h"
60 #include "gromacs/tools/convert_tpr.h"
61 #include "gromacs/tools/dump.h"
62 #include "gromacs/tools/report_methods.h"
64 #include "mdrun/mdrun_main.h"
65 #include "view/view.h"
71 * Command line module that provides information about obsolescence.
73 * Prints a message directing the user to a wiki page describing replacement
76 class ObsoleteToolModule : public gmx::ICommandLineModule
79 //! Creates an obsolete tool module for a tool with the given name.
80 explicit ObsoleteToolModule(const char *name)
85 const char *name() const override
89 const char *shortDescription() const override
94 void init(gmx::CommandLineModuleSettings * /*settings*/) override
97 int run(int /*argc*/, char * /*argv*/[]) override
102 void writeHelp(const gmx::CommandLineHelpContext & /*context*/) const override
108 void printMessage() const
111 "This tool is no longer present in GROMACS. Please see\n"
112 " http://jenkins.gromacs.org/job/Documentation_Nightly_master/javadoc/user-guide/cmdline.html#command-changes\n"
113 "for ideas how to perform the same tasks with the "
120 //! Initializer for a module that defaults to nice level zero.
121 void initSettingsNoNice(gmx::CommandLineModuleSettings *settings)
123 settings->setDefaultNiceLevel(0);
127 * Convenience function for creating and registering a module.
129 * \param[in] manager Module manager to which to register the module.
130 * \param[in] mainFunction Main function to wrap.
131 * \param[in] name Name for the new module.
132 * \param[in] shortDescription One-line description for the new module.
134 void registerModule(gmx::CommandLineModuleManager *manager,
135 gmx::CommandLineModuleManager::CMainFunction mainFunction,
136 const char *name, const char *shortDescription)
138 manager->addModuleCMain(name, shortDescription, mainFunction);
142 * Convenience function for creating and registering a module that defaults to
145 * \param[in] manager Module manager to which to register the module.
146 * \param[in] mainFunction Main function to wrap.
147 * \param[in] name Name for the new module.
148 * \param[in] shortDescription One-line description for the new module.
150 void registerModuleNoNice(gmx::CommandLineModuleManager *manager,
151 gmx::CommandLineModuleManager::CMainFunction mainFunction,
152 const char *name, const char *shortDescription)
154 manager->addModuleCMainWithSettings(name, shortDescription, mainFunction,
155 &initSettingsNoNice);
159 * Convenience function for registering a module for an obsolete tool.
161 * \param[in] manager Module manager to which to register the module.
162 * \param[in] name Name for the obsolete tool.
164 void registerObsoleteTool(gmx::CommandLineModuleManager *manager,
167 gmx::CommandLineModulePointer module(new ObsoleteToolModule(name));
168 manager->addModule(std::move(module));
173 void registerLegacyModules(gmx::CommandLineModuleManager *manager)
175 registerModule(manager, &gmx_check, "check",
176 "Check and compare files");
177 gmx::ICommandLineOptionsModule::registerModuleFactory(
178 manager, gmx::DumpInfo::name,
179 gmx::DumpInfo::shortDescription,
180 &gmx::DumpInfo::create);
181 registerModule(manager, &gmx_grompp, "grompp",
182 "Make a run input file");
183 registerModule(manager, &gmx_convert_tpr, "convert-tpr",
184 "Make a modifed run-input file");
185 registerObsoleteTool(manager, "tpbconv");
186 registerModule(manager, &gmx_x2top, "x2top",
187 "Generate a primitive topology from coordinates");
189 registerModuleNoNice(manager, &gmx::gmx_mdrun, "mdrun",
190 "Perform a simulation, do a normal mode analysis or an energy minimization");
192 gmx::ICommandLineOptionsModule::registerModuleFactory(
193 manager, gmx::InsertMoleculesInfo::name(),
194 gmx::InsertMoleculesInfo::shortDescription(),
195 &gmx::InsertMoleculesInfo::create);
197 gmx::ICommandLineOptionsModule::registerModuleFactory(
198 manager, gmx::ReportMethodsInfo::name,
199 gmx::ReportMethodsInfo::shortDescription,
200 &gmx::ReportMethodsInfo::create);
202 gmx::ICommandLineOptionsModule::registerModuleFactory(
203 manager, gmx::pdb2gmxInfo::name,
204 gmx::pdb2gmxInfo::shortDescription,
205 &gmx::pdb2gmxInfo::create);
207 // Modules from gmx_ana.h.
208 registerModule(manager, &gmx_do_dssp, "do_dssp",
209 "Assign secondary structure and calculate solvent accessible surface area");
210 registerModule(manager, &gmx_editconf, "editconf",
211 "Convert and manipulates structure files");
212 registerModule(manager, &gmx_eneconv, "eneconv",
213 "Convert energy files");
214 registerModule(manager, &gmx_solvate, "solvate",
216 registerObsoleteTool(manager, "genbox");
217 registerModule(manager, &gmx_genconf, "genconf",
218 "Multiply a conformation in 'random' orientations");
219 registerModule(manager, &gmx_genion, "genion",
220 "Generate monoatomic ions on energetically favorable positions");
221 registerModule(manager, &gmx_genrestr, "genrestr",
222 "Generate position restraints or distance restraints for index groups");
223 registerModule(manager, &gmx_make_edi, "make_edi",
224 "Generate input files for essential dynamics sampling");
225 registerModule(manager, &gmx_make_ndx, "make_ndx",
227 registerModule(manager, &gmx_mk_angndx, "mk_angndx",
228 "Generate index files for 'gmx angle'");
229 registerModule(manager, &gmx_trjcat, "trjcat",
230 "Concatenate trajectory files");
231 registerModule(manager, &gmx_trjconv, "trjconv",
232 "Convert and manipulates trajectory files");
233 registerModule(manager, &gmx_trjorder, "trjorder",
234 "Order molecules according to their distance to a group");
235 registerModule(manager, &gmx_xpm2ps, "xpm2ps",
236 "Convert XPM (XPixelMap) matrices to postscript or XPM");
238 registerModule(manager, &gmx_anaeig, "anaeig",
239 "Analyze eigenvectors/normal modes");
240 registerModule(manager, &gmx_analyze, "analyze",
241 "Analyze data sets");
242 registerModule(manager, &gmx_g_angle, "angle",
243 "Calculate distributions and correlations for angles and dihedrals");
244 registerModule(manager, &gmx_awh, "awh",
245 "Extract data from an accelerated weight histogram (AWH) run");
246 registerModule(manager, &gmx_bar, "bar",
247 "Calculate free energy difference estimates through Bennett's acceptance ratio");
248 registerObsoleteTool(manager, "bond");
249 registerObsoleteTool(manager, "dist");
250 registerObsoleteTool(manager, "sas");
251 registerObsoleteTool(manager, "sgangle");
253 registerModule(manager, &gmx_bundle, "bundle",
254 "Analyze bundles of axes, e.g., helices");
255 registerModule(manager, &gmx_chi, "chi",
256 "Calculate everything you want to know about chi and other dihedrals");
257 registerModule(manager, &gmx_cluster, "cluster",
258 "Cluster structures");
259 registerModule(manager, &gmx_clustsize, "clustsize",
260 "Calculate size distributions of atomic clusters");
261 registerModule(manager, &gmx_confrms, "confrms",
262 "Fit two structures and calculates the RMSD");
263 registerModule(manager, &gmx_covar, "covar",
264 "Calculate and diagonalize the covariance matrix");
265 registerModule(manager, &gmx_current, "current",
266 "Calculate dielectric constants and current autocorrelation function");
267 registerModule(manager, &gmx_density, "density",
268 "Calculate the density of the system");
269 registerModule(manager, &gmx_densmap, "densmap",
270 "Calculate 2D planar or axial-radial density maps");
271 registerModule(manager, &gmx_densorder, "densorder",
272 "Calculate surface fluctuations");
273 registerModule(manager, &gmx_dielectric, "dielectric",
274 "Calculate frequency dependent dielectric constants");
275 registerModule(manager, &gmx_dipoles, "dipoles",
276 "Compute the total dipole plus fluctuations");
277 registerModule(manager, &gmx_disre, "disre",
278 "Analyze distance restraints");
279 registerModule(manager, &gmx_dos, "dos",
280 "Analyze density of states and properties based on that");
281 registerModule(manager, &gmx_dyecoupl, "dyecoupl",
282 "Extract dye dynamics from trajectories");
283 registerModule(manager, &gmx_enemat, "enemat",
284 "Extract an energy matrix from an energy file");
285 registerModule(manager, &gmx_energy, "energy",
286 "Writes energies to xvg files and display averages");
287 registerModule(manager, &gmx_filter, "filter",
288 "Frequency filter trajectories, useful for making smooth movies");
289 registerModule(manager, &gmx_gyrate, "gyrate",
290 "Calculate the radius of gyration");
291 registerModule(manager, &gmx_h2order, "h2order",
292 "Compute the orientation of water molecules");
293 registerModule(manager, &gmx_hbond, "hbond",
294 "Compute and analyze hydrogen bonds");
295 registerModule(manager, &gmx_helix, "helix",
296 "Calculate basic properties of alpha helices");
297 registerModule(manager, &gmx_helixorient, "helixorient",
298 "Calculate local pitch/bending/rotation/orientation inside helices");
299 registerModule(manager, &gmx_hydorder, "hydorder",
300 "Compute tetrahedrality parameters around a given atom");
301 registerModule(manager, &gmx_lie, "lie",
302 "Estimate free energy from linear combinations");
303 registerModule(manager, &gmx_mdmat, "mdmat",
304 "Calculate residue contact maps");
305 registerModule(manager, &gmx_mindist, "mindist",
306 "Calculate the minimum distance between two groups");
307 registerModule(manager, &gmx_msd, "msd",
308 "Calculates mean square displacements");
309 registerModule(manager, &gmx_nmeig, "nmeig",
310 "Diagonalize the Hessian for normal mode analysis");
311 registerModule(manager, &gmx_nmens, "nmens",
312 "Generate an ensemble of structures from the normal modes");
313 registerModule(manager, &gmx_nmr, "nmr",
314 "Analyze nuclear magnetic resonance properties from an energy file");
315 registerModule(manager, &gmx_nmtraj, "nmtraj",
316 "Generate a virtual oscillating trajectory from an eigenvector");
317 registerModule(manager, &gmx_order, "order",
318 "Compute the order parameter per atom for carbon tails");
319 registerModule(manager, &gmx_pme_error, "pme_error",
320 "Estimate the error of using PME with a given input file");
321 registerModule(manager, &gmx_polystat, "polystat",
322 "Calculate static properties of polymers");
323 registerModule(manager, &gmx_potential, "potential",
324 "Calculate the electrostatic potential across the box");
325 registerModule(manager, &gmx_principal, "principal",
326 "Calculate principal axes of inertia for a group of atoms");
327 registerModule(manager, &gmx_rama, "rama",
328 "Compute Ramachandran plots");
329 registerModule(manager, &gmx_rms, "rms",
330 "Calculate RMSDs with a reference structure and RMSD matrices");
331 registerModule(manager, &gmx_rmsdist, "rmsdist",
332 "Calculate atom pair distances averaged with power -2, -3 or -6");
333 registerModule(manager, &gmx_rmsf, "rmsf",
334 "Calculate atomic fluctuations");
335 registerModule(manager, &gmx_rotacf, "rotacf",
336 "Calculate the rotational correlation function for molecules");
337 registerModule(manager, &gmx_rotmat, "rotmat",
338 "Plot the rotation matrix for fitting to a reference structure");
339 registerModule(manager, &gmx_saltbr, "saltbr",
340 "Compute salt bridges");
341 registerModule(manager, &gmx_sans, "sans",
342 "Compute small angle neutron scattering spectra");
343 registerModule(manager, &gmx_saxs, "saxs",
344 "Compute small angle X-ray scattering spectra");
345 registerModule(manager, &gmx_sham, "sham",
346 "Compute free energies or other histograms from histograms");
347 registerModule(manager, &gmx_sigeps, "sigeps",
348 "Convert c6/12 or c6/cn combinations to and from sigma/epsilon");
349 registerModule(manager, &gmx_sorient, "sorient",
350 "Analyze solvent orientation around solutes");
351 registerModule(manager, &gmx_spatial, "spatial",
352 "Calculate the spatial distribution function");
353 registerModule(manager, &gmx_spol, "spol",
354 "Analyze solvent dipole orientation and polarization around solutes");
355 registerModule(manager, &gmx_tcaf, "tcaf",
356 "Calculate viscosities of liquids");
357 registerModule(manager, &gmx_traj, "traj",
358 "Plot x, v, f, box, temperature and rotational energy from trajectories");
359 registerModule(manager, &gmx_tune_pme, "tune_pme",
360 "Time mdrun as a function of PME ranks to optimize settings");
361 registerModule(manager, &gmx_vanhove, "vanhove",
362 "Compute Van Hove displacement and correlation functions");
363 registerModule(manager, &gmx_velacc, "velacc",
364 "Calculate velocity autocorrelation functions");
365 registerModule(manager, &gmx_wham, "wham",
366 "Perform weighted histogram analysis after umbrella sampling");
367 registerModule(manager, &gmx_wheel, "wheel",
368 "Plot helical wheels");
369 registerModuleNoNice(manager, &gmx_view, "view",
370 "View a trajectory on an X-Windows terminal");
373 gmx::CommandLineModuleGroup group =
374 manager->addModuleGroup("Generating topologies and coordinates");
375 group.addModuleWithDescription("editconf", "Edit the box and write subgroups");
376 group.addModule("x2top");
377 group.addModule("solvate");
378 group.addModule("insert-molecules");
379 group.addModule("genconf");
380 group.addModule("genion");
381 group.addModule("genrestr");
382 group.addModule("pdb2gmx");
385 gmx::CommandLineModuleGroup group =
386 manager->addModuleGroup("Running a simulation");
387 group.addModule("grompp");
388 group.addModule("mdrun");
389 group.addModule("convert-tpr");
392 gmx::CommandLineModuleGroup group =
393 manager->addModuleGroup("Viewing trajectories");
394 group.addModule("nmtraj");
395 group.addModule("view");
398 gmx::CommandLineModuleGroup group =
399 manager->addModuleGroup("Processing energies");
400 group.addModule("enemat");
401 group.addModule("energy");
402 group.addModuleWithDescription("mdrun", "(Re)calculate energies for trajectory frames with -rerun");
405 gmx::CommandLineModuleGroup group =
406 manager->addModuleGroup("Converting files");
407 group.addModule("editconf");
408 group.addModule("eneconv");
409 group.addModule("sigeps");
410 group.addModule("trjcat");
411 group.addModule("trjconv");
412 group.addModule("xpm2ps");
415 gmx::CommandLineModuleGroup group =
416 manager->addModuleGroup("Tools");
417 group.addModule("analyze");
418 group.addModule("awh");
419 group.addModule("filter");
420 group.addModule("lie");
421 group.addModule("pme_error");
422 group.addModule("sham");
423 group.addModule("spatial");
424 group.addModule("traj");
425 group.addModule("tune_pme");
426 group.addModule("wham");
427 group.addModule("check");
428 group.addModule("dump");
429 group.addModule("make_ndx");
430 group.addModule("mk_angndx");
431 group.addModule("trjorder");
432 group.addModule("xpm2ps");
433 group.addModule("report-methods");
436 gmx::CommandLineModuleGroup group =
437 manager->addModuleGroup("Distances between structures");
438 group.addModule("cluster");
439 group.addModule("confrms");
440 group.addModule("rms");
441 group.addModule("rmsf");
444 gmx::CommandLineModuleGroup group =
445 manager->addModuleGroup("Distances in structures over time");
446 group.addModule("mindist");
447 group.addModule("mdmat");
448 group.addModule("polystat");
449 group.addModule("rmsdist");
452 gmx::CommandLineModuleGroup group =
453 manager->addModuleGroup("Mass distribution properties over time");
454 group.addModule("gyrate");
455 group.addModule("msd");
456 group.addModule("polystat");
457 group.addModule("rdf");
458 group.addModule("rotacf");
459 group.addModule("rotmat");
460 group.addModule("sans");
461 group.addModule("saxs");
462 group.addModule("traj");
463 group.addModule("vanhove");
466 gmx::CommandLineModuleGroup group =
467 manager->addModuleGroup("Analyzing bonded interactions");
468 group.addModule("angle");
469 group.addModule("mk_angndx");
472 gmx::CommandLineModuleGroup group =
473 manager->addModuleGroup("Structural properties");
474 group.addModule("bundle");
475 group.addModule("clustsize");
476 group.addModule("disre");
477 group.addModule("hbond");
478 group.addModule("order");
479 group.addModule("principal");
480 group.addModule("rdf");
481 group.addModule("saltbr");
482 group.addModule("sorient");
483 group.addModule("spol");
486 gmx::CommandLineModuleGroup group =
487 manager->addModuleGroup("Kinetic properties");
488 group.addModule("bar");
489 group.addModule("current");
490 group.addModule("dos");
491 group.addModule("dyecoupl");
492 group.addModule("principal");
493 group.addModule("tcaf");
494 group.addModule("traj");
495 group.addModule("vanhove");
496 group.addModule("velacc");
499 gmx::CommandLineModuleGroup group =
500 manager->addModuleGroup("Electrostatic properties");
501 group.addModule("current");
502 group.addModule("dielectric");
503 group.addModule("dipoles");
504 group.addModule("potential");
505 group.addModule("spol");
506 group.addModule("genion");
509 gmx::CommandLineModuleGroup group =
510 manager->addModuleGroup("Protein-specific analysis");
511 group.addModule("do_dssp");
512 group.addModule("chi");
513 group.addModule("helix");
514 group.addModule("helixorient");
515 group.addModule("rama");
516 group.addModule("wheel");
519 gmx::CommandLineModuleGroup group =
520 manager->addModuleGroup("Interfaces");
521 group.addModule("bundle");
522 group.addModule("density");
523 group.addModule("densmap");
524 group.addModule("densorder");
525 group.addModule("h2order");
526 group.addModule("hydorder");
527 group.addModule("order");
528 group.addModule("potential");
531 gmx::CommandLineModuleGroup group =
532 manager->addModuleGroup("Covariance analysis");
533 group.addModuleWithDescription("anaeig", "Analyze the eigenvectors");
534 group.addModule("covar");
535 group.addModule("make_edi");
538 gmx::CommandLineModuleGroup group =
539 manager->addModuleGroup("Normal modes");
540 group.addModuleWithDescription("anaeig", "Analyze the normal modes");
541 group.addModule("nmeig");
542 group.addModule("nmtraj");
543 group.addModule("nmens");
544 group.addModule("grompp");
545 group.addModuleWithDescription("mdrun", "Find a potential energy minimum and calculate the Hessian");