artiq icon indicating copy to clipboard operation
artiq copied to clipboard

Save custom groups in h5py data file

Open Deepskyhunter opened this issue 1 year ago • 1 comments

ARTIQ Pull Request

Description of Changes

Custom attributes stored in dictionary can be passed to Dataset Manager by `save_custom_groups"

Notes:

  • If there is dictionary inside the dictionary, it will create a sub-group for it.
  • Calling this function second time will replace the previous dictionary

Related Issue #1691

Type of Changes

Type
:bug: Bug fix
:sparkles: New feature
:hammer: Refactoring
:scroll: Docs

Steps (Choose relevant, delete irrelevant before submitting)

All Pull Requests

  • [x] Use correct spelling and grammar.
  • [ ] Update RELEASE_NOTES.rst if there are noteworthy changes, especially if there are changes to existing APIs.
  • [x] Close/update issues.

Code Changes

  • [x] Run flake8 to check code style (follow PEP-8 style). flake8 has issues with parsing Migen/gateware code, ignore as necessary.
  • [x] Test your changes or have someone test them. Mention what was tested and how.
  • [ ] Add and check docstrings and comments
  • [ ] Check, test, and update the unittests in /artiq/test/ or gateware simulations in /artiq/gateware/test

Documentation Changes

  • [ ] Check, test, and update the documentation in doc/. Build documentation (cd doc/manual/; make html) to ensure no errors.

Git Logistics

  • [x] Split your contribution into logically separate changes (git rebase --interactive). Merge/squash/fixup commits that just fix or amend previous commits. Remove unintended changes & cleanup. See tutorial.
  • [x] Write short & meaningful commit messages. Review each commit for messages (git show). Format:
    topic: description. < 50 characters total.
    
    Longer description. < 70 characters per line
    

Licensing

See copyright & licensing for more info. ARTIQ files that do not contain a license header are copyrighted by M-Labs Limited and are licensed under LGPLv3+.

Deepskyhunter avatar Aug 16 '22 02:08 Deepskyhunter

Doesn't seem like a well thought-through API.

sbourdeauducq avatar Aug 24 '22 08:08 sbourdeauducq