Package psychopy :: Module info :: Class RunTimeInfo
[frames] | no frames]

Class RunTimeInfo

source code


Returns a snapshot of your configuration at run-time, for immediate or archival use.

Returns a dict-like object with info about PsychoPy, your experiment script, the system & OS, your window and monitor settings (if any), python & packages, and openGL.

If you want to skip testing the refresh rate, use 'refreshTest=None'

Example usage: see runtimeInfo.py in coder demos.


Author:

Instance Methods
new empty dictionary

__init__(self, author=None, version=None, win=None, refreshTest='grating', userProcsDetailed=False, verbose=False, randomSeed=None)
:Parameters:
source code
 
__repr__(self)
Return a string that is a legal python (dict), and close to YAML, .ini, and configObj syntax
source code
 
__str__(self)
Return a string intended for printing to a log file
source code

Inherited from dict: __cmp__, __contains__, __delitem__, __eq__, __ge__, __getattribute__, __getitem__, __gt__, __hash__, __iter__, __le__, __len__, __lt__, __ne__, __new__, __setitem__, clear, copy, fromkeys, get, has_key, items, iteritems, iterkeys, itervalues, keys, pop, popitem, setdefault, update, values

Inherited from object: __delattr__, __reduce__, __reduce_ex__, __setattr__

Properties

Inherited from object: __class__

Method Details

__init__(self, author=None, version=None, win=None, refreshTest='grating', userProcsDetailed=False, verbose=False, randomSeed=None)
(Constructor)

source code 

:Parameters:
    
    win : *None*, False, :class:`~psychopy.visual.Window` instance
        what window to use for refresh rate testing (if any) and settings. None -> temporary window using
        defaults; False -> no window created, used, nor profiled; a Window() instance you have already created
    
    author : *None*, string
        None = try to autodetect first __author__ in sys.argv[0]; string = user-supplied author info (of an experiment)
    
    version : *None*, string
        None = try to autodetect first __version__ in sys.argv[0]; string = user-supplied version info (of an experiment)
    
    verbose : *False*, True; how much detail to assess
    
    refreshTest : None, False, True, *'grating'*
        True or 'grating' = assess refresh average, median, and SD of 60 win.flip()s, using visual.getMsPerFrame()
        'grating' = show a visual during the assessment; True = assess without a visual
        
    userProcsDetailed: *False*, True
        get details about concurrent user's processses (command, process-ID)
        
    randomSeed: *None*
        a way for the user to record, and optionally set, a random seed for making reproducible random sequences
        'set:XYZ' will both record the seed, 'XYZ', and set it: random.seed('XYZ'); numpy.random.seed() is NOT set
        None defaults to python default;
        'time' = use time.time() as the seed, as obtained during RunTimeInfo()
        randomSeed='set:time' will give a new random seq every time the script is run, with the seed recorded.
        
:Returns: 
    a flat dict (but with several groups based on key names):
    
    psychopy : version, rush() availability
        psychopyVersion, psychopyHaveExtRush
        
    experiment : author, version, directory, name, current time-stamp, 
        SHA1 digest, VCS info (if any, svn or hg only),
        experimentAuthor, experimentVersion, ...
        
    system : hostname, platform, user login, count of users, user process info (count, cmd + pid), flagged processes
        systemHostname, systemPlatform, ...
        
    window : (see output; many details about the refresh rate, window, and monitor; units are noted)
        windowWinType, windowWaitBlanking, ...windowRefreshTimeSD_ms, ... windowMonitor.<details>, ...
        
    python : version of python, versions of key packages (numpy, scipy, matplotlib, pyglet, pygame)
        pythonVersion, pythonScipyVersion, ...
        
    openGL : version, vendor, rendering engine, plus info on whether several extensions are present
        openGLVersion, ..., openGLextGL_EXT_framebuffer_object, ...

Returns:
new empty dictionary

Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 
Return a string that is a legal python (dict), and close to YAML, .ini, and configObj syntax
Overrides: object.__repr__

__str__(self)
(Informal representation operator)

source code 
Return a string intended for printing to a log file
Overrides: object.__str__