labinform-eln

LabInform ELN component

https://github.com/tillbiskup/labinform-eln

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.8%) to scientific vocabulary

Keywords

docker dokuwiki eln
Last synced: 6 months ago · JSON representation ·

Repository

LabInform ELN component

Basic Info
  • Host: GitHub
  • Owner: tillbiskup
  • License: bsd-2-clause
  • Language: PHP
  • Default Branch: master
  • Homepage: https://eln.labinform.de/
  • Size: 989 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Topics
docker dokuwiki eln
Created almost 3 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

LabInform ELN

This is the LabInform ELN component, the electronic lab(oratory) notebook (ELN) that is part of the LabInform laboratory information and management system (LIMS).

Why yet another open-source ELN? Aren't there enough already? We are pretty certain that the LabInform ELN comes with some unique features, and we look back at already ten years of successful operation. However, rather than telling you into using the LabInform ELN, in the documentation available online we explain the underlying design principles and highlight the decisions necessary to achieve a workflow fitting the local requirements and improving reproducibility and hence overall quality of science, besides helping with getting FAIRer data.

Demo available online

A demo of the LabInform ELN can be accessed online: https://eln.labinform.de/.

The data contained in this demo will be deleted regularly. Nevertheless, don't enter any sensible data in there, as everybody will be able to access them.

For more information on how to use the LabInform ELN from a user perspective, have a look at the user manual.

Features

A number of good reasons why to choose the LabInform ELN instead of other ELN candidates.

System:

  • Based on DokuWiki, "a simple to use and highly versatile Open Source wiki software".
  • Small footprint: minimum system requirements, simple installation, no database backend
  • Flexible, easily adapted to your needs from within the Web UI
  • Fine-grained access control and role model
  • Hierarchical structure, well-suited for knowledge management
  • Easy to backup: just a folder in the file system
  • Complete audit trail of changes

Contents:

  • Flexible contents including media, thanks to simple yet powerful DokuWiki markup syntax
  • Structured content, machine-actionable with little to no effort
  • Inventory for samples
  • Automatic cross-linking between inventory and labbook entries
  • new entries via web forms and configurable templates

And to make it even more convenient for users and future-proof:

Non-Features

A few things the LabInform ELN does not provide/implement by purpose:

  • Data store, aka repository*
  • Research data catalogue
  • Management of measurement setups in the lab*
  • General project management, including proposals and publications*
  • General inventory for consumables
  • Analysis workflow for data**

The main reason lies in the "separation of concerns" (E. Dijkstra), focussing on one task at a time using one dedicated tool. Some of the "non-features" described above (and marked with an asterisk: ) are, however, part of the wider LabInform LIMS the LabInform ELN is only one part of. If you are interested in a reproducible analysis workflow of spectroscopic data (*), have a look at the ASpecD framework and related packages.

Installation

Generally, DokuWiki requires a running web server and PHP, but no database. Hence, basic familiarity with setting up a web server and with the command line are necessary. The LabInform ELN builds upon a series of plugins for DokuWiki. Detailed installation instructions can be found in the administrator manual.

How to cite

The LabInform ELN is free software. However, if you use the LabInform ELN as crucial infrastructure component of your own research, please cite both, the article describing it and the software itself:

  • Mirjam Schröder, Till Biskup. LabInform ELN: A lightweight and flexible electronic laboratory notebook for academic research based on the open-source software DokuWiki. ChemRxiv, 2023. doi:10.26434/chemrxiv-2023-2tvct

License

This program is free software: you can redistribute it and/or modify it under the terms of the BSD License. However, if you use the LabInform ELN as crucial infrastructure component of your own research, please cite it appropriately. See the "How to cite" section above for details.

Please note that DokuWiki itself is provided under a GNU General Public License (GPL). For details, see their webpage. Most DokuWiki plugins are licensed under the GNU GPL as well, but please check yourself for each plugin you're using.

Owner

  • Login: tillbiskup
  • Kind: user
  • Location: Germany

Scientist focussing on reproducible research, particularly in spectroscopy

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite both the preprint from preferred-citation and the software itself.
preferred-citation:
  authors:
    - family-names: Schröder
      given-names: Mirjam
      orcid: "https://orcid.org/0000-0002-8940-3185"
    - family-names: Biskup
      given-names: Till
      orcid: "https://orcid.org/0000-0003-2913-0004"
  title: "LabInform ELN: A lightweight and flexible electronic laboratory notebook for academic research based on the open-source software DokuWiki."
  doi: 10.26434/chemrxiv-2023-2tvct
  journal: ChemRxiv
  year: 2023
  type: article
title: LabInform ELN
abstract: >
    LabInform ELN is a lightweight and flexible electronic laboratory notebook for academic research based on the open-source software DokuWiki. Key features are its minimal system requirements, flexibility, modularity, and compliance with auditing requirements. The minimalistic system requirements allow for using it in small groups and even by individual scientists and help with improving both, reproducibility and access to the notes taken. At the same time, thanks to its fine-grained access management, it scales well to larger groups. Furthermore, it can be easily adjusted to specific needs from within its web interface.
authors:
  - family-names: Schröder
    given-names: Mirjam
    orcid: "https://orcid.org/0000-0002-8940-3185"
  - family-names: Biskup
    given-names: Till
    orcid: "https://orcid.org/0000-0003-2913-0004"
type: software
license: BSD-2-Clause
repository-code: "https://github.com/tillbiskup/labinform-eln"
keywords:
  - "electronic laboratory notebook"
  - "ELN"
  - "reproducible research"
  - "research data management"
  - "metadata"
  - "wiki"
  - "inventory"
  - "FAIR data"
  - "knowledge management"
references:
  - authors:
    - family-names: Schröder
      given-names: Mirjam
      orcid: "https://orcid.org/0000-0002-8940-3185"
    - family-names: Biskup
      given-names: Till
      orcid: "https://orcid.org/0000-0003-2913-0004"
    doi: 10.5281/zenodo.4717937
    repository-code: "https://github.com/tillbiskup/labinform-eln"
    title: LabInform ELN
    type: software

GitHub Events

Total
Last Year

Dependencies

dokuwiki/Dockerfile docker
  • tillbiskup/dokuwiki-eln latest build
dokuwiki/docker-compose.yml docker