File: test_runtime.py

package info (click to toggle)
gromacs 2026~rc-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 274,216 kB
  • sloc: xml: 3,831,143; cpp: 686,111; ansic: 75,300; python: 21,171; sh: 3,553; perl: 2,246; yacc: 644; fortran: 397; lisp: 265; makefile: 174; lex: 125; awk: 68; csh: 39
file content (195 lines) | stat: -rw-r--r-- 8,151 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
#
# This file is part of the GROMACS molecular simulation package.
#
# Copyright 2019- The GROMACS Authors
# and the project initiators Erik Lindahl, Berk Hess and David van der Spoel.
# Consult the AUTHORS/COPYING files and https://www.gromacs.org for details.
#
# GROMACS is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public License
# as published by the Free Software Foundation; either version 2.1
# of the License, or (at your option) any later version.
#
# GROMACS is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with GROMACS; if not, see
# https://www.gnu.org/licenses, or write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
#
# If you want to redistribute modifications to GROMACS, please
# consider that scientific software is very special. Version
# control is crucial - bugs must be traceable. We will be happy to
# consider code for inclusion in the official distribution, but
# derived work must not be called official GROMACS. Details are found
# in the README & COPYING files - if they are missing, get the
# official version at https://www.gromacs.org.
#
# To help us fund GROMACS development, we humbly ask that you cite
# the research papers on the package. Check out https://www.gromacs.org.

"""Test the utilities in the gmxapi.runtime module."""

import logging

import gmxapi.utility
from gmxapi.runtime import (
    scoped_resources,
    BaseContext,
    ResourceRequirements,
    ResourceAssignment,
)

try:
    from mpi4py import MPI

    rank_number = MPI.COMM_WORLD.Get_rank()
    comm_size = MPI.COMM_WORLD.Get_size()
except ImportError:
    rank_number = 0
    comm_size = 1
    rank_tag = ""
    MPI = None
else:
    rank_tag = "rank{}:".format(rank_number)

logger = logging.getLogger()


def test_no_requested_comm():
    """Indicate multiple subtasks, but don't request any comm resources."""
    base = BaseContext.instance()
    assert base.communicator().Get_rank() == rank_number
    assert base.communicator().Get_size() == comm_size
    assignment = None
    # Indicate multiple subtasks, but don't request any comm resources.
    for num_tasks in range(1, comm_size + 1):
        requirements = ResourceRequirements(
            communication=tuple({} for _ in range(num_tasks))
        )
        with scoped_resources(base, requirements=requirements) as assignment:
            assert assignment._base_comm_size == base.communicator().Get_size()
            assert assignment.base_rank() == base.communicator().Get_rank()
            assert set(assignment._group_ids) == set(range(num_tasks))
            group_id = assignment._group_ids[rank_number]
            assert group_id >= 0
            assert group_id < num_tasks
            roots = assignment._roots
            assert len(set(roots) - {None}) == num_tasks
            assert set(roots) - {None} == set(range(num_tasks))
            if rank_number == 0:
                assert group_id == 0
            if rank_number == comm_size - 1:
                assert group_id == num_tasks - 1
            if assignment.is_subtask_root():
                _count = 1
            else:
                _count = 0
            num_roots = base.communicator().allreduce(_count)
            assert num_roots == num_tasks
            assert not assignment.subtask_id()
            assert not assignment.subtask_rank()
            assert set(assignment._group_ids) == set(range(num_tasks))
    assert isinstance(assignment, ResourceAssignment)
    message = " ".join(
        [
            f"*{rank}*" if rank == assignment.base_rank() else f"{rank}"
            for rank in range(comm_size)
        ]
    )
    logger.info(message)


def test_no_ensemble_comm():
    """Indicate multiple subtasks, but don't request an ensemble comm."""
    base = BaseContext.instance()
    for num_tasks in range(1, comm_size + 1):
        requirements = ResourceRequirements(
            communication=tuple({"subtask_comm": True} for _ in range(num_tasks))
        )
        with scoped_resources(base, requirements=requirements) as assignment:
            if assignment.subtask_rank() == 0:
                assert assignment.is_subtask_root()
            subtasks = base.communicator().allgather(assignment.subtask_id())
            subtasks = set(subtasks) - {None}
            assert subtasks == set(range(num_tasks))
            subtask_communicator = assignment.communicator()
            if assignment.subtask_rank() is not None:
                assert subtask_communicator.Get_rank() == assignment.subtask_rank()
                _count = 1
            else:
                _count = 0
            total = base.communicator().allreduce(_count)
            if gmxapi.utility.config()["gmx_mpi_type"] == "library":
                assert total == comm_size
            else:
                if subtask_communicator:
                    assert subtask_communicator.Get_size() == 1
                assert total == num_tasks
            if assignment.subtask_id():
                total = subtask_communicator.allreduce(_count)
                if gmxapi.utility.config()["gmx_mpi_type"] == "library":
                    assert total >= 1
                    assert total <= comm_size - (num_tasks - 1)
                else:
                    assert total == 1
                    assert assignment.subtask_rank() == 0


def test_no_subtask_comm():
    """Indicate multiple subtasks, but don't request subtask comms."""
    base = BaseContext.instance()
    for num_tasks in range(1, comm_size + 1):
        requirements = ResourceRequirements(
            communication=tuple({"ensemble_comm": 1} for _ in range(num_tasks))
        )
        with scoped_resources(base, requirements=requirements) as assignment:
            assert not assignment.subtask_id()
            assert not assignment.subtask_rank()
            assert assignment._resource_id is not None
            labels = base.communicator().allgather(assignment._resource_id)
            assert len(set(labels)) == 1
            if assignment.is_subtask_root():
                assert assignment.ensemble_communicator()
            if assignment.ensemble_communicator():
                assert assignment.ensemble_communicator().Get_size() == num_tasks
                assert assignment.is_subtask_root()
                assert (
                    assignment._group_ids[rank_number]
                    == assignment.ensemble_communicator().Get_rank()
                )
                _count = 1
                assert assignment.ensemble_communicator().allreduce(_count) == num_tasks
            else:
                _count = 0
            total = base.communicator().allreduce(_count)
            assert total == num_tasks


def test_assign_ensemble():
    """Indicate an ensemble of subtasks with all resources."""
    base = BaseContext.instance()
    # for num_tasks in range(3, 4):
    for num_tasks in range(1, comm_size + 1):
        requirements = ResourceRequirements(
            communication=tuple(
                {"ensemble_comm": 2, "subtask_comm": True} for _ in range(num_tasks)
            )
        )
        with scoped_resources(base, requirements=requirements) as assignment:
            subtask_rank = assignment.subtask_rank()
            if subtask_rank is not None:
                subtask_comm = assignment.communicator()
                assert subtask_comm.Get_rank() == subtask_rank
                assert subtask_comm.Get_size() > subtask_rank
            if subtask_rank == 0:
                assert bool(assignment.ensemble_communicator())
            if assignment.ensemble_communicator():
                assert subtask_rank == 0
                assert (
                    assignment.subtask_id()
                    == assignment.ensemble_communicator().Get_rank()
                )