diff --git a/master.pdf b/master.pdf index 399e19c..e8b456c 100644 Binary files a/master.pdf and b/master.pdf differ diff --git a/master.tex b/master.tex index 8b650d5..d07e358 100644 --- a/master.tex +++ b/master.tex @@ -10,16 +10,16 @@ \usetheme{metropolis} \metroset{block=fill} - \setdefaultlanguage[variant=german, - spelling=new, - latesthyphen=true]{german} - \setotherlanguage[variant=usmax]{english} + \setdefaultlanguage[variant=usmax]{english} + \setotherlanguage[variant=german, + spelling=new, + latesthyphen=true]{german} \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} - \institute[Biochemische Pflanzenphysiologie]{Institut für Biochemische Pflanzenphysiologie\\Heinrich-Heine-Universität Düsseldorf} - \date{\scriptsize IRTG Lecture Series -- „Thementag Elektronische Laborbücher“\\26. März 2019} + \institute[Biochemical Plant Physiology]{Institute of Biochemical Plant Physiology\\Heinrich Heine University Düsseldorf} + \date{\scriptsize \textquote{Thementag Elektronische Laborbücher}\\26. March 2019 -- University of Rostock} \hypersetup{pdfauthor={Alexander Minges}} @@ -34,36 +34,36 @@ \maketitle -\section{Einführung} +\section{Introduction} \begin{frame} - \frametitle{Was ist eLabFTW?} - eLabFTW ist ein generisches elektronisches Laborjournal (ELN) + \frametitle{What is eLabFTW?} + eLabFTW is a generic electronic lab notebook (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 + \item Free and open-source software (GNU AGPL 3.0~\includegraphics[height=1.0em]{img/AGPLv3_Logo.pdf})\pause + \item Community-driven development -- by scientists, \\for scientists\pause + \item Browser-based user interface compatible with all commonly used browsers and (mobile) devices\pause + \item Multilingual \end{itemize} \end{frame} \begin{frame} - \frametitle{Was ist eLabFTW?} + \frametitle{What is eLabFTW?} \begin{center} - \large eLabFTW ist eine freie und offene Software (FLOSS) + \large eLabFTW is free and open-source 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 + \item[Free as in \textquote{beer}] eLabFTW is (and will always be) \\available \textbf{free of charge} + \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{frame} \begin{frame} - \frametitle{Warum elektronische Laborbücher?} + \frametitle{Why electronic lab notebooks?} \begin{center} - \large Analoge Laborbücher sind ein Anachronismus\ldots + \large Hand-written lab notebooks are anachronistic\ldots \end{center} \pause \begin{figure} @@ -74,27 +74,28 @@ \end{frame} \begin{frame} - \frametitle{Eine kurze Historie} + \frametitle{A brief history of eLabFTW} \Huge\faClock\normalsize \begin{description} - \item[2012] Initiiert von Nicolas Carpi am \emph{Institut Curie} - \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[März 2019] 2.1.0-alpha + \item[2012] Initiated by Nicolas Carpi at the \emph{Institut Curie} + \item[Feb. 2013] First public version (0.7.0) + \item[2018] Announced as an officially supported software project by the \emph{Institut Curie} + \item[Aug. 2018] Current major version 2.0 released + \item[Mar. 2019] Feature preview 2.1.0-alpha \end{description} \end{frame} \begin{frame} - \frametitle{eLabFTW arbeitet platformunabhängig} + \frametitle{eLabFTW is platform independent} \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} + \item Installation on a \textbf{server} (Webserver + PHP + MySQL/MariaDB) + \item Access via \textbf{web browser} on many different clients (desktop, notebook, tablet, smartphone) + \item \textbf{No client software} needed + \item No dependency on specific \textbf{operating systems} \end{itemize} \begin{center} @@ -105,17 +106,17 @@ \begin{frame} - \frametitle{eLabFTW wird weltweit eingesetzt} + \frametitle{Used worldwide} \begin{figure} \includegraphics[width=0.9\textwidth]{img/users.pdf} \end{figure} \end{frame} -\section{Funktionsumfang} +\section{Features} \begin{frame} - \frametitle{Benutzeroberfläche} - \centering eLabFTW verfügt über eine moderne und übersichtliche Benutzeroberfläche + \frametitle{User interface} + \centering eLabFTW features a modern and clean UI \begin{figure} \centering \includegraphics[width=\textwidth]{img/elab/elab_01.png} @@ -123,34 +124,34 @@ \end{frame} \begin{frame} - \frametitle{Datenmodell} + \frametitle{Data Model} \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} + \item Freely definable \textbf{status} (e.g. \textquote{finished}, \textquote{in progress} \ldots) + \item \textbf{time stamping} of experiments + \item Definition of \textbf{templates and stepped procedures} \end{itemize} \end{frame} \begin{frame} - \frametitle{Datenmodell} - \huge\faDatabase\hspace{0.5em}\large Datenbankeinträge\normalsize + \frametitle{Data model} + \huge\faDatabase\hspace{0.5em}\large Database entries\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 + \item \textbf{Templates and sub types} + \item Use cases: laboratory inventory, protocols, \ldots + \item Calendar with \textbf{bookable items} (e.g.\ technical facilities) \end{itemize} \pause - \huge\faTag\hspace{0.5em}\large Kategorisierung\normalsize + \huge\faTag\hspace{0.5em}\large Categorization\normalsize \begin{itemize} - \item Frei definierbare Schlagwörter (\emph{Tags}) + \item Freely choosable \textbf{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} + \frametitle{Creating experiments and database items} + \only<1>{\centering Rich text editor} + \only<2>{\centering Attaching of files with previews} \begin{figure} \centering \only<1>{\includegraphics[width=\textwidth]{img/elab/elab_editor1.png}} @@ -159,8 +160,8 @@ \end{frame} \begin{frame} - \frametitle{Laborinventar} - \centering Inventarverwaltung mit frei definierbaren Vorlagen + \frametitle{Laboratory inventory} + \centering Inventory management using templates \begin{figure} \centering \includegraphics[width=\textwidth]{img/elab/elab_03.png} @@ -168,8 +169,8 @@ \end{frame} \begin{frame} - \frametitle{Integrierter Zeitplan} - \centering Buchung von Geräten über integrierten Kalender + \frametitle{Integrated calendar} + \centering Booking equipment and facilities \begin{figure} \centering \includegraphics[width=0.8\textwidth]{img/elab/elab_02.png} @@ -177,39 +178,39 @@ \end{frame} \begin{frame} - \frametitle{Erstellen von Experimenten und Datenbankeinträgen} - Weitere Funktionen + \frametitle{Creating experiments and database items} + Additional features \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} + \item Alternative input syntax: \textbf{structured text} (Markdown)\pause + \item \textbf{Preview} of common file formats (u.a. PDF, TIFF, PDB, SDF,\ldots)\pause + \item \textbf{Versioning} of entries and attached files\pause + \item \textbf{Linking} of/between experiments and database items\pause + \item \textbf{Sharing} experimens with other users\pause + \item Rendering of \textbf{math formula} \end{itemize} \end{frame} \begin{frame} - \frametitle{Kommende Funktionen} - Neu in 2.1.0 (unvollständig): + \frametitle{Upcoming features} + New in 2.1.0 (incomplete): \begin{itemize} - \item Möglichkeit zum Einbinden einer \textbf{Datenschutzerklärung} (Stichwort „DSGVO“) - \item \textbf{Mailinglisten}-Funktion - \item Erstellung von \textbf{Berichten} im Admin-Interface (z.B. zur Speichernutzung) - \item Diverse Änderungen „unter der Haube“ + \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{Zeitstempel} - Fixierung von Experimenten mittels Zeitstempel + \frametitle{Time stamping} + Status of experiments \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 + \item Proof of defined status at time point \textquote{X} + \item Time stamping authority (TSA) according to RFC~3161 (e.g. DFN) + \item Verification of data integrity by cryptographic hash (SHA256) \end{itemize} \end{column} \begin{column}{0.2\textwidth} @@ -221,29 +222,29 @@ \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}} + \blfootnote{Figure: Wikimedia Commons; CC BY-SA 4.0 \faCreativeCommons~\faCreativeCommonsBy~\faCreativeCommonsSa\hspace{1em}} \end{frame} \begin{frame} - \frametitle{Datenexport/-import} + \frametitle{Data export/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 + \item Export of single experiments and data items as \textbf{ZIP} archive + \item Export as \textbf{PDF} including preview of attached files (if possible) + \item Mass export as \textbf{CSV} (text-only) or \textbf{ZIP} archive (incl. attached files) + \item Import of tables (\textbf{CSV}) to create experiments or database items \end{itemize} \centering \huge\faFileArchive\hspace{0.75em}\faFilePdf\hspace{0.75em}\faFile \end{frame} -\section{Einbindung in bestehende Infrastruktur} +\section{Integration into existing infrastructure} \begin{frame} - \frametitle{Benutzerauthentifizierung} + \frametitle{User authentification} \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 + \item Default after installation: local user accounts + \item Itegration into existing identity management (SAML 2.0) + \item Combination of local and centrally managed accounts possible \end{itemize} \begin{center} \huge\faUsers\normalsize @@ -251,26 +252,26 @@ \end{frame} \begin{frame} - \frametitle{API-Zugriff} - Zugriff über öffentliche REST-API + \frametitle{API access} + Access via public 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 + \item Interaction with lab equipment and processes + \item Automated creation/termination of experiments + \item Upload of files to eLabFTW + \item Data export in JSON format \end{itemize} \end{frame} \begin{frame}[fragile] - \frametitle{API-Zugriff} - \begin{block}{Erstellen eines Experimentes aus der \emph{bash} heraus} + \frametitle{API access} + \begin{block}{Creating an experiment using \emph{bash} scripts} \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 + # Upload and attach file to experiment 3 curl -X POST -F "file=@your-file.jpg" -H \ "Authorization: $API_KEY" \ "https://elabftw.example.org/api/v1/experiments/3" @@ -279,21 +280,21 @@ \end{frame} \begin{frame} - \frametitle{API-Zugriff} + \frametitle{API access} \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} + Python library for easy interaction with 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}} + \frametitle{API access} + \begin{block}{Creating an experiment using \emph{python}} \tiny\begin{verbatim} #!/sbin/env python import elabapy @@ -307,13 +308,13 @@ \end{verbatim} \end{block} \pause - Weitere Beispiele:~\small\url{https://doc.elabftw.net/api.html} + Additional examples:~\small\url{https://doc.elabftw.net/api.html} \end{frame} -\section{Wie ausprobieren?} +\section{How to try?} \begin{frame} - \frametitle{Demo-Installation} + \frametitle{Demo} \begin{figure} \centering \includegraphics[width=0.5\textwidth]{img/elabftw-logo.pdf} @@ -332,40 +333,40 @@ \url{https://doc.elabftw.net/install.html} \end{frame} -\section{Zum Abschluss} +\section{Finally} \begin{frame} - \frametitle{Weitere Fragen?} + \frametitle{Further questions?} \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 + \item[Documentation] \small\url{https://doc.elabftw.net}\normalsize + \item[Source code] \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} + \url{alexander.minges@hhu.de}~(de/en)\\ + \url{nicolas.carpi@curie.fr}~(fr/en) \end{center} \end{frame} \begin{frame} - \frametitle{Danksagung} + \frametitle{Acknowledgments} \begin{columns}[c] \begin{column}{0.7\textwidth} Prof.~Dr.~Georg Groth\\ - Biochemische Pflanzenphysiologie\\ - \emph{Heinrich-Heine-Universität} + Institute of Biochemical Plant Physiology\\ + \emph{Heinrich Heine University Düsseldorf} \vspace{3em} Nicolas Carpi\\ \emph{Institut Curie, Paris}\\ - Frankreich + France \end{column} \begin{column}{0.3\textwidth} \includegraphics[width=\textwidth]{img/hhu-logo.pdf} @@ -380,9 +381,9 @@ \end{frame} \begin{frame} - \frametitle{Abschließend\ldots} + \frametitle{Finally\ldots} \begin{center} - \Huge Vielen Dank für Ihre Aufmerksamkeit! + \Huge Thank you for your kind attention! \end{center} \end{frame}