python_packaging/src/test/test_mdrun.py

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2019,2020, 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.
   8 #
   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.
  13 #
  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.
  18 #
  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.
  23 #
  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.
  31 #
  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.
  34
  35 """Test gromacs.mdrun operation.
  36
  37 Factory produces deferred execution operation.
  38
  39 TODO: Factory expects input for conformation, topology, simulation parameters, simulation state.
  40
  41 TODO: Factory accepts additional keyword input to indicate binding
  42  to the "potential" interface.
  43 """
  44
  45 import logging
  46 import os
  47 import pytest
  48
  49 import gmxapi as gmx
  50
  51
  52 # Configure the `logging` module before proceeding any further.
  53 gmx.logger.setLevel(logging.WARNING)
  54
  55 try:
  56     from mpi4py import MPI
  57     rank_number = MPI.COMM_WORLD.Get_rank()
  58 except ImportError:
  59     rank_number = 0
  60     rank_tag = ''
  61     MPI = None
  62 else:
  63     rank_tag = 'rank{}:'.format(rank_number)
  64
  65 # Use this formatter to improve the caplog log records.
  66 formatter = logging.Formatter(rank_tag + '%(name)s:%(levelname)s: %(message)s')
  67
  68 # For additional console logging, create and attach a stream handler.
  69 # For example:
  70 #    ch = logging.StreamHandler()
  71 #    ch.setFormatter(formatter)
  72 #    logging.getLogger().addHandler(ch)
  73
  74
  75 @pytest.mark.usefixtures('cleandir')
  76 def test_run_from_tpr(spc_water_box, mdrun_kwargs):
  77     assert os.path.exists(spc_water_box)
  78
  79     md = gmx.mdrun(spc_water_box)
  80     md.run()
  81     # TODO: better handling of output on unused MPI ranks.
  82
  83
  84 @pytest.mark.withmpi_only
  85 @pytest.mark.usefixtures('cleandir')
  86 def test_run_trivial_ensemble(spc_water_box, caplog, mdrun_kwargs):
  87     from mpi4py import MPI
  88     current_rank = MPI.COMM_WORLD.Get_rank()
  89     with caplog.at_level(logging.DEBUG):
  90         caplog.handler.setFormatter(formatter)
  91         with caplog.at_level(logging.WARNING, 'gmxapi'), \
  92                 caplog.at_level(logging.DEBUG, 'gmxapi.mdrun'), \
  93                 caplog.at_level(logging.DEBUG, 'gmxapi.modify_input'), \
  94                 caplog.at_level(logging.DEBUG, 'gmxapi.read_tpr'), \
  95                 caplog.at_level(logging.DEBUG, 'gmxapi.simulation'):
  96
  97             tpr_filename = spc_water_box
  98             ensemble_width = 2
  99             simulation_input = gmx.read_tpr([tpr_filename] * ensemble_width)
 100             assert simulation_input.output.ensemble_width == ensemble_width
 101             assert len(simulation_input.output._simulation_input.result()) == ensemble_width
 102             md = gmx.mdrun(simulation_input)
 103             assert md.output.ensemble_width == ensemble_width
 104             md.run()
 105
 106             output_directory = md.output._work_dir.result()
 107             logging.info('output_directory result: {}'.format(str(output_directory)))
 108             assert len(output_directory) == 2
 109
 110             # Note that the 'cleandir' test fixture will clean up the output directory on
 111             # other ranks, so only check the current rank. Generally, our behavior
 112             # is undefined if the client removes the working directory while the job
 113             # is in progress. We can consider adding some sort of synchronization at
 114             # the end of the job if running in temporary directories becomes an
 115             # important use case outside of testing.
 116             assert output_directory[0] != output_directory[1]
 117             assert os.path.exists(output_directory[current_rank])
 118             assert os.path.exists(md.output.trajectory.result()[current_rank])
 119
 120
 121 @pytest.mark.usefixtures('cleandir')
 122 def test_run_from_read_tpr_op(spc_water_box, caplog, mdrun_kwargs):
 123     with caplog.at_level(logging.DEBUG):
 124         caplog.handler.setFormatter(formatter)
 125         with caplog.at_level(logging.DEBUG, 'gmxapi'):
 126             simulation_input = gmx.read_tpr(spc_water_box)
 127             md = gmx.mdrun(input=simulation_input)
 128
 129             md.run()
 130             if rank_number == 0:
 131                 assert os.path.exists(md.output.trajectory.result())
 132
 133
 134 @pytest.mark.usefixtures('cleandir')
 135 def test_run_from_modify_input_op(spc_water_box, caplog, mdrun_kwargs):
 136     with caplog.at_level(logging.DEBUG):
 137
 138         simulation_input = gmx.read_tpr(spc_water_box)
 139         modified_input = gmx.modify_input(input=simulation_input, parameters={'nsteps': 4})
 140         md = gmx.mdrun(input=modified_input)
 141
 142         md.run()