eLabFTW

eLabFTW: An open source laboratory notebook for research labs - Published in JOSS (2017)

https://github.com/elabftw/elabftw

Science Score: 100.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 and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    4 of 50 committers (8.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

docker laboratory lims mysql notebook php

Keywords from Contributors

neuroimaging bioinformatics
Last synced: 4 months ago · JSON representation ·

Repository

:notebook: eLabFTW is the most popular open source electronic lab notebook for research labs.

Basic Info
  • Host: GitHub
  • Owner: elabftw
  • License: agpl-3.0
  • Language: PHP
  • Default Branch: master
  • Homepage: https://www.elabftw.net
  • Size: 208 MB
Statistics
  • Stars: 1,146
  • Watchers: 57
  • Forks: 245
  • Open Issues: 200
  • Releases: 321
Topics
docker laboratory lims mysql notebook php
Created about 13 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing Funding License Code of conduct Citation Security Governance Codemeta

README.md

elabftw logo

A free, modern, versatile, secure electronic lab notebook for researchers

Official website | Live demo | Documentation | Dedicated hosting

CircleCI

Code Coverage CII Best Practices Join the chat at https://gitter.im/elabftw/elabftw License Release StackShare Joss
Carbon offset Trees Plant more

Description

eLabFTW is an electronic lab notebook manager for research teams.

It lets you store and organize your research experiments easily. It also features a database where any kind of objects (such as antibodies, plasmids, cell lines, boxes, etc.) can be stored. It is accessed via the browser. Several research teams can be hosted on the same installation. This means eLabFTW can be installed at the institute level and host all team members at the same place. This is what is done at in many research institutions around the globe. It is also a great solution for companies looking into improving the traceability and reproducibility of their processes.

Features

  • Lab notebook for experiments
  • Database for resources (lab reagents, equipment, storage, cell lines, chemical products, etc...)
  • Trusted timestamping
  • Blockchain timestamping
  • Import and export in various formats
  • Calendar to manage booking of equipment
  • Support for various scientific file formats
  • Molecule editor
  • LaTeX support
  • Todolist
  • Public REST API
  • Available in 21 languages
  • Advanced permissions system
  • Audited, secure codebase suitable for sensitive research results
  • Self contained service that doesn't leak data to third party

How it works

eLabFTW is designed to be installed on a server, and people from the team can log in from their browser.

server client

Installation

eLabFTW can easily be installed on any GNU/Linux server. It requires at least 512 MB of RAM (1 GB recommended) and 300 MB of disk space. Installation is done through Docker, so Docker needs to be installed on the server. Since it runs in a Docker container, php, webservers or mysql do not have to be installed on your server. Everything is provided by the containers so different versions and extensions do not matter. This makes upgrading versions much easier.

The documentation explains everything:

Installation instructions

Contributing

eLabFTW is a collaborative project. Your contributions are very welcome! Have a look at the contributing page to see how you can help with translation or code.

Security

See SECURITY.md.

Support

Community support

Free support is available through GitHub issues. Please open an issue if you have a problem, want to make a suggestion, ask a question or discuss a feature.

You can also join the chat room on Gitter.

Commercial support

PRO support and professional hosting are available from Deltablot.

Stay tuned

Subscribe to the newsletter to be notified when a new release is out!

Or use GitHub to follow releases:

release watch

Funding

eLabFTW is distributed without charge. If you find this project useful, please consider making a small donation either:

Gold sponsors

This project is backed by Deltablot company.

deltablot logo

  • Atelier de la donnée ADOC Lorraine (projet financé avec le soutien du Fonds national pour la Science ouverte)
  • Department for the Development of Innovative Digital Use – French National Research Institute for Sustainable Development
  • Institut Curie – Centre de Recherche
  • Vrije Universiteit Brussel
  • Institute of Medical Biometry and Statistics, Faculty of Medicine and Medical Center – University of Freiburg, Germany
  • Georg-August-University Goettingen - Institute of Inorganic Chemistry

Related projects

API libraries

Communities

  • The ELN Consortium: a consortium of ELN vendors interested in improving interoperability between ELNs

Importing data from another ELN

Third party libraries or scripts

These projects were created by users of eLabFTW, check them out if interested!

  • elAPI: a powerful, extensible API client for eLabFTW developed at the University Computing Centre of University of Heidelberg
  • pyelabdata: provides functions for simple one-line access to data stored in eLabFTW via Python
  • elabftw-teamupload: Synchronize teamgroups and teams with users from Excel
  • Reporting Dashboard: Collection of scripts to create a reporting dashabord for eLabFTW SysAdmins

Deprecated projects using retired api v1

Unofficial documentation

Contributors

Made with contrib.rocks.

<3

Thank you for using eLabFTW. I hope it will bring happiness to your lab ;)

Owner

  • Name: elabftw
  • Login: elabftw
  • Kind: organization
  • Location: Paris, France

Electronic lab notebook for research teams

JOSS Publication

eLabFTW: An open source laboratory notebook for research labs
Published
April 14, 2017
Volume 2, Issue 12, Page 146
Authors
Nicolas CARPi ORCID
Institut Curie UMR144/CNRS 26 rue d'Ulm 75005 PARIS, France
Alexander Minges ORCID
Institute of Biochemical Plant Physiology, Heinrich Heine University 40204 Düsseldorf, Germany
Matthieu Piel ORCID
Institut Curie UMR144/CNRS 26 rue d'Ulm 75005 PARIS, France
Editor
Christopher R. Madan ORCID
Tags
eln notebook research php/mysql opensource AGPLv3

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: CARPi
    given-names: Nicolas
    orcid: https://orcid.org/0000-0002-7494-5555
  - family-names: Minges
    given-names: Alexander
    orcid: https://orcid.org/0000-0001-7760-2753
  - family-names: Piel
    given-names: Matthieu
    orcid: https://orcid.org/0000-0002-2848-177X
title: "eLabFTW: An open source laboratory notebook for research labs"
version: 1.4.0
doi: 10.21105/joss.00146
date-released: 2017-04-14

CodeMeta (codemeta.json)

{
  "@context": "https://raw.githubusercontent.com/codemeta/codemeta/master/codemeta.jsonld",
  "@type": "Code",
  "author": [
    {
      "@id": "http://orcid.org/0000-0002-7494-5555",
      "@type": "Person",
      "email": "nico-git@deltablot.email",
      "name": "Nicolas CARPi",
      "affiliation": "Deltablot, Paris, France"
    },
    {
      "@id": "http://orcid.org/0000-0001-7760-2753",
      "@type": "Person",
      "name": "Alexander Minges",
      "affiliation": "Institute of Biochemical Plant Physiology, Düsseldorf, Germany"
    },
    {
      "@id": "http://orcid.org/0000-0002-2848-177X",
      "@type": "Person",
      "name": "Matthieu Piel",
      "affiliation": "Institut Curie UMR144/CNRS, Paris, France"
    },
    {
      "@id": "https://orcid.org/0000-0002-3808-2481",
      "@type": "Person",
      "name": "Marcel Bolten"
    }
  ],
  "codeRepository": "https://github.com/elabftw/elabftw",
  "datePublished": "2012-03-03",
  "dateCreated": "2012-01-01",
  "description": "A free and open source electronic laboratory notebook for research labs.",
  "funder": [
    {
      "@type": "Organization",
      "name": "CNRS",
      "url": "https://www.cnrs.fr/"
    },
    {
      "@type": "Organization",
      "name": "Institut Curie - Centre de Recherche",
      "url": "https://curie.fr/"
    },
    {
      "@type": "Organization",
      "name": "Atelier de la donnée ADOC Lorraine (projet financé avec le soutien du Fonds national pour la Science ouverte)",
      "url": "https://scienceouverte.univ-lorraine.fr/donnees-de-la-recherche-ul/donnees-de-la-recherche/"
    },
    {
      "@type": "Organization",
      "name": "Vrije Universiteit Brussel",
      "url": "https://www.vub.be/en"
    },
    {
      "@type": "Organization",
      "name": "Institute of Medical Biometry and Statistics, Faculty of Medicine and Medical Center – University of Freiburg, Germany",
      "url": "https://www.uniklinik-freiburg.de/imbi-en.html"
    },
    {
      "@type": "Organization",
      "name": "Georg-August-University Goettingen - Institute of Inorganic Chemistry",
      "url": "https://www.uni-goettingen.de/en/institute+of+inorganic+chemistry/28446.html"
    },
    {
      "@type": "Organization",
      "name": "Deltablot",
      "url": "https://www.deltablot.com/"
    },
    {
      "@type": "Organization",
      "name": "Department for the Development of Innovative Digital Use – French National Research Institute for Sustainable Development",
      "url": "https://www.ird.fr/"
    }
  ],
  "keywords": "eln, notebook, laboratory, lims, research, science, free, opensource, timestamp, legal proof",
  "license": "https://github.com/elabftw/elabftw/blob/master/LICENSE",
  "name": "eLabFTW, Deltablot",
  "contIntegration": "https://circleci.com/gh/elabftw/elabftw/tree/master",
  "developmentStatus": "Active",
  "issueTracker": "https://github.com/elabftw/elabftw/issues",
  "referencePublication": "https://joss.theoj.org/papers/10.21105/joss.00146",
  "readme": "https://github.com/elabftw/elabftw/#readme"
}

GitHub Events

Total
  • Fork event: 25
  • Create event: 162
  • Commit comment event: 6
  • Release event: 26
  • Issues event: 472
  • Watch event: 174
  • Delete event: 143
  • Member event: 1
  • Issue comment event: 854
  • Push event: 981
  • Pull request review comment event: 310
  • Pull request review event: 353
  • Pull request event: 279
Last Year
  • Fork event: 25
  • Create event: 164
  • Commit comment event: 6
  • Release event: 26
  • Issues event: 474
  • Watch event: 174
  • Delete event: 143
  • Member event: 1
  • Issue comment event: 859
  • Push event: 984
  • Pull request review comment event: 312
  • Pull request review event: 355
  • Pull request event: 281

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 8,480
  • Total Committers: 50
  • Avg Commits per committer: 169.6
  • Development Distribution Score (DDS): 0.175
Past Year
  • Commits: 643
  • Committers: 13
  • Avg Commits per committer: 49.462
  • Development Distribution Score (DDS): 0.148
Top Committers
Name Email Commits
Nicolas CARPi n****t@d****l 6,995
Nicolas CARPi n****i@g****m 784
Marcel Bolten g****b@m****e 256
Alexander Minges a****s@g****m 198
Mouss 1****a 62
PascalNOIRCi p****i@f****r 44
Marcel Bolten m****n@m****a 40
Scrutinizer Auto-Fixer a****r@s****m 13
anargam a****m 9
timfalcucci t****m@f****t 9
ManonStripes s****e@g****m 8
Sherjeel Shabih s****l@g****m 6
Max Schröder m****r@u****e 3
Manuel Lera-Ramirez m****4@g****m 3
SuyoungWang w****7@g****m 3
Oliver o****r 3
Mahadi Xion m****s@g****m 3
ForeverFloating 3****g 3
Filipe Maia f****a@g****m 2
Henning Timm h****m@t****e 2
Johannes Hermann l****r@w****e 2
Yaroslav Halchenko d****n@o****m 2
jcapellman j****n@h****m 2
jstigler 8****r 2
scapoor 4****r 1
manu0401 m****u@n****g 1
dubit0 b****7@w****e 1
Carlos KIKUTI c****i@c****r 1
Nicolas CARPi n****y@d****l 1
dependabot-preview[bot] 2****] 1
and 20 more...

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 692
  • Total pull requests: 417
  • Average time to close issues: 3 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 269
  • Total pull request authors: 32
  • Average comments per issue: 2.37
  • Average comments per pull request: 0.76
  • Merged pull requests: 315
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 361
  • Pull requests: 299
  • Average time to close issues: 15 days
  • Average time to close pull requests: 4 days
  • Issue authors: 160
  • Pull request authors: 19
  • Average comments per issue: 1.51
  • Average comments per pull request: 0.57
  • Merged pull requests: 230
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Aveyron-RetD (35)
  • NicolasCARPi (33)
  • kikuti (32)
  • ndrobnitzky (23)
  • nap84 (22)
  • chrhoh (18)
  • ELN-uzun (14)
  • alexander-haller (13)
  • hhchhcmxhf (11)
  • microbearlogist (10)
  • MaikeID (9)
  • jat255 (9)
  • ghost (9)
  • alexsvcl (8)
  • felipetraj (8)
Pull Request Authors
  • MoustaphaCamara (137)
  • NicolasCARPi (121)
  • MarcelBolten (88)
  • anargam (11)
  • jstigler (8)
  • Athemis (7)
  • manulera (4)
  • nap84 (3)
  • dependabot-preview[bot] (3)
  • SuyoungWang (3)
  • ForeverFloating (3)
  • Psychi1 (2)
  • spinnau (2)
  • Zack-83 (2)
  • seblu (2)
Top Labels
Issue Labels
feature request (283) bug (275) fixed in hypernext (145) enhancement (45) community support (32) severity:low (15) reproducible (13) question (12) priority:low (11) more info required (10) priority:medium (10) not reproducible (9) invalid (8) discussion (7) wontfix (7) Safari: why are you like this? (6) priority:high (5) ui/ux (5) documentation (3) module:scheduler (2) i18n (2) help wanted (1) blocked (1) module:compounds (1) css (1) support (1)
Pull Request Labels
bug (6) dependencies (3) javascript (3) feature request (2) invalid (1) php (1)

Dependencies

.github/workflows/codeql.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/autobuild v2 composite
  • github/codeql-action/init v2 composite
package.json npm
  • @types/bootstrap ^5.0.17 development
  • @types/dropzone ^5.7.4 development
  • @types/fancybox ^3.5.2 development
  • @types/file-saver ^2.0.1 development
  • @types/jquery ^3.5.1 development
  • @types/jqueryui ^1.12.14 development
  • @types/luxon ^3.0.0 development
  • @typescript-eslint/eslint-plugin ^5.3.0 development
  • @typescript-eslint/parser ^5.3.0 development
  • cypress ^10.0.0 development
  • eslint ^8.2.0 development
  • postcss ^8.4.7 development
  • postcss-scss ^4.0.3 development
  • stylelint ^14.0.1 development
  • stylelint-config-sass-guidelines ^9.0.1 development
  • webpack-bundle-analyzer ^4.1.0 development
  • 3dmol ^1.4.0
  • @deltablot/chemdoodle-web-mini ^9.2.1
  • @deltablot/malle ^1.0.1
  • @deltablot/open-vector-editor-umd ^18.0.0
  • @fancyapps/fancybox 3.5.*
  • @fullcalendar/bootstrap ^5.1.0
  • @fullcalendar/core ^5.1.0
  • @fullcalendar/daygrid ^5.1.0
  • @fullcalendar/interaction ^5.1.0
  • @fullcalendar/list ^5.1.0
  • @fullcalendar/timegrid ^5.1.0
  • bio-parsers ^9.0.1
  • bootstrap ^4.5.0
  • bootstrap-markdown-fa5 2.10.*
  • bootstrap-select ^1.13.18
  • css-loader ^6.0.0
  • css-minimizer-webpack-plugin ^4.0.0
  • dropzone ^5.8.0
  • expose-loader ^4.0.0
  • i18next ^22.0.6
  • jquery ^3.5.1
  • jquery-ui ^1.13.0
  • jsoneditor ^9.0.3
  • luxon ^3.0.1
  • marked ^4.0.10
  • mathjax-full ^3.2.0
  • mini-css-extract-plugin ^2.1.0
  • peggy 1.0.0
  • phpeggy ^1.0.0
  • popper.js 1.16.*
  • prismjs ^1.25.0
  • sass ^1.23.7
  • stream-browserify ^3.0.0
  • timers-browserify ^2.0.12
  • tinymce ^5.10.0
  • ts-loader ^9.1.1
  • typescript ^4.0.3
  • ve-range-utils ^2.6.3
  • ve-sequence-utils ^5.1.6
  • webpack ^5.9.0
  • webpack-cli ^5.0.0
composer.json packagist
  • codeception/c3 ^2.6 development
  • codeception/codeception ^5.0.1 development
  • codeception/module-asserts ^3.0.0 development
  • codeception/module-db ^3.0.0 development
  • codeception/module-phpbrowser ^3.0 development
  • codeception/module-rest ^3.2.0 development
  • fakerphp/faker ^1.13 development
  • friendsofphp/php-cs-fixer ^3.0.0 development
  • pyrech/composer-changelogs ^1.8.0 development
  • roave/security-advisories dev-master development
  • symfony/yaml ^6.0 development
  • aws/aws-sdk-php ^3.209
  • defuse/php-encryption 2.3.*
  • directorytree/ldaprecord ^2.0.3
  • ext-ctype *
  • ext-curl *
  • ext-exif *
  • ext-fileinfo *
  • ext-filter *
  • ext-gd *
  • ext-gettext *
  • ext-hash *
  • ext-json *
  • ext-ldap *
  • ext-mbstring *
  • ext-openssl *
  • ext-pdo *
  • ext-zip *
  • ezyang/htmlpurifier ^4.13
  • guzzlehttp/guzzle ^7.4.5
  • jblond/twig-trans ^1.0
  • lcobucci/jwt ^4.1
  • league/commonmark ^2.0
  • league/csv ^9.4
  • league/flysystem ^3.1
  • league/flysystem-aws-s3-v3 ^3.0
  • league/flysystem-memory ^3.0
  • maennchen/zipstream-php ^2.0.0
  • monolog/monolog ^3.1.0
  • mpdf/mpdf ^8.1.0
  • mpdf/qrcode ^1.0
  • onelogin/php-saml ^4.0.0
  • php >=8.0.1
  • robthree/twofactorauth ^1.7.0
  • symfony/console ^6.0
  • symfony/filesystem ^6.0
  • symfony/http-foundation ^6.0
  • symfony/mailer ^6.0
  • symfony/mime ^6.0
  • symfony/process ^6.0
  • twig/intl-extra ^3.3
  • twig/twig ^3.3.8
  • xemlock/htmlpurifier-html5 ^0.1.11
composer.lock packagist
  • 133 dependencies
.github/workflows/codespell.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite