elabftw_hhzi_2018/master.tex

365 lines
No EOL
12 KiB
TeX

\documentclass[hyperref={pdfencoding=auto,colorlinks=false}]{beamer}
\usepackage{fontspec}
\usepackage{fontawesome5}
\usepackage{polyglossia}
\usepackage{tikz}
\usetikzlibrary{fit}
\usepackage{caption}
\usepackage{csquotes}
\usetheme{metropolis}
\metroset{block=fill}
\setdefaultlanguage[variant=german,
spelling=new,
latesthyphen=true]{german}
\setotherlanguage[variant=usmax]{english}
\title{eLabFTW}
\subtitle{Das freie elektronische Laborjournal}
\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}
\date{\scriptsize Helmholtz Open Science Workshop „Elektronische Laborbücher“\\13. September 2018}
\hypersetup{pdfauthor={Alexander Minges}}
\newcommand\blfootnote[1]{%
\begingroup
\renewcommand\thefootnote{}\footnote{#1}%
\addtocounter{footnote}{-1}%
\endgroup
}
\begin{document}
\maketitle
\section{Einführung}
\begin{frame}
\frametitle{Was ist eLabFTW?}
eLabFTW ist ein generisches elektronisches Laborjournal (ELN)
\pause
\begin{itemize}
\item Offene und freie 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 Browser basierte Benutzeroberfläche, kompatibel mit allen gängigen Browsern und (Mobil-) Geräten\pause
\item Übersetzt in verschiedene Sprachen
\end{itemize}
\end{frame}
\begin{frame}
\frametitle{Was ist eLabFTW?}
\begin{center}
\large eLabFTW ist eine freie und offene Software (FLOSS)
\end{center}
\pause
\begin{description}
\item[Frei wie in \textquote{Freibier}] eLabFTW ist jederzeit \textbf{kostenlos} verfügbar
\item[Frei wie in \textquote{Freiheit}] der \textbf{Quelltext} steht offen zur Verfügung, kann \textbf{angepasst, verändert und weiterverbreitet} werden
\end{description}
\end{frame}
\begin{frame}
\frametitle{Eine kurze Historie}
\Huge\faClock\normalsize
\begin{description}
\item[2012] Initiiert von Nicolas Carpi am \emph{Institut Pasteur}
\item[Feb. 2013] Erste veröffentlichte Version (0.7.0)
\item[2018] Offiziell durch das \emph{Institut Curie} unterstütztes Softwareprojekt
\item[Aug. 2018] Veröffentlichung der aktuellen stabilen Version 2.0
\item[Vorgestern] Bugfix-Release 2.0.1
\end{description}
\end{frame}
\begin{frame}
\frametitle{eLabFTW arbeitet platformunabhängig}
\begin{center}
\Huge\faPhp\hspace{1em}\faDatabase\hspace{1em}\faServer
\end{center}
\begin{itemize}
\item Installation auf zentralem \textbf{Server} (Webserver + PHP + MySQL/MariaDB)
\item Zugriff über \textbf{Webbrowser} auf Endgeräten (Desktop, Notebook, Tablet, Smartphone)
\item \textbf{Keine Installation spezieller Software} auf dem Client nötig, keine Bindung an bestimmte \textbf{Betriebssysteme}
\end{itemize}
\begin{center}
\LARGE\faWindows\hspace{0.75em}\faLinux\hspace{0.75em}\faApple\hspace{0.75em}\faFreebsd \\
\faFirefox\hspace{1.25em}\faChrome\hspace{1.25em}\faSafari\hspace{1.25em}\faEdge
\end{center}
\end{frame}
\begin{frame}
\frametitle{eLabFTW wird weltweit eingesetzt}
\begin{figure}
\includegraphics[width=0.9\textwidth]{img/users.pdf}
\end{figure}
\end{frame}
\section{Funktionsumfang}
\begin{frame}
\frametitle{Benutzeroberfläche}
\centering eLabFTW verfügt über eine moderne und übersichtliche Benutzeroberfläche
\begin{figure}
\centering
\includegraphics[width=\textwidth]{img/elab/elab_01.png}
\end{figure}
\end{frame}
\begin{frame}
\frametitle{Datenmodell}
\huge\faFlask\hspace{0.5em}\large Experimente\normalsize
\begin{itemize}
\item Frei definierbarer \textbf{Status} (z.B. \textquote{abgeschlossen}, \textquote{laufend} \ldots)
\item \textbf{Zeitstempel} möglich
\item Definierung von \textbf{Vorlagen und Schritten}
\end{itemize}
\end{frame}
\begin{frame}
\frametitle{Datenmodell}
\huge\faDatabase\hspace{0.5em}\large Datenbankeinträge\normalsize
\begin{itemize}
\item Definierung von \textbf{Vorlagen und Subtypen}
\item Nutzbar für z.B. Laborinventar, Protokolle
\item Definition von \textbf{buchbaren Einträgen} möglich
\end{itemize}
\pause
\huge\faTag\hspace{0.5em}\large Kategorisierung\normalsize
\begin{itemize}
\item Frei definierbare Schlagwörter (\emph{Tags})
\end{itemize}
\end{frame}
\begin{frame}
\frametitle{Erstellen von Experimenten und Datenbankeinträgen}
\only<1>{\centering Bearbeitung im grafischen Texteditor}
\only<2>{\centering Anhängen von Dateien mit Vorschau}
\begin{figure}
\centering
\only<1>{\includegraphics[width=\textwidth]{img/elab/elab_editor1.png}}
\only<2>{\includegraphics[width=\textwidth]{img/elab/elab_editor2.png}}
\end{figure}
\end{frame}
\begin{frame}
\frametitle{Laborinventar}
\centering Inventarverwaltung mit frei definierbaren Vorlagen
\begin{figure}
\centering
\includegraphics[width=\textwidth]{img/elab/elab_03.png}
\end{figure}
\end{frame}
\begin{frame}
\frametitle{Integrierter Zeitplan}
\centering Buchung von Geräten über integrierten Kalender
\begin{figure}
\centering
\includegraphics[width=0.8\textwidth]{img/elab/elab_02.png}
\end{figure}
\end{frame}
\begin{frame}
\frametitle{Erstellen von Experimenten und Datenbankeinträgen}
Weitere Funktionen
\begin{itemize}
\item Eingabe alternativ als \textbf{strukturierter Text} (Markdown)\pause
\item \textbf{Vorschau} gängiger Dateiformate (u.a. PDF, TIFF, PDB, SDF,\ldots)\pause
\item \textbf{Versionierung} von Einträgen und angehängten Daten\pause
\item \textbf{Verlinkung} von Experimenten/Datenbankeinträgen auch untereinander\pause
\item \textbf{Freigabe} von Experimenten für andere Benutzer\pause
\item Satz \textbf{mathematischer Formeln}
\end{itemize}
\end{frame}
\begin{frame}
\frametitle{Zeitstempel}
Fixierung von Experimenten mittels Zeitstempel
\begin{columns}[c]
\begin{column}{0.8\textwidth}
\begin{itemize}
\small
\item Nachweis eines definierten Zustandes zum Zeitpunkt \textquote{X}
\item Zeitstempeldienst (TSA) nach RFC 3161 (z.B. DFN)
\item Datenintegrität mittels Signatur überprüfbar
\end{itemize}
\end{column}
\begin{column}{0.2\textwidth}
\includegraphics[width=\textwidth]{img/Zeitstempel_01.jpg}
\end{column}
\end{columns}
\pause
\begin{figure}
\centering
\includegraphics[width=0.95\textwidth]{img/elab/ts01.png}
\end{figure}
\blfootnote{Abbildung: Wikimedia Commons; CC BY-SA 4.0 \faCreativeCommons~\faCreativeCommonsBy~\faCreativeCommonsSa\hspace{1em}}
\end{frame}
\begin{frame}
\frametitle{Datenexport/-import}
\begin{itemize}
\item Export einzelner Experimente und Datenbankeinträge inkl. angehängter Dateien als \textbf{ZIP}
\item Export als \textbf{PDF-Datei} mit Vorschau angehängter Dateien
\item Massenexport als \textbf{CSV} (nur Text) und ZIP (inkl. Dateien)
\item Import von Tabellen im CSV-Format als Experimente oder Datenbankeinträge
\end{itemize}
\centering
\huge\faFileArchive\hspace{0.75em}\faFilePdf\hspace{0.75em}\faFile
\end{frame}
\section{Einbindung in bestehende Infrastruktur}
\begin{frame}
\frametitle{Benutzerauthentifizierung}
\begin{itemize}
\item Nach Installation: Lokale Benutzerkonten
\item Einbindung in zentrale Identitätsmanagementsysteme möglich (SAML 2.0)
\item Kombination von lokalen und zentralen Zugängen möglich
\end{itemize}
\begin{center}
\huge\faUsers\normalsize
\end{center}
\end{frame}
\begin{frame}
\frametitle{API-Zugriff}
Zugriff über öffentliche REST-API
\begin{itemize}
\item Interaktion mit Geräten und Prozessen
\item Automatisches Anlegen/Abschließen von Experimenten
\item Hochladen von Daten zu eLabFTW
\item Datenexport im JSON-Format
\end{itemize}
\end{frame}
\begin{frame}[fragile]
\frametitle{API-Zugriff}
\begin{block}{Erstellen eines Experimentes aus der \emph{bash} heraus}
\scriptsize\begin{verbatim}
#!/bin/bash
export API_KEY=XXXXX
curl -X POST -H "Authorization: $API_KEY" \
"https://elabftw.example.org/api/v1/experiments"
# Datei zu Experiment 3 hochladen
curl -X POST -F "file=@your-file.jpg" -H \
"Authorization: $API_KEY" \
"https://elabftw.example.org/api/v1/experiments/3"
\end{verbatim}
\end{block}
\end{frame}
\begin{frame}
\frametitle{API-Zugriff}
\begin{figure}
\centering
\includegraphics[width=0.5\textwidth]{img/python-logo.pdf}
\end{figure}
\begin{figure}
\centering
Python-Bibliothek zur einfachen Interaktion mit eLabFTW:\vspace{1em}
\includegraphics[width=0.25\textwidth]{img/elab/elabapy.png}
\end{figure}
\end{frame}
\begin{frame}[fragile]
\frametitle{API-Zugriff}
\begin{block}{Erstellen eines Experimentes mit \emph{python}}
\tiny\begin{verbatim}
#!/sbin/env python
import elabapy
manager = elabapy.Manager(endpoint="https://elab.example.org/api/v1/",
token="XXXX")
exp = manager.create_experiment()
files = {'file': open('report.xls', 'rb')}
print(manager.upload_to_experiment(exp["id], files))
\end{verbatim}
\end{block}
\pause
Weitere Beispiele:~\small\url{https://doc.elabftw.net/api.html}
\end{frame}
\section{Wie ausprobieren?}
\begin{frame}
\frametitle{Demo-Installation}
\begin{figure}
\centering
\includegraphics[width=0.5\textwidth]{img/elabftw-logo.pdf}
\end{figure}
\centering
\url{https://demo.elabftw.net}
\end{frame}
\begin{frame}
\frametitle{Installation}
\begin{figure}
\centering
\includegraphics[width=0.5\textwidth]{img/docker.eps}
\end{figure}
\centering
\url{https://doc.elabftw.net/install.html}
\end{frame}
\section{Zum Abschluss}
\begin{frame}
\frametitle{Weitere Fragen?}
\begin{center}
\huge\faGlobe\normalsize
\end{center}
\begin{description}
\item[Website] \small\url{https://www.elabftw.net}\normalsize
\item[Hilfe] \small\url{https://doc.elabftw.net}\normalsize
\item[Quelltext] \small\url{https://github.com/elabftw/elabftw}\normalsize
\end{description}
\vfill
\begin{center}
\huge\faEnvelope\normalsize
\url{alexander.minges@hhu.de} \\
\url{nicolas.carpi@curie.fr}
\end{center}
\end{frame}
\begin{frame}
\frametitle{Danksagung}
\begin{columns}[c]
\begin{column}{0.7\textwidth}
Prof.~Dr.~Georg Groth\\
Biochemische Pflanzenphysiologie\\
\emph{Heinrich-Heine-Universität}
\vspace{3em}
Nicolas Carpi\\
\emph{Institut Curie, Paris}\\
Frankreich
\end{column}
\begin{column}{0.3\textwidth}
\includegraphics[width=\textwidth]{img/hhu-logo.pdf}
\vspace{3em}
\includegraphics[width=\textwidth]{img/institut-curie.jpg}
\end{column}
\end{columns}
\vfill
\blfootnote{\faCreativeCommons~\faCreativeCommonsBy~\faCreativeCommonsSa\hspace{1em}Creative Commons BY-SA 4.0}
\end{frame}
\begin{frame}
\frametitle{Abschließend\ldots}
\begin{center}
\Huge Vielen Dank für Ihre Aufmerksamkeit!
\end{center}
\end{frame}
\end{document}