h5rdmtoolbox 2.5.4__tar.gz → 2.6.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/PKG-INFO +137 -141
  2. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/README.md +109 -30
  3. h5rdmtoolbox-2.6.1/h5rdmtoolbox/catalog/__init__.py +499 -0
  4. h5rdmtoolbox-2.6.1/h5rdmtoolbox/catalog/_initialization.py +88 -0
  5. h5rdmtoolbox-2.6.1/h5rdmtoolbox/catalog/abstracts.py +241 -0
  6. h5rdmtoolbox-2.6.1/h5rdmtoolbox/catalog/core.py +878 -0
  7. h5rdmtoolbox-2.6.1/h5rdmtoolbox/catalog/profiles.py +73 -0
  8. h5rdmtoolbox-2.6.1/h5rdmtoolbox/catalog/query_templates.py +169 -0
  9. h5rdmtoolbox-2.6.1/h5rdmtoolbox/catalog/stores/hdf5.py +140 -0
  10. h5rdmtoolbox-2.6.1/h5rdmtoolbox/catalog/utils.py +554 -0
  11. h5rdmtoolbox-2.5.4/tests/conventions/test_convention_vfuncs.py → h5rdmtoolbox-2.6.1/h5rdmtoolbox/data/tutorial_convention_vfuncs.py +4 -20
  12. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/hdf/attributes.py +0 -3
  13. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/hdf/datasets.py +2 -1
  14. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/user/groups.py +4 -2
  15. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/repository/utils.py +9 -8
  16. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/repository/zenodo/core.py +38 -17
  17. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox.egg-info/PKG-INFO +137 -141
  18. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox.egg-info/SOURCES.txt +12 -36
  19. h5rdmtoolbox-2.6.1/h5rdmtoolbox.egg-info/requires.txt +69 -0
  20. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox.egg-info/top_level.txt +0 -1
  21. h5rdmtoolbox-2.6.1/pyproject.toml +133 -0
  22. h5rdmtoolbox-2.6.1/setup.cfg +4 -0
  23. h5rdmtoolbox-2.6.1/tests/test_readme.py +22 -0
  24. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/tests/test_version.py +78 -72
  25. h5rdmtoolbox-2.5.4/h5rdmtoolbox.egg-info/requires.txt +0 -116
  26. h5rdmtoolbox-2.5.4/pyproject.toml +0 -6
  27. h5rdmtoolbox-2.5.4/setup.cfg +0 -117
  28. h5rdmtoolbox-2.5.4/setup.py +0 -4
  29. h5rdmtoolbox-2.5.4/tests/clean_zenodo_sandbox.py +0 -23
  30. h5rdmtoolbox-2.5.4/tests/conftest.py +0 -10
  31. h5rdmtoolbox-2.5.4/tests/conventions/__init__.py +0 -0
  32. h5rdmtoolbox-2.5.4/tests/conventions/test_conventions.py +0 -731
  33. h5rdmtoolbox-2.5.4/tests/conventions/test_engmeta.py +0 -55
  34. h5rdmtoolbox-2.5.4/tests/conventions/test_references.py +0 -33
  35. h5rdmtoolbox-2.5.4/tests/conventions/test_toolbox_validators.py +0 -148
  36. h5rdmtoolbox-2.5.4/tests/conventions/test_utils.py +0 -94
  37. h5rdmtoolbox-2.5.4/tests/database/__init__.py +0 -0
  38. h5rdmtoolbox-2.5.4/tests/database/test_find_rdf.py +0 -36
  39. h5rdmtoolbox-2.5.4/tests/database/test_hdfDB.py +0 -619
  40. h5rdmtoolbox-2.5.4/tests/database/test_mongo.py +0 -229
  41. h5rdmtoolbox-2.5.4/tests/layouts/__init__.py +0 -0
  42. h5rdmtoolbox-2.5.4/tests/layouts/test_core.py +0 -362
  43. h5rdmtoolbox-2.5.4/tests/layouts/test_docs.py +0 -66
  44. h5rdmtoolbox-2.5.4/tests/ld/__init__.py +0 -0
  45. h5rdmtoolbox-2.5.4/tests/ld/test_ld.py +0 -904
  46. h5rdmtoolbox-2.5.4/tests/ld/test_rdf.py +0 -749
  47. h5rdmtoolbox-2.5.4/tests/ld/test_shacl.py +0 -223
  48. h5rdmtoolbox-2.5.4/tests/ld/test_user_graph.py +0 -278
  49. h5rdmtoolbox-2.5.4/tests/ld/test_utils.py +0 -13
  50. h5rdmtoolbox-2.5.4/tests/repository/__init__.py +0 -0
  51. h5rdmtoolbox-2.5.4/tests/repository/test_zenodo.py +0 -743
  52. h5rdmtoolbox-2.5.4/tests/wrapper/__init__.py +0 -0
  53. h5rdmtoolbox-2.5.4/tests/wrapper/test_core.py +0 -994
  54. h5rdmtoolbox-2.5.4/tests/wrapper/test_dump.py +0 -77
  55. h5rdmtoolbox-2.5.4/tests/wrapper/test_file.py +0 -412
  56. h5rdmtoolbox-2.5.4/tests/wrapper/test_h5ext.py +0 -22
  57. h5rdmtoolbox-2.5.4/tests/wrapper/test_lazy.py +0 -62
  58. h5rdmtoolbox-2.5.4/tests/wrapper/test_namespaces.py +0 -46
  59. h5rdmtoolbox-2.5.4/tests/wrapper/test_xr2df.py +0 -41
  60. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/LICENSE +0 -0
  61. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/__init__.py +0 -0
  62. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/_cfg.py +0 -0
  63. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/_repr.py +0 -0
  64. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/_version.py +0 -0
  65. {h5rdmtoolbox-2.5.4/h5rdmtoolbox/extensions → h5rdmtoolbox-2.6.1/h5rdmtoolbox/catalog/stores}/__init__.py +0 -0
  66. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/cli.py +0 -0
  67. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/consts.py +0 -0
  68. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/__init__.py +0 -0
  69. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/cfg.py +0 -0
  70. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/consts.py +0 -0
  71. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/core.py +0 -0
  72. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/errors.py +0 -0
  73. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/generate.py +0 -0
  74. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/ontology/__init__.py +0 -0
  75. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/ontology/h5ontocls.py +0 -0
  76. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/ontology/hdf_datatypes.py +0 -0
  77. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/references.py +0 -0
  78. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/standard_attributes.py +0 -0
  79. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/toolbox_validators.py +0 -0
  80. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/convention/utils.py +0 -0
  81. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/data/def_icon.png +0 -0
  82. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/data/fluid-v1.yml +0 -0
  83. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/data/h5tbx.yaml +0 -0
  84. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/data/id_icon.png +0 -0
  85. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/data/iri_icon.png +0 -0
  86. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/data/ld_icon.png +0 -0
  87. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/data/piv-v1.yml +0 -0
  88. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/data/style.css +0 -0
  89. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/data/tutorial_convention.yaml +0 -0
  90. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/data/tutorial_standard_name_table.yaml +0 -0
  91. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/data/type_icon.png +0 -0
  92. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/database/__init__.py +0 -0
  93. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/database/hdfdb/__init__.py +0 -0
  94. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/database/hdfdb/filedb.py +0 -0
  95. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/database/hdfdb/objdb.py +0 -0
  96. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/database/hdfdb/query.py +0 -0
  97. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/database/hdfdb/utils.py +0 -0
  98. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/database/interface.py +0 -0
  99. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/database/lazy.py +0 -0
  100. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/database/mongo.py +0 -0
  101. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/errors.py +0 -0
  102. {h5rdmtoolbox-2.5.4/h5rdmtoolbox/gui → h5rdmtoolbox-2.6.1/h5rdmtoolbox/extensions}/__init__.py +0 -0
  103. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/extensions/magnitude.py +0 -0
  104. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/extensions/normalize.py +0 -0
  105. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/extensions/onto.py +0 -0
  106. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/extensions/units.py +0 -0
  107. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/extensions/vector.py +0 -0
  108. {h5rdmtoolbox-2.5.4/h5rdmtoolbox/gui/src → h5rdmtoolbox-2.6.1/h5rdmtoolbox/gui}/__init__.py +0 -0
  109. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/gui/fairify.py +0 -0
  110. {h5rdmtoolbox-2.5.4/h5rdmtoolbox/ld/hdf → h5rdmtoolbox-2.6.1/h5rdmtoolbox/gui/src}/__init__.py +0 -0
  111. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/gui/src/main.py +0 -0
  112. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/identifiers.py +0 -0
  113. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/layout/__init__.py +0 -0
  114. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/layout/core.py +0 -0
  115. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/__init__.py +0 -0
  116. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/globals.py +0 -0
  117. {h5rdmtoolbox-2.5.4/h5rdmtoolbox/ld/user → h5rdmtoolbox-2.6.1/h5rdmtoolbox/ld/hdf}/__init__.py +0 -0
  118. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/hdf/file.py +0 -0
  119. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/hdf/groups.py +0 -0
  120. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/rdf.py +0 -0
  121. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/shacl.py +0 -0
  122. {h5rdmtoolbox-2.5.4/h5rdmtoolbox/wrapper/accessors → h5rdmtoolbox-2.6.1/h5rdmtoolbox/ld/user}/__init__.py +0 -0
  123. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/user/attributes.py +0 -0
  124. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/user/datasets.py +0 -0
  125. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/user/file.py +0 -0
  126. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/user/utils.py +0 -0
  127. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/ld/utils.py +0 -0
  128. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/plotting.py +0 -0
  129. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/protected_attributes.py +0 -0
  130. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/protocols.py +0 -0
  131. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/repository/__init__.py +0 -0
  132. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/repository/default_metamapper.py +0 -0
  133. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/repository/interface.py +0 -0
  134. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/repository/zenodo/__init__.py +0 -0
  135. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/repository/zenodo/metadata.py +0 -0
  136. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/repository/zenodo/tokens.py +0 -0
  137. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/repository/zenodo/utils.py +0 -0
  138. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/tutorial.py +0 -0
  139. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/user.py +0 -0
  140. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/utils.py +0 -0
  141. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/wrapper/__init__.py +0 -0
  142. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/wrapper/accessor.py +0 -0
  143. {h5rdmtoolbox-2.5.4/tests → h5rdmtoolbox-2.6.1/h5rdmtoolbox/wrapper/accessors}/__init__.py +0 -0
  144. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/wrapper/accessors/provenance.py +0 -0
  145. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/wrapper/core.py +0 -0
  146. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/wrapper/ds_decoder.py +0 -0
  147. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/wrapper/h5attr.py +0 -0
  148. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/wrapper/h5ext.py +0 -0
  149. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/wrapper/h5utils.py +0 -0
  150. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/wrapper/h5yaml.py +0 -0
  151. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/wrapper/jsonld.py +0 -0
  152. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox/wrapper/xr2hdf.py +0 -0
  153. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox.egg-info/dependency_links.txt +0 -0
  154. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/h5rdmtoolbox.egg-info/entry_points.txt +0 -0
  155. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/tests/test_cli.py +0 -0
  156. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/tests/test_config.py +0 -0
  157. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/tests/test_extensions.py +0 -0
  158. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/tests/test_identifiers.py +0 -0
  159. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/tests/test_plotting.py +0 -0
  160. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/tests/test_repr.py +0 -0
  161. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/tests/test_user.py +0 -0
  162. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/tests/test_utils.py +0 -0
  163. {h5rdmtoolbox-2.5.4 → h5rdmtoolbox-2.6.1}/tests/test_xarray_export.py +0 -0
@@ -1,16 +1,19 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: h5rdmtoolbox
3
- Version: 2.5.4
3
+ Version: 2.6.1
4
4
  Summary: Supporting a FAIR Research Data lifecycle using Python and HDF5.
5
- Home-page: https://h5rdmtoolbox.readthedocs.io/en/latest/
6
- Author: Matthias Probst
7
- Author-email: matth.probst@gmail.com
5
+ Author-email: Matthias Probst <matth.probst@gmail.com>
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://h5rdmtoolbox.readthedocs.io/en/latest/
8
+ Project-URL: Documentation, https://h5rdmtoolbox.readthedocs.io/en/latest/
9
+ Project-URL: Repository, https://github.com/matthiasprobst/h5rdmtoolbox
10
+ Project-URL: Bug Tracker, https://github.com/matthiasprobst/h5rdmtoolbox/issues
11
+ Keywords: hdf5,research data,fair,metadata
8
12
  Classifier: Programming Language :: Python :: 3.9
9
13
  Classifier: Programming Language :: Python :: 3.10
10
14
  Classifier: Programming Language :: Python :: 3.11
11
15
  Classifier: Programming Language :: Python :: 3.12
12
16
  Classifier: Programming Language :: Python :: 3.13
13
- Classifier: License :: OSI Approved :: MIT License
14
17
  Classifier: Operating System :: OS Independent
15
18
  Classifier: Development Status :: 4 - Beta
16
19
  Classifier: Topic :: Scientific/Engineering
@@ -29,7 +32,7 @@ Requires-Dist: pint>=0.24.4
29
32
  Requires-Dist: pint_xarray<=0.6.0,>=0.2.1
30
33
  Requires-Dist: regex>=2020.7.9
31
34
  Requires-Dist: packaging>=24.1
32
- Requires-Dist: ontolutils<1.0.0,>=0.25.1
35
+ Requires-Dist: ontolutils<0.28.0,>=0.27.5
33
36
  Requires-Dist: python-forge==18.6.0
34
37
  Requires-Dist: requests>=2.32.4
35
38
  Requires-Dist: pydantic~=2.8
@@ -48,119 +51,33 @@ Requires-Dist: xmltodict<=0.13.0; extra == "snt"
48
51
  Requires-Dist: tabulate<=0.9.0,>=0.8.10; extra == "snt"
49
52
  Requires-Dist: python-gitlab; extra == "snt"
50
53
  Requires-Dist: pypandoc>=1.11; extra == "snt"
54
+ Provides-Extra: catalog
55
+ Requires-Dist: SPARQLWrapper>=2.0.0; extra == "catalog"
51
56
  Provides-Extra: gui
52
57
  Requires-Dist: PyQt5==5.15.10; extra == "gui"
58
+ Provides-Extra: test-core
59
+ Requires-Dist: toml>0.10.0; extra == "test-core"
60
+ Requires-Dist: pytest>=8.3.3; extra == "test-core"
61
+ Requires-Dist: pytest-cov>=5.0.0; extra == "test-core"
62
+ Requires-Dist: pylint; extra == "test-core"
63
+ Requires-Dist: ssnolib<3.0.0,>=2.2.0.2; extra == "test-core"
64
+ Requires-Dist: mongomock==4.1.2; extra == "test-core"
65
+ Requires-Dist: scipy>=1.10.1; extra == "test-core"
66
+ Requires-Dist: scikit-image>=0.21.0; extra == "test-core"
67
+ Requires-Dist: scikit-learn; extra == "test-core"
53
68
  Provides-Extra: test
54
- Requires-Dist: pytest>=8.3.3; extra == "test"
55
- Requires-Dist: pytest-cov>=5.0.0; extra == "test"
56
- Requires-Dist: pylint; extra == "test"
57
- Requires-Dist: ssnolib<3.0.0,>=2.2.0.2; extra == "test"
58
- Requires-Dist: mongomock==4.1.2; extra == "test"
59
- Requires-Dist: xmltodict<=0.13.0; extra == "test"
60
- Requires-Dist: scipy>=1.10.1; extra == "test"
61
- Requires-Dist: scikit-image>=0.21.0; extra == "test"
62
- Requires-Dist: scikit-learn; extra == "test"
63
- Requires-Dist: pandas>=1.4.3; extra == "test"
64
- Requires-Dist: xmltodict<=0.13.0; extra == "test"
65
- Requires-Dist: tabulate<=0.9.0,>=0.8.10; extra == "test"
66
- Requires-Dist: python-gitlab; extra == "test"
67
- Requires-Dist: pypandoc>=1.11; extra == "test"
68
- Requires-Dist: pymongo<=4.10.1,>=4.2.0; extra == "test"
69
+ Requires-Dist: h5rdmtoolbox[catalog,csv,database,snt,test-core]; extra == "test"
69
70
  Provides-Extra: docs
70
- Requires-Dist: pandas>=1.4.3; extra == "docs"
71
- Requires-Dist: xmltodict<=0.13.0; extra == "docs"
72
- Requires-Dist: tabulate<=0.9.0,>=0.8.10; extra == "docs"
73
- Requires-Dist: python-gitlab; extra == "docs"
74
- Requires-Dist: pypandoc>=1.11; extra == "docs"
75
- Requires-Dist: pymongo<=4.10.1,>=4.2.0; extra == "docs"
76
- Requires-Dist: pytest>=8.3.3; extra == "docs"
77
- Requires-Dist: pytest-cov>=5.0.0; extra == "docs"
78
- Requires-Dist: pylint; extra == "docs"
79
- Requires-Dist: ssnolib<3.0.0,>=2.2.0.2; extra == "docs"
80
- Requires-Dist: mongomock==4.1.2; extra == "docs"
81
- Requires-Dist: xmltodict<=0.13.0; extra == "docs"
82
- Requires-Dist: scipy>=1.10.1; extra == "docs"
83
- Requires-Dist: scikit-image>=0.21.0; extra == "docs"
84
- Requires-Dist: scikit-learn; extra == "docs"
85
- Requires-Dist: pandas>=1.4.3; extra == "docs"
86
- Requires-Dist: xmltodict<=0.13.0; extra == "docs"
87
- Requires-Dist: tabulate<=0.9.0,>=0.8.10; extra == "docs"
88
- Requires-Dist: python-gitlab; extra == "docs"
89
- Requires-Dist: pypandoc>=1.11; extra == "docs"
90
- Requires-Dist: pymongo<=4.10.1,>=4.2.0; extra == "docs"
91
71
  Requires-Dist: Sphinx==8.0.0; extra == "docs"
92
72
  Requires-Dist: sphinx_book_theme==1.1.3; extra == "docs"
93
- Requires-Dist: sphinx-copybutton==0.5.2; extra == "docs"
94
- Requires-Dist: sphinx-design==0.6.1; extra == "docs"
95
- Requires-Dist: myst-nb==1.2.0; extra == "docs"
96
- Requires-Dist: sphinxcontrib-bibtex==2.6.3; extra == "docs"
97
- Requires-Dist: scikit-image>=0.21.0; extra == "docs"
98
- Requires-Dist: scikit-learn; extra == "docs"
73
+ Requires-Dist: sphinx_copybutton==0.5.2; extra == "docs"
74
+ Requires-Dist: sphinx_design==0.6.1; extra == "docs"
75
+ Requires-Dist: myst_nb==1.2.0; extra == "docs"
76
+ Requires-Dist: sphinxcontrib_bibtex==2.6.3; extra == "docs"
99
77
  Provides-Extra: complete
100
- Requires-Dist: tabulate<=0.9.0,>=0.8.10; extra == "complete"
101
- Requires-Dist: PyQt5==5.15.10; extra == "complete"
102
- Requires-Dist: pytest>=8.3.3; extra == "complete"
103
- Requires-Dist: pytest-cov>=5.0.0; extra == "complete"
104
- Requires-Dist: pylint; extra == "complete"
105
- Requires-Dist: ssnolib<3.0.0,>=2.2.0.2; extra == "complete"
106
- Requires-Dist: mongomock==4.1.2; extra == "complete"
107
- Requires-Dist: xmltodict<=0.13.0; extra == "complete"
108
- Requires-Dist: scipy>=1.10.1; extra == "complete"
109
- Requires-Dist: scikit-image>=0.21.0; extra == "complete"
110
- Requires-Dist: scikit-learn; extra == "complete"
111
- Requires-Dist: pandas>=1.4.3; extra == "complete"
112
- Requires-Dist: xmltodict<=0.13.0; extra == "complete"
113
- Requires-Dist: tabulate<=0.9.0,>=0.8.10; extra == "complete"
114
- Requires-Dist: python-gitlab; extra == "complete"
115
- Requires-Dist: pypandoc>=1.11; extra == "complete"
116
- Requires-Dist: pymongo<=4.10.1,>=4.2.0; extra == "complete"
78
+ Requires-Dist: h5rdmtoolbox[catalog,csv,database,gui,layout_validation,snt,test]; extra == "complete"
117
79
  Provides-Extra: complete-with-docs
118
- Requires-Dist: tabulate<=0.9.0,>=0.8.10; extra == "complete-with-docs"
119
- Requires-Dist: PyQt5==5.15.10; extra == "complete-with-docs"
120
- Requires-Dist: pytest>=8.3.3; extra == "complete-with-docs"
121
- Requires-Dist: pytest-cov>=5.0.0; extra == "complete-with-docs"
122
- Requires-Dist: pylint; extra == "complete-with-docs"
123
- Requires-Dist: ssnolib<3.0.0,>=2.2.0.2; extra == "complete-with-docs"
124
- Requires-Dist: mongomock==4.1.2; extra == "complete-with-docs"
125
- Requires-Dist: xmltodict<=0.13.0; extra == "complete-with-docs"
126
- Requires-Dist: scipy>=1.10.1; extra == "complete-with-docs"
127
- Requires-Dist: scikit-image>=0.21.0; extra == "complete-with-docs"
128
- Requires-Dist: scikit-learn; extra == "complete-with-docs"
129
- Requires-Dist: pandas>=1.4.3; extra == "complete-with-docs"
130
- Requires-Dist: xmltodict<=0.13.0; extra == "complete-with-docs"
131
- Requires-Dist: tabulate<=0.9.0,>=0.8.10; extra == "complete-with-docs"
132
- Requires-Dist: python-gitlab; extra == "complete-with-docs"
133
- Requires-Dist: pypandoc>=1.11; extra == "complete-with-docs"
134
- Requires-Dist: pymongo<=4.10.1,>=4.2.0; extra == "complete-with-docs"
135
- Requires-Dist: pandas>=1.4.3; extra == "complete-with-docs"
136
- Requires-Dist: xmltodict<=0.13.0; extra == "complete-with-docs"
137
- Requires-Dist: tabulate<=0.9.0,>=0.8.10; extra == "complete-with-docs"
138
- Requires-Dist: python-gitlab; extra == "complete-with-docs"
139
- Requires-Dist: pypandoc>=1.11; extra == "complete-with-docs"
140
- Requires-Dist: pymongo<=4.10.1,>=4.2.0; extra == "complete-with-docs"
141
- Requires-Dist: pytest>=8.3.3; extra == "complete-with-docs"
142
- Requires-Dist: pytest-cov>=5.0.0; extra == "complete-with-docs"
143
- Requires-Dist: pylint; extra == "complete-with-docs"
144
- Requires-Dist: ssnolib<3.0.0,>=2.2.0.2; extra == "complete-with-docs"
145
- Requires-Dist: mongomock==4.1.2; extra == "complete-with-docs"
146
- Requires-Dist: xmltodict<=0.13.0; extra == "complete-with-docs"
147
- Requires-Dist: scipy>=1.10.1; extra == "complete-with-docs"
148
- Requires-Dist: scikit-image>=0.21.0; extra == "complete-with-docs"
149
- Requires-Dist: scikit-learn; extra == "complete-with-docs"
150
- Requires-Dist: pandas>=1.4.3; extra == "complete-with-docs"
151
- Requires-Dist: xmltodict<=0.13.0; extra == "complete-with-docs"
152
- Requires-Dist: tabulate<=0.9.0,>=0.8.10; extra == "complete-with-docs"
153
- Requires-Dist: python-gitlab; extra == "complete-with-docs"
154
- Requires-Dist: pypandoc>=1.11; extra == "complete-with-docs"
155
- Requires-Dist: pymongo<=4.10.1,>=4.2.0; extra == "complete-with-docs"
156
- Requires-Dist: Sphinx==8.0.0; extra == "complete-with-docs"
157
- Requires-Dist: sphinx_book_theme==1.1.3; extra == "complete-with-docs"
158
- Requires-Dist: sphinx-copybutton==0.5.2; extra == "complete-with-docs"
159
- Requires-Dist: sphinx-design==0.6.1; extra == "complete-with-docs"
160
- Requires-Dist: myst-nb==1.2.0; extra == "complete-with-docs"
161
- Requires-Dist: sphinxcontrib-bibtex==2.6.3; extra == "complete-with-docs"
162
- Requires-Dist: scikit-image>=0.21.0; extra == "complete-with-docs"
163
- Requires-Dist: scikit-learn; extra == "complete-with-docs"
80
+ Requires-Dist: h5rdmtoolbox[complete,docs]; extra == "complete-with-docs"
164
81
  Dynamic: license-file
165
82
 
166
83
  # HDF5 Research Data Management Toolbox
@@ -168,34 +85,109 @@ Dynamic: license-file
168
85
  ![Tests](https://github.com/matthiasprobst/h5RDMtoolbox/actions/workflows/tests.yml/badge.svg)
169
86
  [![codecov](https://codecov.io/gh/matthiasprobst/h5RDMtoolbox/graph/badge.svg?token=IVG4AQEW47)](https://codecov.io/gh/matthiasprobst/h5RDMtoolbox)
170
87
  [![Documentation Status](https://readthedocs.org/projects/h5rdmtoolbox/badge/?version=latest)](https://h5rdmtoolbox.readthedocs.io/en/latest/?badge=latest)
88
+ [![PyPI version](https://badge.fury.io/py/h5RDMtoolbox.svg)](https://badge.fury.io/py/h5RDMtoolbox)
171
89
  ![pyvers](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)
172
90
 
173
- *Note, that the project is still under development!*
174
-
175
- The "HDF5 Research Data Management Toolbox" (h5RDMtoolbox) is a Python package supporting everybody who is working with
176
- HDF5 to achieve a sustainable data lifecycle which follows
177
- the [FAIR (Findable, Accessible, Interoperable, Reusable)](https://www.nature.com/articles/sdata201618)
178
- principles. It specifically supports the five main steps of *planning*, *collecting*, *analyzing*, *sharing* and
179
- *reusing* data. Please visit the [documentation](https://h5rdmtoolbox.readthedocs.io/en/latest/) for detailed
180
- information of try the [quickstart using colab](#quickstart).
181
-
182
- ## Highlights
183
-
184
- - Combining HDF5 and [xarray](https://docs.xarray.dev/en/stable/) to allow easy access to metadata and data during
185
- analysis and processing (
186
- see [here](https://h5rdmtoolbox.readthedocs.io/en/latest/gettingstarted/quickoverview.html#datasets-xarray-interface)).
187
- - Assigning [metadata with "globally unique and persistent identifiers"]() as required
188
- by [F1 of the FAIR principles](https://www.go-fair.org/fair-principles/f1-meta-data-assigned-globally-unique-persistent-identifiers/).
189
- This can be achieved by using [RDF triples](https://www.w3.org/RDF/), which removes "ambiguity in the meaning of your
190
- published data".
191
- - Define standard attributes through
192
- [conventions](https://h5rdmtoolbox.readthedocs.io/en/latest/userguide/convention/index.html) and enforce users to use
193
- certain attributes in their HDF5 files, such as units and a description, for example.
194
- - Upload HDF5 files directly
195
- to [repositories](https://h5rdmtoolbox.readthedocs.io/en/latest/userguide/repository/index.html)
196
- like [Zenodo](https://zenodo.org/)
197
- or [use them with noSQL databases](https://h5rdmtoolbox.readthedocs.io/en/latest/userguide/database/index.html) like
198
- [mongoDB](https://www.mongodb.com/).
91
+ A Python package that helps researchers achieve sustainable
92
+ [**FAIR (Findable, Accessible, Interoperable, Reusable)**](https://www.nature.com/articles/sdata201618) data management with HDF5 files. The toolbox provides a comprehensive
93
+ approach to the research data lifecycle through five main stages: **planning**, **collecting**, **analyzing**,
94
+ **sharing**, and **reusing** data.
95
+
96
+ > **Note**: This project is actively under development.
97
+
98
+
99
+
100
+
101
+ ## ✨ Quick Start
102
+
103
+
104
+ One of the core features of the toolbox and success factors for achieving FAIR data, is using semantic metadata.
105
+
106
+ Let's see how we can use RDF (semantic metadata) together with HDF5 files using the toolbox:
107
+
108
+ ```bash
109
+ # Install the package
110
+ pip install h5RDMtoolbox
111
+ ```
112
+
113
+ ```python
114
+ import h5rdmtoolbox as h5tbx
115
+ import rdflib
116
+ import numpy as np
117
+
118
+ # Create a new HDF5 file with semantic metadata
119
+ M4I = rdflib.Namespace("http://w3id.org/nfdi4ing/metadata4ing#")
120
+
121
+ # Create a new HDF5 file with FAIR metadata
122
+ with h5tbx.File("example.h5", "w") as h5:
123
+ h5.create_dataset("temperature", data=np.array([20, 21, 19, 22]))
124
+ h5.attrs["units", M4I.hasUnit] = "degree_Celsius"
125
+ h5.rdf["units"].object = "http://qudt.org/vocab/unit/DEG_C"
126
+ h5.attrs["description", "https://schema.org/description"] = "Room temperature measurements"
127
+
128
+ ttl = h5.serialize("ttl")
129
+
130
+ ```
131
+ The serialization in Turtle (ttl) is teh RDF serialization of the HDF5 data (without arrays):
132
+ ```ttl
133
+ @prefix hdf: <http://purl.allotrope.org/ontologies/hdf5/1.8#> .
134
+ @prefix m4i: <http://w3id.org/nfdi4ing/metadata4ing#> .
135
+ @prefix schema: <https://schema.org/> .
136
+ @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
137
+
138
+ hdf:H5T_INTEL_I64 a hdf:Datatype .
139
+
140
+ [] a hdf:File ;
141
+ hdf:rootGroup [ a hdf:Group ;
142
+ hdf:attribute [ a hdf:StringAttribute ;
143
+ hdf:data "Room temperature measurements" ;
144
+ hdf:name "description" ],
145
+ [ a hdf:StringAttribute ;
146
+ hdf:data "degree_Celsius" ;
147
+ hdf:name "units" ] ;
148
+ hdf:member [ a hdf:Dataset ;
149
+ hdf:dataspace [ a hdf:SimpleDataspace ;
150
+ hdf:dimension [ a hdf:DataspaceDimension ;
151
+ hdf:dimensionIndex 0 ;
152
+ hdf:size 4 ] ] ;
153
+ hdf:datatype hdf:H5T_INTEGER,
154
+ hdf:H5T_INTEL_I64 ;
155
+ hdf:layout hdf:H5D_CONTIGUOUS ;
156
+ hdf:maximumSize 4 ;
157
+ hdf:name "/temperature" ;
158
+ hdf:rank 1 ;
159
+ hdf:size 4 ] ;
160
+ hdf:name "/" ;
161
+ m4i:hasUnit <http://qudt.org/vocab/unit/DEG_C> ;
162
+ schema:description "Room temperature measurements" ] .
163
+ ```
164
+
165
+ [//]: # (The "HDF5 Research Data Management Toolbox" &#40;h5RDMtoolbox&#41; is a Python package supporting everybody who is working with)
166
+
167
+ [//]: # (HDF5 to achieve a sustainable data lifecycle which follows)
168
+
169
+ [//]: # (the [FAIR &#40;Findable, Accessible, Interoperable, Reusable&#41;]&#40;https://www.nature.com/articles/sdata201618&#41;)
170
+
171
+ [//]: # (principles. It specifically supports the five main steps of *planning*, *collecting*, *analyzing*, *sharing* and)
172
+
173
+ [//]: # (*reusing* data. Please visit the [documentation]&#40;https://h5rdmtoolbox.readthedocs.io/en/latest/&#41; for detailed)
174
+
175
+ [//]: # (information of try the [quickstart using colab]&#40;#quickstart&#41;.)
176
+
177
+
178
+ ## 🚀 Key Features
179
+
180
+ - **🔗 HDF5 + [Xarray](https://docs.xarray.dev/en/stable/) Integration**: Seamless access to metadata during data analysis with native xarray support
181
+ - **🏷️ Persistent Identifiers**: Assign globally unique identifiers using RDF triples for FAIR compliance
182
+ - **📋 Standardized Conventions**: Define and enforce community-specific metadata standards
183
+ - **☁️ Repository Integration**: Direct upload to Zenodo and other research repositories
184
+ - **🗄️ Database Support**: Use HDF5 files with MongoDB or native HDF5 databases
185
+ - **🔒 Semantic Enrichment**: Add RDF-based semantic meaning to your data
186
+ - **🌐 Catalog Integration**: Search and discover datasets through SPARQL-based catalogs
187
+
188
+
189
+ Find an example code in [![In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/matthiasprobst/h5RDMtoolbox/blob/main/docs/colab/quickstart.ipynb) or check out the
190
+ [📚 full Documentation](https://h5rdmtoolbox.readthedocs.io/en/latest/)
199
191
 
200
192
  ## Who is the package for?
201
193
 
@@ -204,7 +196,8 @@ For everybody, who is...
204
196
  - ... looking for a management approach for his or her data.
205
197
  - ... community has not yet established a stable convention.
206
198
  - ... working with small and big data, that fits into HDF5 files.
207
- - ... looking for an easy way to work with HDF5, especially through [Jupyter Notebooks](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html).
199
+ - ... looking for an easy way to work with HDF5, especially
200
+ through [Jupyter Notebooks](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html).
208
201
  - ... trying to integrate HDF5 with repositories and databases.
209
202
  - ... wishing to enrich data semantically with the RDF standard.
210
203
  - ... looking for a way to do all the above whiles not needing to learn a new syntax.
@@ -220,8 +213,9 @@ For everybody, who ...
220
213
  ## Package Architecture/structure
221
214
 
222
215
  The toolbox implements six modules, which are shown below. The numbers reference to their main usage in the stages in
223
- the data lifecycle above. The wrapper module implements the main interface between the user and the HDF5 file. It
224
- extends the features of the underlying `h5py` library. Some of the features are implemented in other modules, hence the
216
+ the data lifecycle shown [here](https://h5rdmtoolbox.readthedocs.io/en/latest/gettingstarted/index.html). The wrapper
217
+ module implements the main interface between the user and the HDF5 file. It
218
+ extends the features of the underlying `h5py` library. Some of the features are implemented in other modules, hence the
225
219
  wrapper module depends on the convention, database and linked data (ld) module.
226
220
 
227
221
  <a href="https://h5rdmtoolbox.readthedocs.io/en/latest/"><img src="docs/_static/h5tbx_modules.svg" alt="H5TBX modules" style="widht:600px;"></a>
@@ -242,6 +236,9 @@ Current implementation highlights in the modules:
242
236
  are implemented.
243
237
  - The **layout** module allows to define expectations on the internal layout (object names, location, attributes,
244
238
  properties) of HDF5 files.
239
+ - The **catalog** module allows interfacing to HDF5 and RDF data published on Zenodo. Via a catalog file, a providers
240
+ describe the data in various zenodo records they want to share. Through the catalog file, users can work with the
241
+ data without downloading the full HDF5 files first.
245
242
 
246
243
  ## Quickstart
247
244
 
@@ -264,7 +261,6 @@ package via pip:
264
261
 
265
262
  pip install h5RDMtoolbox
266
263
 
267
-
268
264
  ### Install from source:
269
265
 
270
266
  Developers may clone the repository and install the package from source. Clone the repository first:
@@ -3,34 +3,109 @@
3
3
  ![Tests](https://github.com/matthiasprobst/h5RDMtoolbox/actions/workflows/tests.yml/badge.svg)
4
4
  [![codecov](https://codecov.io/gh/matthiasprobst/h5RDMtoolbox/graph/badge.svg?token=IVG4AQEW47)](https://codecov.io/gh/matthiasprobst/h5RDMtoolbox)
5
5
  [![Documentation Status](https://readthedocs.org/projects/h5rdmtoolbox/badge/?version=latest)](https://h5rdmtoolbox.readthedocs.io/en/latest/?badge=latest)
6
+ [![PyPI version](https://badge.fury.io/py/h5RDMtoolbox.svg)](https://badge.fury.io/py/h5RDMtoolbox)
6
7
  ![pyvers](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)
7
8
 
8
- *Note, that the project is still under development!*
9
-
10
- The "HDF5 Research Data Management Toolbox" (h5RDMtoolbox) is a Python package supporting everybody who is working with
11
- HDF5 to achieve a sustainable data lifecycle which follows
12
- the [FAIR (Findable, Accessible, Interoperable, Reusable)](https://www.nature.com/articles/sdata201618)
13
- principles. It specifically supports the five main steps of *planning*, *collecting*, *analyzing*, *sharing* and
14
- *reusing* data. Please visit the [documentation](https://h5rdmtoolbox.readthedocs.io/en/latest/) for detailed
15
- information of try the [quickstart using colab](#quickstart).
16
-
17
- ## Highlights
18
-
19
- - Combining HDF5 and [xarray](https://docs.xarray.dev/en/stable/) to allow easy access to metadata and data during
20
- analysis and processing (
21
- see [here](https://h5rdmtoolbox.readthedocs.io/en/latest/gettingstarted/quickoverview.html#datasets-xarray-interface)).
22
- - Assigning [metadata with "globally unique and persistent identifiers"]() as required
23
- by [F1 of the FAIR principles](https://www.go-fair.org/fair-principles/f1-meta-data-assigned-globally-unique-persistent-identifiers/).
24
- This can be achieved by using [RDF triples](https://www.w3.org/RDF/), which removes "ambiguity in the meaning of your
25
- published data".
26
- - Define standard attributes through
27
- [conventions](https://h5rdmtoolbox.readthedocs.io/en/latest/userguide/convention/index.html) and enforce users to use
28
- certain attributes in their HDF5 files, such as units and a description, for example.
29
- - Upload HDF5 files directly
30
- to [repositories](https://h5rdmtoolbox.readthedocs.io/en/latest/userguide/repository/index.html)
31
- like [Zenodo](https://zenodo.org/)
32
- or [use them with noSQL databases](https://h5rdmtoolbox.readthedocs.io/en/latest/userguide/database/index.html) like
33
- [mongoDB](https://www.mongodb.com/).
9
+ A Python package that helps researchers achieve sustainable
10
+ [**FAIR (Findable, Accessible, Interoperable, Reusable)**](https://www.nature.com/articles/sdata201618) data management with HDF5 files. The toolbox provides a comprehensive
11
+ approach to the research data lifecycle through five main stages: **planning**, **collecting**, **analyzing**,
12
+ **sharing**, and **reusing** data.
13
+
14
+ > **Note**: This project is actively under development.
15
+
16
+
17
+
18
+
19
+ ## ✨ Quick Start
20
+
21
+
22
+ One of the core features of the toolbox and success factors for achieving FAIR data, is using semantic metadata.
23
+
24
+ Let's see how we can use RDF (semantic metadata) together with HDF5 files using the toolbox:
25
+
26
+ ```bash
27
+ # Install the package
28
+ pip install h5RDMtoolbox
29
+ ```
30
+
31
+ ```python
32
+ import h5rdmtoolbox as h5tbx
33
+ import rdflib
34
+ import numpy as np
35
+
36
+ # Create a new HDF5 file with semantic metadata
37
+ M4I = rdflib.Namespace("http://w3id.org/nfdi4ing/metadata4ing#")
38
+
39
+ # Create a new HDF5 file with FAIR metadata
40
+ with h5tbx.File("example.h5", "w") as h5:
41
+ h5.create_dataset("temperature", data=np.array([20, 21, 19, 22]))
42
+ h5.attrs["units", M4I.hasUnit] = "degree_Celsius"
43
+ h5.rdf["units"].object = "http://qudt.org/vocab/unit/DEG_C"
44
+ h5.attrs["description", "https://schema.org/description"] = "Room temperature measurements"
45
+
46
+ ttl = h5.serialize("ttl")
47
+
48
+ ```
49
+ The serialization in Turtle (ttl) is teh RDF serialization of the HDF5 data (without arrays):
50
+ ```ttl
51
+ @prefix hdf: <http://purl.allotrope.org/ontologies/hdf5/1.8#> .
52
+ @prefix m4i: <http://w3id.org/nfdi4ing/metadata4ing#> .
53
+ @prefix schema: <https://schema.org/> .
54
+ @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
55
+
56
+ hdf:H5T_INTEL_I64 a hdf:Datatype .
57
+
58
+ [] a hdf:File ;
59
+ hdf:rootGroup [ a hdf:Group ;
60
+ hdf:attribute [ a hdf:StringAttribute ;
61
+ hdf:data "Room temperature measurements" ;
62
+ hdf:name "description" ],
63
+ [ a hdf:StringAttribute ;
64
+ hdf:data "degree_Celsius" ;
65
+ hdf:name "units" ] ;
66
+ hdf:member [ a hdf:Dataset ;
67
+ hdf:dataspace [ a hdf:SimpleDataspace ;
68
+ hdf:dimension [ a hdf:DataspaceDimension ;
69
+ hdf:dimensionIndex 0 ;
70
+ hdf:size 4 ] ] ;
71
+ hdf:datatype hdf:H5T_INTEGER,
72
+ hdf:H5T_INTEL_I64 ;
73
+ hdf:layout hdf:H5D_CONTIGUOUS ;
74
+ hdf:maximumSize 4 ;
75
+ hdf:name "/temperature" ;
76
+ hdf:rank 1 ;
77
+ hdf:size 4 ] ;
78
+ hdf:name "/" ;
79
+ m4i:hasUnit <http://qudt.org/vocab/unit/DEG_C> ;
80
+ schema:description "Room temperature measurements" ] .
81
+ ```
82
+
83
+ [//]: # (The "HDF5 Research Data Management Toolbox" &#40;h5RDMtoolbox&#41; is a Python package supporting everybody who is working with)
84
+
85
+ [//]: # (HDF5 to achieve a sustainable data lifecycle which follows)
86
+
87
+ [//]: # (the [FAIR &#40;Findable, Accessible, Interoperable, Reusable&#41;]&#40;https://www.nature.com/articles/sdata201618&#41;)
88
+
89
+ [//]: # (principles. It specifically supports the five main steps of *planning*, *collecting*, *analyzing*, *sharing* and)
90
+
91
+ [//]: # (*reusing* data. Please visit the [documentation]&#40;https://h5rdmtoolbox.readthedocs.io/en/latest/&#41; for detailed)
92
+
93
+ [//]: # (information of try the [quickstart using colab]&#40;#quickstart&#41;.)
94
+
95
+
96
+ ## 🚀 Key Features
97
+
98
+ - **🔗 HDF5 + [Xarray](https://docs.xarray.dev/en/stable/) Integration**: Seamless access to metadata during data analysis with native xarray support
99
+ - **🏷️ Persistent Identifiers**: Assign globally unique identifiers using RDF triples for FAIR compliance
100
+ - **📋 Standardized Conventions**: Define and enforce community-specific metadata standards
101
+ - **☁️ Repository Integration**: Direct upload to Zenodo and other research repositories
102
+ - **🗄️ Database Support**: Use HDF5 files with MongoDB or native HDF5 databases
103
+ - **🔒 Semantic Enrichment**: Add RDF-based semantic meaning to your data
104
+ - **🌐 Catalog Integration**: Search and discover datasets through SPARQL-based catalogs
105
+
106
+
107
+ Find an example code in [![In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/matthiasprobst/h5RDMtoolbox/blob/main/docs/colab/quickstart.ipynb) or check out the
108
+ [📚 full Documentation](https://h5rdmtoolbox.readthedocs.io/en/latest/)
34
109
 
35
110
  ## Who is the package for?
36
111
 
@@ -39,7 +114,8 @@ For everybody, who is...
39
114
  - ... looking for a management approach for his or her data.
40
115
  - ... community has not yet established a stable convention.
41
116
  - ... working with small and big data, that fits into HDF5 files.
42
- - ... looking for an easy way to work with HDF5, especially through [Jupyter Notebooks](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html).
117
+ - ... looking for an easy way to work with HDF5, especially
118
+ through [Jupyter Notebooks](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html).
43
119
  - ... trying to integrate HDF5 with repositories and databases.
44
120
  - ... wishing to enrich data semantically with the RDF standard.
45
121
  - ... looking for a way to do all the above whiles not needing to learn a new syntax.
@@ -55,8 +131,9 @@ For everybody, who ...
55
131
  ## Package Architecture/structure
56
132
 
57
133
  The toolbox implements six modules, which are shown below. The numbers reference to their main usage in the stages in
58
- the data lifecycle above. The wrapper module implements the main interface between the user and the HDF5 file. It
59
- extends the features of the underlying `h5py` library. Some of the features are implemented in other modules, hence the
134
+ the data lifecycle shown [here](https://h5rdmtoolbox.readthedocs.io/en/latest/gettingstarted/index.html). The wrapper
135
+ module implements the main interface between the user and the HDF5 file. It
136
+ extends the features of the underlying `h5py` library. Some of the features are implemented in other modules, hence the
60
137
  wrapper module depends on the convention, database and linked data (ld) module.
61
138
 
62
139
  <a href="https://h5rdmtoolbox.readthedocs.io/en/latest/"><img src="docs/_static/h5tbx_modules.svg" alt="H5TBX modules" style="widht:600px;"></a>
@@ -77,6 +154,9 @@ Current implementation highlights in the modules:
77
154
  are implemented.
78
155
  - The **layout** module allows to define expectations on the internal layout (object names, location, attributes,
79
156
  properties) of HDF5 files.
157
+ - The **catalog** module allows interfacing to HDF5 and RDF data published on Zenodo. Via a catalog file, a providers
158
+ describe the data in various zenodo records they want to share. Through the catalog file, users can work with the
159
+ data without downloading the full HDF5 files first.
80
160
 
81
161
  ## Quickstart
82
162
 
@@ -99,7 +179,6 @@ package via pip:
99
179
 
100
180
  pip install h5RDMtoolbox
101
181
 
102
-
103
182
  ### Install from source:
104
183
 
105
184
  Developers may clone the repository and install the package from source. Clone the repository first: