Electronic Lab Documentation (E-Logbook) at HZDR
E-Labbook Community
Mediawiki
Source: Von Serhio Magpie - Eigenes Werk, CC BY-SA 4.0, https://commons.wikimedia.org/w/index.php?curid=96604531
- More communication/knowledge sharing via Mattermost
- Resume regular meetings with community members
- Documentation for the community:
- Expand the example experiment ELN with as many example functionalities as possible
- FAQ: Documentation for common questions
- Onbording: Documentation pages, video tutorial, regular workshops
- Instance specific documentation
- Bringing the "Mwclient tools" for forms development developed for our community up to good standards in terms of software development best practices, e.g.
- Tests
- Packaging (setuptools, poetry, ...) instead of installation scripts
- Help texts in the software instead of Markdown documents in the repo
- LICENSE is missing
- Poster for events
General Todos / Maintainance
ELN_Beispiel_Mediawiki
Bild: Dr. Gruber, Thomas
- Task management using gitlab issues, interface between community and IT department
- Creation of lab books for users (at least 2 weeks per user/group)
- Continuous development of Mwclient_tools by adding functionalities for the ELN forms of the community users
- Keep Mediawiki source code up to date, regular updates
- Continuous extension of the example lab book to show the functional range
- Extension of the sample scripts
Roadmap
- Export of specific metadata to SciCat offers possibility for
- Selection of which datasets to publish
- Restructuring of metadata or introduction of a metadata standard
- Optimize for sample database
- Test of Open Semantic Lab, which enables, among other things:
- define forms as JSON schema
- obtain metadata directly as JSON
- set graph relationships
- Device database:
- Integration of HardwareDB (important metadata is stored and read out in HardwareDB)
- Creation of devices from already existing lists
- Create automatic CMS pages for "public" devices
- Extend with large devices
- CMS - landing page
- DOI registration
- XML/JSON metadata export for DataCite
- Evaluate versioning of large devices
- Sample scripts for specific use cases:
- Creating/updating mediawiki page (automation) with python or Labview
- reading metadata for data processing for e.g. python
- Move/migration from Athene server to Wiki server
- Have personal data populated through LDAP
- Make QR scanner software more configurable to make it more usable for other community members, including documentation.
- Report function (create pdf files as summary of multiple measurements). Possible variations:
- Through a template in Mediawiki (e.g. for short/single experiments).
- Through a script or Heliport (e.g. for a whole project)
- Linking with Heliport
- Transfer (both directions) of selected metadata, e.g. for workflows
- Readout of whole projects with selection for report or rodare
- Test multiple editability on one page