Compare commits

...
Sign in to create a new pull request.

2 commits

Author SHA1 Message Date
556a688a38 english version 2019-03-25 20:12:33 +01:00
f9b53d0162 Version für Vorstellung an der Uni Rostock 2019-03-25 17:58:27 +01:00
4 changed files with 129 additions and 104 deletions

View file

@ -1,3 +1,3 @@
# elabftw_hhzi_2018 # elabftw_slides_2019
Vorstellung von eLabFTW auf dem Helmholtz Open Science Workshop „Elektronische Laborbücher“, 13./14.09.2018 Vorstellung von eLabFTW an der Universität Rostock: IRTG Lecture Series -- "Thementag Elektronische Laborbücher" / 26.03.2019

BIN
img/anachronismus_1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

View file

@ -10,16 +10,16 @@
\usetheme{metropolis} \usetheme{metropolis}
\metroset{block=fill} \metroset{block=fill}
\setdefaultlanguage[variant=german, \setdefaultlanguage[variant=usmax]{english}
spelling=new, \setotherlanguage[variant=german,
latesthyphen=true]{german} spelling=new,
\setotherlanguage[variant=usmax]{english} latesthyphen=true]{german}
\title{eLabFTW} \title{eLabFTW}
\subtitle{Das freie elektronische Laborjournal} \subtitle{Free Electronic Lab Notebook}
\author[Alexander Minges]{\includegraphics[width=0.2\textwidth]{img/elabftw-logo-small.pdf}\\Alexander Minges} \author[Alexander Minges]{\includegraphics[width=0.2\textwidth]{img/elabftw-logo-small.pdf}\\Alexander Minges}
\institute[Biochemische Pflanzenphysiologie]{Institut für Biochemische Pflanzenphysiologie\\Heinrich-Heine-Universität Düsseldorf} \institute[Biochemical Plant Physiology]{Institute of Biochemical Plant Physiology\\Heinrich Heine University Düsseldorf}
\date{\scriptsize Helmholtz Open Science Workshop „Elektronische Laborbücher“\\13. September 2018} \date{\scriptsize \textquote{Thementag Elektronische Laborbücher}\\26. March 2019 -- University of Rostock}
\hypersetup{pdfauthor={Alexander Minges}} \hypersetup{pdfauthor={Alexander Minges}}
@ -34,54 +34,68 @@
\maketitle \maketitle
\section{Einführung} \section{Introduction}
\begin{frame} \begin{frame}
\frametitle{Was ist eLabFTW?} \frametitle{What is eLabFTW?}
eLabFTW ist ein generisches elektronisches Laborjournal (ELN) eLabFTW is a generic electronic lab notebook (ELN)
\pause \pause
\begin{itemize} \begin{itemize}
\item Offene und freie Software (GNU AGPL 3.0~\includegraphics[height=1.0em]{img/AGPLv3_Logo.pdf})\pause \item Free and open-source software (GNU AGPL 3.0~\includegraphics[height=1.0em]{img/AGPLv3_Logo.pdf})\pause
\item Gemeinschaftliche Entwicklung durch \\ Freiwillige -- von Wissenschaftlern, für Wissenschaftler\pause \item Community-driven development -- by scientists, \\for scientists\pause
\item Browser basierte Benutzeroberfläche, kompatibel mit allen gängigen Browsern und (Mobil-) Geräten\pause \item Browser-based user interface compatible with all commonly used browsers and (mobile) devices\pause
\item Übersetzt in verschiedene Sprachen \item Multilingual
\end{itemize} \end{itemize}
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Was ist eLabFTW?} \frametitle{What is eLabFTW?}
\begin{center} \begin{center}
\large eLabFTW ist eine freie und offene Software (FLOSS) \large eLabFTW is free and open-source software (FLOSS)
\end{center} \end{center}
\pause \pause
\begin{description} \begin{description}
\item[Frei wie in \textquote{Freibier}] eLabFTW ist jederzeit \textbf{kostenlos} verfügbar \item[Free as in \textquote{beer}] eLabFTW is (and will always be) \\available \textbf{free of charge}
\item[Frei wie in \textquote{Freiheit}] der \textbf{Quelltext} steht offen zur Verfügung, kann \textbf{angepasst, verändert und weiterverbreitet} werden \item[Free as in \textquote{freedom of speech}] Its \textbf{source code} is available and can be \textbf{adjusted, changed and freely distributed}
\end{description} \end{description}
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Eine kurze Historie} \frametitle{Why electronic lab notebooks?}
\begin{center}
\large Hand-written lab notebooks are anachronistic\ldots
\end{center}
\pause
\begin{figure}
\centering
\includegraphics[width=0.75\textwidth]{img/anachronismus_1.png}
\blfootnote{Dirnagl \& Przesdzing 2016 (doi: 10.12688/f1000research.7628.1)}
\end{figure}
\end{frame}
\begin{frame}
\frametitle{A brief history of eLabFTW}
\Huge\faClock\normalsize \Huge\faClock\normalsize
\begin{description} \begin{description}
\item[2012] Initiiert von Nicolas Carpi am \emph{Institut Pasteur} \item[2012] Initiated by Nicolas Carpi at the \emph{Institut Curie}
\item[Feb. 2013] Erste veröffentlichte Version (0.7.0) \item[Feb. 2013] First public version (0.7.0)
\item[2018] Offiziell durch das \emph{Institut Curie} unterstütztes Softwareprojekt \item[2018] Announced as an officially supported software project by the \emph{Institut Curie}
\item[Aug. 2018] Veröffentlichung der aktuellen stabilen Version 2.0 \item[Aug. 2018] Current major version 2.0 released
\item[Vorgestern] Bugfix-Release 2.0.1 \item[Mar. 2019] Feature preview 2.1.0-alpha
\end{description} \end{description}
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{eLabFTW arbeitet platformunabhängig} \frametitle{eLabFTW is platform independent}
\begin{center} \begin{center}
\Huge\faPhp\hspace{1em}\faDatabase\hspace{1em}\faServer \Huge\faPhp\hspace{1em}\faDatabase\hspace{1em}\faServer
\end{center} \end{center}
\begin{itemize} \begin{itemize}
\item Installation auf zentralem \textbf{Server} (Webserver + PHP + MySQL/MariaDB) \item Installation on a \textbf{server} (Webserver + PHP + MySQL/MariaDB)
\item Zugriff über \textbf{Webbrowser} auf Endgeräten (Desktop, Notebook, Tablet, Smartphone) \item Access via \textbf{web browser} on many different clients (desktop, notebook, tablet, smartphone)
\item \textbf{Keine Installation spezieller Software} auf dem Client nötig, keine Bindung an bestimmte \textbf{Betriebssysteme} \item \textbf{No client software} needed
\item No dependency on specific \textbf{operating systems}
\end{itemize} \end{itemize}
\begin{center} \begin{center}
@ -92,17 +106,17 @@
\begin{frame} \begin{frame}
\frametitle{eLabFTW wird weltweit eingesetzt} \frametitle{Used worldwide}
\begin{figure} \begin{figure}
\includegraphics[width=0.9\textwidth]{img/users.pdf} \includegraphics[width=0.9\textwidth]{img/users.pdf}
\end{figure} \end{figure}
\end{frame} \end{frame}
\section{Funktionsumfang} \section{Features}
\begin{frame} \begin{frame}
\frametitle{Benutzeroberfläche} \frametitle{User interface}
\centering eLabFTW verfügt über eine moderne und übersichtliche Benutzeroberfläche \centering eLabFTW features a modern and clean UI
\begin{figure} \begin{figure}
\centering \centering
\includegraphics[width=\textwidth]{img/elab/elab_01.png} \includegraphics[width=\textwidth]{img/elab/elab_01.png}
@ -110,34 +124,34 @@
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Datenmodell} \frametitle{Data Model}
\huge\faFlask\hspace{0.5em}\large Experimente\normalsize \huge\faFlask\hspace{0.5em}\large Experimente\normalsize
\begin{itemize} \begin{itemize}
\item Frei definierbarer \textbf{Status} (z.B. \textquote{abgeschlossen}, \textquote{laufend} \ldots) \item Freely definable \textbf{status} (e.g. \textquote{finished}, \textquote{in progress} \ldots)
\item \textbf{Zeitstempel} möglich \item \textbf{time stamping} of experiments
\item Definierung von \textbf{Vorlagen und Schritten} \item Definition of \textbf{templates and stepped procedures}
\end{itemize} \end{itemize}
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Datenmodell} \frametitle{Data model}
\huge\faDatabase\hspace{0.5em}\large Datenbankeinträge\normalsize \huge\faDatabase\hspace{0.5em}\large Database entries\normalsize
\begin{itemize} \begin{itemize}
\item Definierung von \textbf{Vorlagen und Subtypen} \item \textbf{Templates and sub types}
\item Nutzbar für z.B. Laborinventar, Protokolle \item Use cases: laboratory inventory, protocols, \ldots
\item Definition von \textbf{buchbaren Einträgen} möglich \item Calendar with \textbf{bookable items} (e.g.\ technical facilities)
\end{itemize} \end{itemize}
\pause \pause
\huge\faTag\hspace{0.5em}\large Kategorisierung\normalsize \huge\faTag\hspace{0.5em}\large Categorization\normalsize
\begin{itemize} \begin{itemize}
\item Frei definierbare Schlagwörter (\emph{Tags}) \item Freely choosable \textbf{tags}
\end{itemize} \end{itemize}
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Erstellen von Experimenten und Datenbankeinträgen} \frametitle{Creating experiments and database items}
\only<1>{\centering Bearbeitung im grafischen Texteditor} \only<1>{\centering Rich text editor}
\only<2>{\centering Anhängen von Dateien mit Vorschau} \only<2>{\centering Attaching of files with previews}
\begin{figure} \begin{figure}
\centering \centering
\only<1>{\includegraphics[width=\textwidth]{img/elab/elab_editor1.png}} \only<1>{\includegraphics[width=\textwidth]{img/elab/elab_editor1.png}}
@ -146,8 +160,8 @@
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Laborinventar} \frametitle{Laboratory inventory}
\centering Inventarverwaltung mit frei definierbaren Vorlagen \centering Inventory management using templates
\begin{figure} \begin{figure}
\centering \centering
\includegraphics[width=\textwidth]{img/elab/elab_03.png} \includegraphics[width=\textwidth]{img/elab/elab_03.png}
@ -155,8 +169,8 @@
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Integrierter Zeitplan} \frametitle{Integrated calendar}
\centering Buchung von Geräten über integrierten Kalender \centering Booking equipment and facilities
\begin{figure} \begin{figure}
\centering \centering
\includegraphics[width=0.8\textwidth]{img/elab/elab_02.png} \includegraphics[width=0.8\textwidth]{img/elab/elab_02.png}
@ -164,28 +178,39 @@
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Erstellen von Experimenten und Datenbankeinträgen} \frametitle{Creating experiments and database items}
Weitere Funktionen Additional features
\begin{itemize} \begin{itemize}
\item Eingabe alternativ als \textbf{strukturierter Text} (Markdown)\pause \item Alternative input syntax: \textbf{structured text} (Markdown)\pause
\item \textbf{Vorschau} gängiger Dateiformate (u.a. PDF, TIFF, PDB, SDF,\ldots)\pause \item \textbf{Preview} of common file formats (u.a. PDF, TIFF, PDB, SDF,\ldots)\pause
\item \textbf{Versionierung} von Einträgen und angehängten Daten\pause \item \textbf{Versioning} of entries and attached files\pause
\item \textbf{Verlinkung} von Experimenten/Datenbankeinträgen auch untereinander\pause \item \textbf{Linking} of/between experiments and database items\pause
\item \textbf{Freigabe} von Experimenten für andere Benutzer\pause \item \textbf{Sharing} experimens with other users\pause
\item Satz \textbf{mathematischer Formeln} \item Rendering of \textbf{math formula}
\end{itemize} \end{itemize}
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Zeitstempel} \frametitle{Upcoming features}
Fixierung von Experimenten mittels Zeitstempel New in 2.1.0 (incomplete):
\begin{itemize}
\item Possibility to include a \textbf{privacy statement} (\textquote{GDPR-complicance})
\item \textbf{Mailinglists}
\item \textbf{Reports} in admin interface (e.g. disk space usage)
\item Miscellaneous things \textquote{under the hood}
\end{itemize}
\end{frame}
\begin{frame}
\frametitle{Time stamping}
Status of experiments
\begin{columns}[c] \begin{columns}[c]
\begin{column}{0.8\textwidth} \begin{column}{0.8\textwidth}
\begin{itemize} \begin{itemize}
\small \small
\item Nachweis eines definierten Zustandes zum Zeitpunkt \textquote{X} \item Proof of defined status at time point \textquote{X}
\item Zeitstempeldienst (TSA) nach RFC 3161 (z.B. DFN) \item Time stamping authority (TSA) according to RFC~3161 (e.g. DFN)
\item Datenintegrität mittels Signatur überprüfbar \item Verification of data integrity by cryptographic hash (SHA256)
\end{itemize} \end{itemize}
\end{column} \end{column}
\begin{column}{0.2\textwidth} \begin{column}{0.2\textwidth}
@ -197,29 +222,29 @@
\centering \centering
\includegraphics[width=0.95\textwidth]{img/elab/ts01.png} \includegraphics[width=0.95\textwidth]{img/elab/ts01.png}
\end{figure} \end{figure}
\blfootnote{Abbildung: Wikimedia Commons; CC BY-SA 4.0 \faCreativeCommons~\faCreativeCommonsBy~\faCreativeCommonsSa\hspace{1em}} \blfootnote{Figure: Wikimedia Commons; CC BY-SA 4.0 \faCreativeCommons~\faCreativeCommonsBy~\faCreativeCommonsSa\hspace{1em}}
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Datenexport/-import} \frametitle{Data export/import}
\begin{itemize} \begin{itemize}
\item Export einzelner Experimente und Datenbankeinträge inkl. angehängter Dateien als \textbf{ZIP} \item Export of single experiments and data items as \textbf{ZIP} archive
\item Export als \textbf{PDF-Datei} mit Vorschau angehängter Dateien \item Export as \textbf{PDF} including preview of attached files (if possible)
\item Massenexport als \textbf{CSV} (nur Text) und ZIP (inkl. Dateien) \item Mass export as \textbf{CSV} (text-only) or \textbf{ZIP} archive (incl. attached files)
\item Import von Tabellen im CSV-Format als Experimente oder Datenbankeinträge \item Import of tables (\textbf{CSV}) to create experiments or database items
\end{itemize} \end{itemize}
\centering \centering
\huge\faFileArchive\hspace{0.75em}\faFilePdf\hspace{0.75em}\faFile \huge\faFileArchive\hspace{0.75em}\faFilePdf\hspace{0.75em}\faFile
\end{frame} \end{frame}
\section{Einbindung in bestehende Infrastruktur} \section{Integration into existing infrastructure}
\begin{frame} \begin{frame}
\frametitle{Benutzerauthentifizierung} \frametitle{User authentification}
\begin{itemize} \begin{itemize}
\item Nach Installation: Lokale Benutzerkonten \item Default after installation: local user accounts
\item Einbindung in zentrale Identitätsmanagementsysteme möglich (SAML 2.0) \item Itegration into existing identity management (SAML 2.0)
\item Kombination von lokalen und zentralen Zugängen möglich \item Combination of local and centrally managed accounts possible
\end{itemize} \end{itemize}
\begin{center} \begin{center}
\huge\faUsers\normalsize \huge\faUsers\normalsize
@ -227,26 +252,26 @@
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{API-Zugriff} \frametitle{API access}
Zugriff über öffentliche REST-API Access via public REST API
\begin{itemize} \begin{itemize}
\item Interaktion mit Geräten und Prozessen \item Interaction with lab equipment and processes
\item Automatisches Anlegen/Abschließen von Experimenten \item Automated creation/termination of experiments
\item Hochladen von Daten zu eLabFTW \item Upload of files to eLabFTW
\item Datenexport im JSON-Format \item Data export in JSON format
\end{itemize} \end{itemize}
\end{frame} \end{frame}
\begin{frame}[fragile] \begin{frame}[fragile]
\frametitle{API-Zugriff} \frametitle{API access}
\begin{block}{Erstellen eines Experimentes aus der \emph{bash} heraus} \begin{block}{Creating an experiment using \emph{bash} scripts}
\scriptsize\begin{verbatim} \scriptsize\begin{verbatim}
#!/bin/bash #!/bin/bash
export API_KEY=XXXXX export API_KEY=XXXXX
curl -X POST -H "Authorization: $API_KEY" \ curl -X POST -H "Authorization: $API_KEY" \
"https://elabftw.example.org/api/v1/experiments" "https://elabftw.example.org/api/v1/experiments"
# Datei zu Experiment 3 hochladen # Upload and attach file to experiment 3
curl -X POST -F "file=@your-file.jpg" -H \ curl -X POST -F "file=@your-file.jpg" -H \
"Authorization: $API_KEY" \ "Authorization: $API_KEY" \
"https://elabftw.example.org/api/v1/experiments/3" "https://elabftw.example.org/api/v1/experiments/3"
@ -255,21 +280,21 @@
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{API-Zugriff} \frametitle{API access}
\begin{figure} \begin{figure}
\centering \centering
\includegraphics[width=0.5\textwidth]{img/python-logo.pdf} \includegraphics[width=0.5\textwidth]{img/python-logo.pdf}
\end{figure} \end{figure}
\begin{figure} \begin{figure}
\centering \centering
Python-Bibliothek zur einfachen Interaktion mit eLabFTW:\vspace{1em} Python library for easy interaction with eLabFTW:\vspace{1em}
\includegraphics[width=0.25\textwidth]{img/elab/elabapy.png} \includegraphics[width=0.25\textwidth]{img/elab/elabapy.png}
\end{figure} \end{figure}
\end{frame} \end{frame}
\begin{frame}[fragile] \begin{frame}[fragile]
\frametitle{API-Zugriff} \frametitle{API access}
\begin{block}{Erstellen eines Experimentes mit \emph{python}} \begin{block}{Creating an experiment using \emph{python}}
\tiny\begin{verbatim} \tiny\begin{verbatim}
#!/sbin/env python #!/sbin/env python
import elabapy import elabapy
@ -283,13 +308,13 @@
\end{verbatim} \end{verbatim}
\end{block} \end{block}
\pause \pause
Weitere Beispiele:~\small\url{https://doc.elabftw.net/api.html} Additional examples:~\small\url{https://doc.elabftw.net/api.html}
\end{frame} \end{frame}
\section{Wie ausprobieren?} \section{How to try?}
\begin{frame} \begin{frame}
\frametitle{Demo-Installation} \frametitle{Demo}
\begin{figure} \begin{figure}
\centering \centering
\includegraphics[width=0.5\textwidth]{img/elabftw-logo.pdf} \includegraphics[width=0.5\textwidth]{img/elabftw-logo.pdf}
@ -308,40 +333,40 @@
\url{https://doc.elabftw.net/install.html} \url{https://doc.elabftw.net/install.html}
\end{frame} \end{frame}
\section{Zum Abschluss} \section{Finally}
\begin{frame} \begin{frame}
\frametitle{Weitere Fragen?} \frametitle{Further questions?}
\begin{center} \begin{center}
\huge\faGlobe\normalsize \huge\faGlobe\normalsize
\end{center} \end{center}
\begin{description} \begin{description}
\item[Website] \small\url{https://www.elabftw.net}\normalsize \item[Website] \small\url{https://www.elabftw.net}\normalsize
\item[Hilfe] \small\url{https://doc.elabftw.net}\normalsize \item[Documentation] \small\url{https://doc.elabftw.net}\normalsize
\item[Quelltext] \small\url{https://github.com/elabftw/elabftw}\normalsize \item[Source code] \small\url{https://github.com/elabftw/elabftw}\normalsize
\end{description} \end{description}
\vfill \vfill
\begin{center} \begin{center}
\huge\faEnvelope\normalsize \huge\faEnvelope\normalsize
\url{alexander.minges@hhu.de} \\ \url{alexander.minges@hhu.de}~(de/en)\\
\url{nicolas.carpi@curie.fr} \url{nicolas.carpi@curie.fr}~(fr/en)
\end{center} \end{center}
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Danksagung} \frametitle{Acknowledgments}
\begin{columns}[c] \begin{columns}[c]
\begin{column}{0.7\textwidth} \begin{column}{0.7\textwidth}
Prof.~Dr.~Georg Groth\\ Prof.~Dr.~Georg Groth\\
Biochemische Pflanzenphysiologie\\ Institute of Biochemical Plant Physiology\\
\emph{Heinrich-Heine-Universität} \emph{Heinrich Heine University Düsseldorf}
\vspace{3em} \vspace{3em}
Nicolas Carpi\\ Nicolas Carpi\\
\emph{Institut Curie, Paris}\\ \emph{Institut Curie, Paris}\\
Frankreich France
\end{column} \end{column}
\begin{column}{0.3\textwidth} \begin{column}{0.3\textwidth}
\includegraphics[width=\textwidth]{img/hhu-logo.pdf} \includegraphics[width=\textwidth]{img/hhu-logo.pdf}
@ -356,9 +381,9 @@
\end{frame} \end{frame}
\begin{frame} \begin{frame}
\frametitle{Abschließend\ldots} \frametitle{Finally\ldots}
\begin{center} \begin{center}
\Huge Vielen Dank für Ihre Aufmerksamkeit! \Huge Thank you for your kind attention!
\end{center} \end{center}
\end{frame} \end{frame}