Description:
idspytoolkit 0.7.0
This module contains a serie of function to help mange and manipulate IDSPy dataclasses
fill_missing_values
ids_to_hdf5
hdf5_to_ids
get_ids_value_from_string
set_ids_value_from_string
list_ids_members
copy_ids
Please note that this work is still under progress/heavy development and as experimental status.
This means that functions arguments/signatures as long as HDF5 structure might be totally redesigned in the next updates.
## Quick example
1 import pprint
2 import dataclasses
3
4 import idspy_toolkit
5 from idspy_dictionaries import ids_gyrokinetics
6
7 pp = pprint.PrettyPrinter(indent=2)
8
9 ids_test = ids_gyrokinetics.Gyrokinetics()
10 # you can directly print the class to see what it looks like :
11 pp.pprint(ids_test)
12
13 # if you want to see all the available classes in the current module :
14 ids_dict = idspy_toolkit.list_ids_members(gkids)
15 pp.pprint(ids_dict)
16
17 #to fill an IDS with default values
18 idspy_toolkit.fill_missing_values(ids_test)
19
20 # you can use the . to access ids members :
21 pp.pprint(ids_test.ids_properties)
22
23 # and to set a value :
24 ids_test.ids_properties.comment="a comment"
25
26 # if in a script you want to reach a "deeper" value, you can use the function *get_ids_value_from_string*
27 idspy_toolkit.get_ids_value_from_string(ids_test, "ids_properties/comment")
28 # and for list element, put the element index after an #
29 idspy_toolkit.get_ids_value_from_string(ids_test, "tag#0/name")
30
31 # same kind of function exist to set a value :
32 idspy_toolkit.set_ids_value_from_string(ids_test, "tag#0/name", "a new tag name")
33
34 # pour afficher la classe sous forme de dictionnaire (conseil mettez l'ecran en vertical ;)):
35 ids_dict = dataclasses.asdict(ids_test)
36 pp.pprint(ids_dict)
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
