Reference Guide

This page tests links, see started.rst.

Foo Documentation

automodule

• reframechecks.common.sphexa/foo.py

foo module.

autoclass

• reframechecks.common.sphexa/foo.py -> class Foo:

class reframechecks.common.sphexa.foo.Foo

Bases: object

Foo class.

bye(name)

Print bye addressed to name.

Args:

name (str): Name to address.

automethod

• reframechecks.common.sphexa/foo.py ->

foo.hello()

Print hello addressed to name.

Args:

name (str): Name to address.

autofunction

reframechecks.common.sphexa.foo.seconds_neigh(self)

Reports FindNeighbors time in seconds using the internal timer from the code

reframechecks.common.sphexa.foo.square(a)

short description of the function square

longish explanation: returns the square of a:

Parameters:a – an input argument Returns:a*a

reframechecks.common.sphexa.foo.hello(name)

Print hello addressed to name.

Args:

name (str): Name to address.

TODO

link to parameter::

• Link to prefix parameter

Howto

---

class RegressionTest(metaclass=RegressionTestMeta):
    '''Base class for regression tests.'''
    #: The set of reference values for this test.
    #:
    #: The reference values are specified as a scoped dictionary keyed on the
    #: performance variables defined in :attr:`perf_patterns` and scoped under
    #: the system/partition combinations.
    #: The reference itself is a three- or four-tuple that contains the
    #: reference value, the lower and upper thresholds and, optionally, the
    #: measurement unit.
    #: An example follows:
    #:
    #: .. code:: python
    #:
    #:    self.reference = {
    #:        'sys0:part0': {
    #:            'perfvar0': (50, -0.1, 0.1, 'Gflop/s'),
    #:            'perfvar1': (20, -0.1, 0.1, 'GB/s')
    #:        },
    #:        'sys0:part1': {
    #:            'perfvar0': (100, -0.1, 0.1, 'Gflop/s'),
    #:            'perfvar1': (40, -0.1, 0.1, 'GB/s')
    #:        }
    #:    }
    #:
    #: :type: A scoped dictionary with system names as scopes or :class:`None`
    #: :default: ``{}``
    reference = fields.ScopedDictField('reference', typ.Tuple[object])

    @property
    def current_environ(self):
        '''The programming environment that the regression test is currently
        executing with.

        This is set by the framework during the :func:`setup` phase.

        :type: :class:`reframechecks.common.sphexa.environments.Environment`.
        '''
        return self._current_environ