Skip to content

Commit

Permalink
strikter separation between modules
Browse files Browse the repository at this point in the history
- remove `skipND` from being deprecated
- separation of "linked data" code into a separate repo
- update documentation
  • Loading branch information
matthiasprobst authored Feb 27, 2025
1 parent d731c2f commit 1ae4ae8
Show file tree
Hide file tree
Showing 62 changed files with 3,304 additions and 7,791 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Log of changes in the versions

## v1.7.2

- remove `skipND` from being deprecated
- separation of "linked data" code into a separate repo
- update documentation

## v1.7.1

- fix documentation at readthedocs
Expand Down
6 changes: 3 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ authors:
given-names: "Lucas"
orcid: "https://orcid.org/0000-0002-4116-0065"
title: "h5rdmtoolbox - HDF5 Research Data Management Toolbox"
version: 1.7.1
doi: 10.5281/zenodo.14910043
date-released: 2024-02-22
version: 1.7.2
doi: 10.5281/zenodo.14938907
date-released: 2024-02-27
url: "/~https://github.com/matthiasprobst/h5rdmtoolbox"
11 changes: 11 additions & 0 deletions PLANNED_CHANGES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Planned changes

## v1.8.0

- remove `skipND` and replace with `serialize_0d_datasets`, which only supports serialization of 0D datasets
- remove `resolve_keys` from `dump_jsonld()` and `serialize()`
- remove `semantic` from `dump_jsonld()` and `serialize()`

## v2.0.0

- remove `dump_jsonld()` and only use `serialize()`
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,10 @@ For everybody, who ...

## Package Architecture/structure

The toolbox implements five modules, which are shown below. The numbers reference to their main usage in the stages in
the data lifecycle above. Except the wrapper module, which uses the convention module, all other modules are independent
of each other.
The toolbox implements six modules, which are shown below. The numbers reference to their main usage in the stages in
the data lifecycle above. The wrapper module implements the main interface between the user and the HDF5 file. It
extends the features of the underlying `h5py` library. Some of the features are implemented in other modules, hence the
wrapper module depends on the convention, database and linked data (ld) module.

<a href="https://h5rdmtoolbox.readthedocs.io/en/latest/"><img src="docs/_static/h5tbx_modules.svg" alt="H5TBX modules" style="widht:600px;"></a>

Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"license": "https://spdx.org/licenses/MIT",
"codeRepository": "git+/~https://github.com/matthiasprobst/h5RDMtoolbox.git",
"name": "h5RDMtoolbox",
"version": "1.7.1",
"version": "1.7.2",
"description": "Supporting a FAIR Research Data lifecycle using Python and HDF5.",
"applicationCategory": "Engineering",
"programmingLanguage": [
Expand Down
Loading

0 comments on commit 1ae4ae8

Please sign in to comment.