Download latest PDF - Read the Docs

Transcript
pypet Documentation, Release 0.1.0
v_trajectory_timestamp
Float timestamp when (parent) trajectory was created
v_version
The version of pypet that was used to create the trajectory
v_with_links
Whether links should be considered in case using natural naming or squared bracket indexing
pypet.trajectory.load_trajectory(name=None,
index=None,
as_new=False,
load_parameters=2,
load_derived_parameters=1,
load_results=1, load_other_data=1, recursive=True,
load_data=None, max_depth=None, force=False, dynamic_imports=None,
new_name=’my_trajectory’,
add_time=True,
wildcard_functions=None,
with_run_information=True,
storage_service=<class
‘pypet.storageservice.HDF5StorageService’>, **kwargs)
Helper function that creates a novel trajectory and loads it from disk.
For the parameters see f_load().
new_name and add_time are only used in case as_new is True. Accordingly, they determine the new
name of trajectory.
3.2.3 NNGroupNode
class pypet.naturalnaming.NNGroupNode(full_name=’‘, trajectory=None, comment=’‘)
A group node hanging somewhere under the trajectory or single run root node.
You can add other groups or parameters/results to it.
f_add_group(*args, **kwargs)
Adds an empty generic group under the current node.
You can add to a generic group anywhere you want. So you are free to build your parameter tree
with any structure. You do not necessarily have to follow the four subtrees config, parameters, derived_parameters, results.
If you are operating within these subtrees this simply calls the corresponding adding function.
Be aware that if you are within a single run and you add items not below a group run_XXXXXXXX that
you have to manually save the items. Otherwise they will be lost after the single run is completed.
f_add_leaf(*args, **kwargs)
Adds an empty generic leaf under the current node.
You can add to a generic leaves anywhere you want. So you are free to build your trajectory tree
with any structure. You do not necessarily have to follow the four subtrees config, parameters, derived_parameters, results.
If you are operating within these subtrees this simply calls the corresponding adding function.
Be aware that if you are within a single run and you add items not below a group run_XXXXXXXX that
you have to manually save the items. Otherwise they will be lost after the single run is completed.
f_add_link(name_or_item, full_name_or_item=None)
Adds a link to an existing node.
Can be called as node.f_add_link(other_node) this will add a link the other_node with the
link name as the name of the node.
Or can be called as node.f_add_link(name, other_node) to add a link to the other_node
and the given name of the link.
In contrast to addition of groups and leaves, colon separated names are not allowed, i.e.
node.f_add_link(’mygroup.mylink’, other_node) does not work.
160
Chapter 3. Library Reference