sierra-research 1.3.11__py3-none-any.whl → 1.5.0__py3-none-any.whl

sierra/plugins/platform/ros1robot/variables/population_size.py

@@ -1,146 +0,0 @@
-# Copyright 2020 John Harwell, All rights reserved.
-#
-# SPDX-License-Identifier: MIT
-"""Classes for the population size batch criteria.
-
-See :ref:`ln-sierra-platform-ros1robot-bc-population-size` for usage
-documentation.
-
-"""
-
-# Core packages
-import typing as tp
-import logging
-import pathlib
-
-# 3rd party packages
-import implements
-
-# Project packages
-from sierra.core.variables import batch_criteria as bc
-from sierra.core import types
-from sierra.core.variables import population_size
-from sierra.core.experiment import xml
-
-
-@implements.implements(bc.IConcreteBatchCriteria)
-@implements.implements(bc.IQueryableBatchCriteria)
-class PopulationSize(population_size.BasePopulationSize):
-    """A univariate range of system sizes used to define batch experiments.
-
-    This class is a base class which should (almost) never be used on its
-    own. Instead, the ``factory()`` function should be used to dynamically
-    create derived classes expressing the user's desired size distribution.
-
-    Note: Usage of this class assumes homogeneous systems.
-
-    Attributes:
-
-        size_list: List of integer system sizes defining the range of the
-                   variable for the batch experiment.
-
-    """
-
-    def __init__(self,
-                 cli_arg: str,
-                 main_config: types.YAMLDict,
-                 batch_input_root: pathlib.Path,
-                 robot: str,
-                 sizes: tp.List[int]) -> None:
-        population_size.BasePopulationSize.__init__(self,
-                                                    cli_arg,
-                                                    main_config,
-                                                    batch_input_root)
-        self.sizes = sizes
-        self.robot = robot
-        self.logger = logging.getLogger(__name__)
-        self.tag_adds = []  # type: tp.List[xml.TagAddList]
-
-    def gen_tag_addlist(self) -> tp.List[xml.TagAddList]:
-        """
-        Generate XML modifications to set system sizes.
-        """
-        if not self.tag_adds:
-            robot_config = self.main_config['ros']['robots'][self.robot]
-            prefix = robot_config['prefix']
-
-            for s in self.sizes:
-                per_robot = xml.TagAddList()
-                per_robot.append(xml.TagAdd(".",
-                                            "master",
-                                            {},
-                                            True))
-                per_robot.append(xml.TagAdd("./master",
-                                            "group",
-                                            {
-                                                'ns': 'sierra'
-                                            },
-                                            False))
-                per_robot.append(xml.TagAdd("./master/group/[@ns='sierra']",
-                                            "param",
-                                            {
-                                                'name': 'experiment/n_robots',
-                                                'value': str(s)
-                                            },
-                                            False))
-
-                for i in range(0, s):
-
-                    # Note that we don't try to do any of the robot bringup
-                    # here--we can't know the exact node/package names without
-                    # using a lot of (brittle) config.
-                    ns = f'{prefix}{i}'
-                    per_robot.append(xml.TagAdd("./robot",
-                                                "group",
-                                                {
-                                                    'ns': ns
-                                                },
-                                                True))
-
-                    per_robot.append(xml.TagAdd(f"./robot/group/[@ns='{ns}']",
-                                                "param",
-                                                {
-                                                    "name": "tf_prefix",
-                                                    "value": ns
-                                                },
-                                                True))
-
-                self.tag_adds.append(per_robot)
-
-        return self.tag_adds
-
-    def gen_exp_names(self, cmdopts: types.Cmdopts) -> tp.List[str]:
-        adds = self.gen_tag_addlist()
-        return ['exp' + str(x) for x in range(0, len(adds))]
-
-    def n_robots(self, exp_num: int) -> int:
-        return self.sizes[exp_num]
-
-
-def factory(cli_arg: str,
-            main_config: types.YAMLDict,
-            cmdopts: types.Cmdopts,
-            **kwargs) -> PopulationSize:
-    """Create a :class:`PopulationSize` derived class from the cmdline definition.
-
-    """
-    parser = population_size.Parser()
-    attr = parser(cli_arg)
-    max_sizes = parser.to_sizes(attr)
-
-    def __init__(self) -> None:
-        PopulationSize.__init__(self,
-                                cli_arg,
-                                main_config,
-                                cmdopts['batch_input_root'],
-                                cmdopts['robot'],
-                                max_sizes)
-
-    return type(cli_arg,  # type: ignore
-                (PopulationSize,),
-                {"__init__": __init__})
-
-
-__api__ = [
-    'PopulationSize'
-]

sierra/plugins/robot/__init__.py

@@ -1,9 +0,0 @@
-# Copyright 2021 John Harwell, All rights reserved.
-#
-#  SPDX-License-Identifier: MIT
-
-# Core packages
-
-# 3rd party packages
-
-# Project packages

sierra/plugins/robot/turtlebot3/__init__.py

@@ -1,9 +0,0 @@
-# Copyright 2021 John Harwell, All rights reserved.
-#
-#  SPDX-License-Identifier: MIT
-
-# Core packages
-
-# 3rd party packages
-
-# Project packages

sierra/plugins/robot/turtlebot3/plugin.py

@@ -1,194 +0,0 @@
-# Copyright 2021 John Harwell, All rights reserved.
-#
-#  SPDX-License-Identifier: MIT
-"""
-Robot plugin for running SIERRA with a set of Turtlebot3 robots.
-
-"""
-
-# Core packages
-import os
-import logging
-import typing as tp
-import argparse
-import shutil
-import pathlib
-
-# 3rd party packages
-import implements
-
-# Project packages
-from sierra.core import types, platform, utils
-from sierra.core.experiment import bindings
-
-
-@implements.implements(bindings.IParsedCmdlineConfigurer)
-class ParsedCmdlineConfigurer():
-    """Configure SIERRA for the turtlebot3 execution environment.
-
-    May use the following environment variables:
-
-    - ``SIERRA_NODEFILE`` - If this is not defined ``--nodefile`` must be
-      passed.
-
-    """
-
-    def __init__(self, exec_env: str) -> None:
-        self.logger = logging.getLogger("robot.turtlebot3")
-
-    def __call__(self, args: argparse.Namespace) -> None:
-        if args.nodefile is None:
-            assert 'SIERRA_NODEFILE' in os.environ,\
-                ("Non-robot.turtlebot3 environment detected: --nodefile not "
-                 "passed and 'SIERRA_NODEFILE' not found")
-            args.nodefile = os.environ['SIERRA_NODEFILE']
-
-        assert utils.path_exists(args.nodefile), \
-            f"SIERRA_NODEFILE '{args.nodefile}' does not exist"
-        self.logger.info("Using '%s' as robot hostnames file", args.nodefile)
-
-        assert not args.platform_vc,\
-            "Platform visual capture not supported on robot.turtlebot3"
-
-
-@implements.implements(bindings.IExpShellCmdsGenerator)
-class ExpShellCmdsGenerator():
-    """Generate the cmds to invoke GNU Parallel to launch ROS on the turtlebots.
-
-    """
-
-    def __init__(self,
-                 cmdopts: types.Cmdopts,
-                 exp_num: int) -> None:
-        self.cmdopts = cmdopts
-        self.exp_num = exp_num
-
-    def pre_exp_cmds(self) -> tp.List[types.ShellCmdSpec]:
-        return []
-
-    def post_exp_cmds(self) -> tp.List[types.ShellCmdSpec]:
-        return []
-
-    def exec_exp_cmds(self, exec_opts: types.StrDict) -> tp.List[types.ShellCmdSpec]:
-        jobid = os.getpid()
-
-        # Even if we are passed --nodelist, we still make our own copy of it, so
-        # that the user can safely modify it (if they want to) after running
-        # stage 1.
-        nodelist = pathlib.Path(exec_opts['exp_input_root'],
-                                "{0}-nodelist.txt".format(jobid))
-
-        resume = ''
-        # This can't be --resume, because then GNU parallel looks at the results
-        # directory, and if there is stuff in it, (apparently) assumes that the
-        # job finished...
-        if exec_opts['exec_resume']:
-            resume = '--resume-failed'
-
-        # Make sure there are no duplicate nodes
-        unique_nodes = types.ShellCmdSpec(
-            cmd='sort -u {0} > {1}'.format(exec_opts["nodefile"], nodelist),
-            shell=True,
-            wait=True)
-
-        # Make sure GNU parallel uses the right shell, because it seems to
-        # defaults to /bin/sh since all cmds are run in a python shell which
-        # does not have $SHELL set.
-        use_bash = types.ShellCmdSpec(
-            cmd='export PARALLEL_SHELL={0}'.format(shutil.which('bash')),
-            shell=True,
-            env=True,
-            wait=True)
-
-        ret = [use_bash, unique_nodes]
-
-        # 1 GNU parallel command to launch each experimental run, because each
-        # run might use all available nodes/robots.
-        for i in range(self.cmdopts['n_runs']):
-
-            # GNU parallel cmd for robots (slaves)
-            robots = 'parallel {2} ' \
-                '--jobs {1} ' \
-                '--results {4} ' \
-                '--joblog {3} ' \
-                '--sshloginfile {0} ' \
-                '--workdir {4} < "{5}"'
-
-            robots_ipath = exec_opts['cmdfile_stem_path'] + \
-                f"_run{i}_slave" + exec_opts['cmdfile_ext']
-
-            robot_log = pathlib.Path(exec_opts['scratch_dir'],
-                                     f"parallel-slaves-run{i}.log")
-
-            robots = robots.format(nodelist,
-                                   exec_opts['n_jobs'],
-                                   resume,
-                                   robot_log,
-                                   exec_opts['scratch_dir'],
-                                   robots_ipath)
-
-            # If no master is spawned, then we need to wait for this GNU
-            # parallel cmd. If the master is spawned, then we wait for THAT
-            # command; waiting for both results in the master never starting
-            # because that cmd is never run.
-            robots_spec = types.ShellCmdSpec(cmd=robots,
-                                             shell=True,
-                                             wait=self.cmdopts['no_master_node'])
-            ret.append(robots_spec)
-
-            if not self.cmdopts['no_master_node']:
-                ros_master = 'parallel {3} ' \
-                    '--results {1} ' \
-                    '--joblog {0} ' \
-                    '--workdir {1} < "{2}"'
-
-                ros_master_ipath = exec_opts['cmdfile_stem_path'] + \
-                    f"_run{i}_master" + exec_opts['cmdfile_ext']
-
-                master_log = pathlib.Path(exec_opts['scratch_dir'],
-                                          f"parallel-master-run{i}.log")
-                ros_master = ros_master.format(master_log,
-                                               exec_opts['scratch_dir'],
-                                               ros_master_ipath,
-                                               resume)
-
-                master_spec = types.ShellCmdSpec(cmd=ros_master,
-                                                 shell=True,
-                                                 wait=not self.cmdopts['no_master_node'])
-                ret.append(master_spec)
-
-            wait = ('echo  "{0} seconds until launching next run!"; '
-                    'sleep {0}s ;'.format(self.cmdopts['exec_inter_run_pause']))
-            wait_spec = types.ShellCmdSpec(cmd=wait,
-                                           shell=True,
-                                           wait=True)
-            ret.append(wait_spec)
-        return ret
-
-
-class ExecEnvChecker(platform.ExecEnvChecker):
-    def __init__(self, cmdopts: types.Cmdopts) -> None:
-        super().__init__(cmdopts)
-        self.cmdopts = cmdopts
-        self.logger = logging.getLogger('robot.turtlebot3')
-
-    def __call__(self) -> None:
-        nodes = self.parse_nodefile(self.cmdopts['nodefile'])
-        for node in nodes:
-            if int(node.n_cores) != 1:
-                self.logger.warning(("Nodefile %s, host %s has multiple "
-                                     "cores; turtlebots are single core"),
-                                    self.cmdopts['nodefile'],
-                                    node.hostname)
-            if not self.cmdopts['skip_online_check']:
-                self.check_connectivity(node.login,
-                                        node.hostname,
-                                        node.port,
-                                        'turtlebot3')
-
-
-__api__ = [
-    'ParsedCmdlineConfigurer',
-    'ExpShellCmdsGenerator',
-    'ExecEnvChecker'
-]