Improve workload data structures' docs
[gromacs.git] / python_packaging / test / test_fr04.py
blob9a748557bbf5e3040bb4767600b2a68b951a5252
2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 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.
35 """Test gmxapi functionality described in roadmap.rst."""
37 import pytest
39 import gmxapi as gmx
40 from gmxapi.version import has_feature
42 @pytest.mark.skipif(not has_feature('fr4'),
43 reason="Feature level not met.")
44 def test_fr4():
45 """FR4: Dimensionality and typing of named data causes generation of correct work topologies."""
46 N = 10
47 simulation_input = gmx.read_tpr(initial_tpr)
49 # Array inputs imply array outputs.
50 input_array = gmx.modify_input(
51 simulation_input, params={'tau-t': [t / 10.0 for t in range(N)]})
53 md = gmx.mdrun(input_array) # An array of simulations
55 rmsf = gmx.commandline_operation(
56 'gmx',
57 'rmsf',
58 input={
59 '-f': md.output.trajectory,
60 '-s': initial_tpr
62 output={'-o': gmx.FileName(suffix='.xvg')})