netpyne.sim.utils

Module for utilities related to simulation

Functions:

`loadPythonModule`(path)
`cellByGid`(gid)	Function for/to <short description of netpyne.sim.utils.cellByGid>
`getCellsList`(include[, returnGids])	Function for/to <short description of netpyne.sim.utils.getCellsList>
`timing`(mode, processName)	Function for/to <short description of netpyne.sim.utils.timing>
`version`([show])	Function for/to <short description of netpyne.sim.utils.version>
`gitChangeset`([show])	Function for/to <short description of netpyne.sim.utils.gitChangeset>
`gitInfo`([show])	Function for/to <short description of netpyne.sim.utils.gitInfo>
`hashStr`(obj)	Function for/to <short description of netpyne.sim.utils.hashStr>
`hashList`(obj)	Function for/to <short description of netpyne.sim.utils.hashList>
`fileDigest`(file)
`unique`(seq)	Function for/to <short description of netpyne.sim.utils.unique>
`checkMemory`()	Function for/to <short description of netpyne.sim.utils.checkMemory>
`copyReplaceItemObj`(obj, keystart, newval[, ...])	Function for/to <short description of netpyne.sim.utils.copyReplaceItemObj>
`copyRemoveItemObj`(obj, keystart[, objCopy, ...])	Function for/to <short description of netpyne.sim.utils.copyRemoveItemObj>
`replaceItemObj`(obj, keystart, newval[, ...])	Function for/to <short description of netpyne.sim.utils.replaceItemObj>
`replaceKeys`(obj, oldkey, newkey)	Function for/to <short description of netpyne.sim.utils.replaceKeys>
`replaceFuncObj`(obj)	Function for/to <short description of netpyne.sim.utils.replaceFuncObj>
`replaceDictODict`(obj)	Function for/to <short description of netpyne.sim.utils.replaceDictODict>
`rename`(obj, old, new[, label])	Function for/to <short description of netpyne.sim.utils.rename>
`tupleToList`(obj)	Function for/to <short description of netpyne.sim.utils.tupleToList>
`decimalToFloat`(obj)	Function for/to <short description of netpyne.sim.utils.decimalToFloat>
`clearObj`(obj)	Function for/to <short description of netpyne.sim.utils.clearObj>
`clearAll`()	Function to clear all sim objects in memory
`checkConditions`(conditions, against[, cellGid])

Classes:

NpSerializer(*[, skipkeys, ensure_ascii, ...])

Class for/to <short description of netpyne.sim.utils.NpSerializer>

netpyne.sim.utils.loadPythonModule(path)[source]

netpyne.sim.utils.cellByGid(gid)[source]

Function for/to <short description of netpyne.sim.utils.cellByGid>

Parameters:: gid (<type>) – <Short description of gid> Default: required

netpyne.sim.utils.getCellsList(include, returnGids=False)[source]

Function for/to <short description of netpyne.sim.utils.getCellsList>

Parameters:

include (<type>) – <Short description of include> Default: required
returnGids (bool) – <Short description of returnGids> Default: False Options: <option> <description of option>

netpyne.sim.utils.timing(mode, processName)[source]

Function for/to <short description of netpyne.sim.utils.timing>

Parameters:

mode (<type>) – <Short description of mode> Default: required
processName (<type>) – <Short description of processName> Default: required

netpyne.sim.utils.version(show=True)[source]

Function for/to <short description of netpyne.sim.utils.version>

Parameters:: show (bool) – <Short description of show> Default: True Options: <option> <description of option>

netpyne.sim.utils.gitChangeset(show=True)[source]

Function for/to <short description of netpyne.sim.utils.gitChangeset>

Parameters:: show (bool) – <Short description of show> Default: True Options: <option> <description of option>

netpyne.sim.utils.gitInfo(show=True)[source]

Function for/to <short description of netpyne.sim.utils.gitInfo>

Parameters:: show (bool) – <Short description of show> Default: True Options: <option> <description of option>

netpyne.sim.utils.hashStr(obj)[source]

Function for/to <short description of netpyne.sim.utils.hashStr>

Parameters:: obj (<type>) – <Short description of obj> Default: required

netpyne.sim.utils.hashList(obj)[source]

Function for/to <short description of netpyne.sim.utils.hashList>

Parameters:: obj (<type>) – <Short description of obj> Default: required

netpyne.sim.utils.fileDigest(file)[source]

netpyne.sim.utils.unique(seq)[source]

Function for/to <short description of netpyne.sim.utils.unique>

Parameters:: seq (<type>) – <Short description of seq> Default: required

netpyne.sim.utils.checkMemory()[source]: Function for/to <short description of netpyne.sim.utils.checkMemory>

netpyne.sim.utils.copyReplaceItemObj(obj, keystart, newval, objCopy='ROOT', exclude_list=[])[source]

Function for/to <short description of netpyne.sim.utils.copyReplaceItemObj>

Parameters:

obj (<type>) – <Short description of obj> Default: required
keystart (<type>) – <Short description of keystart> Default: required
newval (<type>) – <Short description of newval> Default: required
objCopy (str) – <Short description of objCopy> Default: 'ROOT' Options: <option> <description of option>
exclude_list (list) – <Short description of exclude_list> Default: [] Options: <option> <description of option>

netpyne.sim.utils.copyRemoveItemObj(obj, keystart, objCopy='ROOT', exclude_list=[])[source]

Function for/to <short description of netpyne.sim.utils.copyRemoveItemObj>

Parameters:

obj (<type>) – <Short description of obj> Default: required
keystart (<type>) – <Short description of keystart> Default: required
objCopy (str) – <Short description of objCopy> Default: 'ROOT' Options: <option> <description of option>
exclude_list (list) – <Short description of exclude_list> Default: [] Options: <option> <description of option>

netpyne.sim.utils.replaceItemObj(obj, keystart, newval, exclude_list=[])[source]

Function for/to <short description of netpyne.sim.utils.replaceItemObj>

Parameters:

obj (<type>) – <Short description of obj> Default: required
keystart (<type>) – <Short description of keystart> Default: required
newval (<type>) – <Short description of newval> Default: required
exclude_list (list) – <Short description of exclude_list> Default: [] Options: <option> <description of option>

netpyne.sim.utils.replaceKeys(obj, oldkey, newkey)[source]

Function for/to <short description of netpyne.sim.utils.replaceKeys>

Parameters:

obj (<type>) – <Short description of obj> Default: required
oldkey (<type>) – <Short description of oldkey> Default: required
newkey (<type>) – <Short description of newkey> Default: required

netpyne.sim.utils.replaceFuncObj(obj)[source]

Function for/to <short description of netpyne.sim.utils.replaceFuncObj>

Parameters:: obj (<type>) – <Short description of obj> Default: required

netpyne.sim.utils.replaceDictODict(obj)[source]

Function for/to <short description of netpyne.sim.utils.replaceDictODict>

Parameters:: obj (<type>) – <Short description of obj> Default: required

netpyne.sim.utils.rename(obj, old, new, label=None)[source]

Function for/to <short description of netpyne.sim.utils.rename>

Parameters:

obj (<type>) – <Short description of obj> Default: required
old (<type>) – <Short description of old> Default: required
new (<type>) – <Short description of new> Default: required
label (<None?>) – <Short description of label> Default: None Options: <option> <description of option>

netpyne.sim.utils.tupleToList(obj)[source]

Function for/to <short description of netpyne.sim.utils.tupleToList>

Parameters:: obj (<type>) – <Short description of obj> Default: required

netpyne.sim.utils.decimalToFloat(obj)[source]

Function for/to <short description of netpyne.sim.utils.decimalToFloat>

Parameters:: obj (<type>) – <Short description of obj> Default: required

netpyne.sim.utils.clearObj(obj)[source]

Function for/to <short description of netpyne.sim.utils.clearObj>

Parameters:: obj (<type>) – <Short description of obj> Default: required

netpyne.sim.utils.clearAll()[source]: Function to clear all sim objects in memory

netpyne.sim.utils.checkConditions(conditions, against, cellGid=None)[source]

class netpyne.sim.utils.NpSerializer(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)[source]

Bases: JSONEncoder

Class for/to <short description of netpyne.sim.utils.NpSerializer>

Methods:

default(obj)

Implement this method in a subclass such that it returns a serializable object for o, or calls the base implementation (to raise a TypeError).

default(obj)[source]

Implement this method in a subclass such that it returns a serializable object for o, or calls the base implementation (to raise a TypeError).

For example, to support arbitrary iterators, you could implement default like this:

def default(self, o):
    try:
        iterable = iter(o)
    except TypeError:
        pass
    else:
        return list(iterable)
    # Let the base class default method raise the TypeError
    return JSONEncoder.default(self, o)