Der GP Parser#

In einer Welt, in der das Datenvolumen, auch in der Wissenschaft, stetig steigt, ist es von hoher Relevanz Datensätze und deren Metadaten auf eine Art aufzubereiten, dass sie für Außenstehende klar verständlich sind. Hierfür wurden 2016 im Paper The FAIR Guiding Principles for scientific data management and stewardship erstmals die FAIR-Kriterien vorgestellt. Diese bieten Anhand unterschiedlicher Anforderungen einen Leitfaden, der Wissenschaftler*innen dabei hilft ihre wissenschaftlichen Erkenntnisse in einer Art aufzubereiten, die nachvollziehbar und wiederverwendbar ist.

Der sogenannte “GP Parser” ist ein Werkzeug, um die “FAIR”ifizierung des physikalischen Grundpraktikums voran zu treiben. Dabei liest der GP Parser die von den Studierenden identifizierten Metadaten aus, und erstellt eine JSON-Datei, die wiederum dem jeweiligen elektronischen Laborbuch hinzugefügt wird. Hintergrund des Erstellens der JSON-Datei ist, dass das Laborbuch, so wie es ohne JSON-Datei vom Parser vorliegt, zwar für einen Menschen, der Kontextdaten wie Durchführung und Anhänge verstehen kann, gut, für Maschinen aber schwer nachvollziehbar ist. Das JSON-Format ist, da es unabhängig von Programmiersprachen oder Betriebsystemen verwendbar ist, dafür also besonders geeignet.

Die Identifizierung der Metadaten und auch die Aufbereitung in der unten erläuterten Syntax dient dem Zweck, den Studierenden bezubringen über Metadaten nachzudenken, da ein Parser, der komplett automatisiert auslesen würde, didaktisch nutzlos wäre.

Für die Versuche “TK46 Elektronen als Teilchen und Welle, Luftfeuchte” “19/20 Elektronische Grundversuche”, “TK24 Elektrische Schwingungen” sowie “Cosmic Hunters” ist die Verwendung der Syntax und des Parsers verpflichtend.

Syntax#

Im Rahmen der FAIRifizierung der Experimente im GP müssen Metadaten zum jeweiligen Experiment ordentlich dokumentiert werden. Metadaten sind Daten, die Informationen über andere Daten enthalten und sind für eine die Organisation, Verwaltung und Auffindbarkeit von großer Bedeutung. Im Grundpraktikum identifizieren die Teilnehmenden die Metadaten selbständig und kennzeichnen diese durch die folgende Syntax in dem Durchführungsabschnitt:

{A; B; C; D}

Es handelt sich um eine einfache 4 × 1 Matrix, in der die Buchstaben als Platzhalter für Metadaten dienen, die für das durchgeführte Experiment von Bedeutung sind. Die Hierarche erfolgt von links nach rechts. Für den Parameter 𝐴 sollen die Begriffe Messmethode, Messinstrument, Messgröße, Aufbau, Probe und Software verwendet werden, die Einträge in den folgenden Spalten hängen von dem Eintrag der ersten Spalte ab. Mit diesen Kategorien können für die im Grundpraktikum durchgeführten Experimente alle Metadaten festgehalten werden. In Tabelle 1 ist eine schematische Übersicht für Metadaten dargestellt.

A

B

C

D

Messmethode

Bezeichnung der Messmethode

weitere Details

/

Messinstrument

Bezeichnung des Messinstruments

PermID

weitere Details

Aufbau

Materialien, Geräte

PermID

weitere Details

Probe

Probenbezeichnung

PermID

weitere Details

Messgröße

Name der Messgröße

Formelzeichen der Messgröße

Einheit der Messgröße

Software

Name der Software

Version

weitere Details

Es ist erkennbar, dass bei der Messmethode nur die ersten Einträge benötigt werden und dass keine PermID eingetragen werden muss. Es können optional weitere Details im dritten Eintrag notiert werden, um die Auffindbarkeit zu erhöhen und zu erleichtern. Beispiele: {Messmethode; Längenmessung}, {Messmethode; U-I-Kennlinie; Oszilloskop}

Im Grundpraktikum sind alle Messinstrumente, mit einer PermID versehen und alle nötigen Informationen zu den Messinstrumenten sind in openBIS hinterlegt. Zur Kennzeichnung wird der Begriff Messinstrument verwendet und anschließend die Bezeichnung des Messinstruments und die PermID eingetragen. Falls noch weitere Details zum Messinstrument erwähnt werden möchten, können diese in die Spalte nach der PermID eingetragen werden. Beispiele: {Messinstrument; Lineal; PermID}, {Messinstrument; Waage; PermID; digital}

Gleiches gilt auch für die zum Aufbau verwendeten Materialien oder Geräte und die untersuchten Proben. Falls Proben zum Experimentieren mitgebracht wurden und somit keine PermID besitzen, sind diese mit NoPermID zu kennzeichnen und sollen in der Durchführung möglichst genau erläutert werden. Es kann sein, dass ein Bauteil in einem Experiment als Probe verwendet wird und in einem anderen in dem Aufbau verwendet wird (z.B. Widerstände). Beispiel: {Aufbau; Stab; PermID}, {Probe; Gewicht; PermID}, {Probe; Seil; NoPermID}

Bei Messgrößen wird keine PermID benötigt. In der zweiten Spalte der Matrix wird der Name der Messgröße und in der dritten Spalte das SI-Formelzeichen notiert. Griechische Formelzeichen werden als Wörter ausgeschrieben. In der vierten Spalte wird die SI-Einheit angegeben. Dabei wird auf Einheitenpräfixe verzichtet und die exponentielle Schreibweise verwendet. D.h., dass sich beispielsweise für „millli“ eine -3 und für „kilo“ eine +3 nach der SI-Einheit eingetragen wird. Bei der Software soll die Version festgehalten werden, um die Reproduzierbarkeit zu gewährleisten. Beispiele: {Messgröße; Länge; l; m-3}, {Messgröße; Masse; m; kg-3}, {Messgröße; Dichte; rho; kg/m^3}, {Software; CassyLab; 2.1}

Anwendungsbeispiel der Syntax und des Parsers#

../_images/BeispielSyntax.png

Die Studierenden können ihre Durchführung ganz normal formulieren und dann die oben gezeigte Syntax anwenden. Neben dem Ziel das Laborbuch “FAIR”er zu machen, ist ein weiteres Ziel den Studierenden beizubringen über Metadaten nach zu denken und ihnen im Laufe des Praktikums einen Blick dafür zu geben, was relevante Metadaten sind. Im gezeigten Beispiel lässt sich erkennen, dass die verwendeten Bauteile wie die Waage, der Draht, der Stab usw. relevante Metadaten sind. Nachdem die Studierenden ihre Metadaten in die entsprechende Syntax gebracht haben und das Laborbuch einmal gespeichert haben, können sie oben in der Menüleiste den Knopf “GP Parser” anklicken, der in einem neuen Tab eine Seite öffnet. Dabei wird ein Session-Token übertragen, welches dem Parser erlaubt, die OpenBis Sitzung zuzuordnen.

../_images/ParserButton.jpeg

Die Startseite des Parsers informiert kurz über die Big-Data Problematik. Auf der Parser-Webseite befindet sich links eine ausklappbare Menüleiste, deren ersten Einträge über Metadaten im Allgemeinen sowie die einzelnen Aspekte des FAIR Acronyms ausführlich informieren und Beispiele aufzeigen, wie im Grundpraktikum die FAIR Prinzipien angewendet werden. In der Seitenleiste befindet sich auch der GP Parser selbst, der über einen klick aufgerufen werden kann.

../_images/Parser_Sidebar.png

Um den Parser anwenden zu können, muss zuerst eine .txt-Datei erstellt werden, in die die Metadaten in der entsprechenden Syntax aus der Durchführung reinkopiert werden. Auf der Parserseite tragen die Studierenden dann die PermID ihres Laborbuches, welche Sie in ihrem Laborbuch unter “Identification Info” finden, in das vorgesehende Feld ein und füllen die weiteren Felder, also Name, Datum usw. ebenfalls aus. Durch klicken des “Upload and Parse”-Knopfes, lässt sich die zuvor gespeicherte .txt-Datei hochladen. Der Parser durchsucht diese dann nach der Syntax und gibt die Metadaten zuerst im “JSON Vorschau” Feld aus.

../_images/parserfertig1.png

Das Feld dient dazu den Studierenden die Möglichkeit zu geben noch einmal ihre Metadaten auf Richtigkeit zu überprüfen. Sind alle relevanten Metadaten vorhanden? Sind die Metadaten richtig? Wenn Metadaten gar nicht oder nicht richtig ausgegeben werden lohnt es sich meist zu erst zu überprüfen, ob irgendwo ein Tippfehler vorliegt, da der Parser falsch geschriebene Wörter nicht finden kann. Generell lohnt es sich immer die folgenden Dinge zu überprüfen, wenn es bei der Ausgabe der JSON-Datei Probleme gibt:

  • Rechtschreibfehler bei den Bezeichnungen Messmethode, Messinstrument, Aufbau, Probe, Messgröße oder Software

  • Vergessen das Keyword zu nennen

  • Reihenfolger innerhalb der geschweiften Klammern falsch

  • Anstelle von “ ; “ wurde ein “ , “ oder “ : “ verwendet

  • Geschweifte “ {} “ Klammer(n) vergessen

Allgemein treten manchmal bei OpenBis Bugs auf, die sich durch das neu Laden der Seite oder aus- und erneutem einloggen beheben lassen. Wenn die Vorschau der JSON-Datei richtig aussieht, wird diese heruntergeladen und mit einem aussagekräftigen Namen versehen. Die JSON Datei wird dann mit den Versuchsdaten auf OpenBis über das Upload Feld hochgeladen.

Zuletzt befindet sich in der Seitenleiste als Menüpunkt die Hilfeseite mit nützlichen Links bei Problemen.