Skip to content

Commit b07b845

Browse files
jliermannjliermann
authored
Merge pull request #433 from NFDI4Chem/localisation
Localisation
2 parents 0bbc103 + 221a724 commit b07b845

File tree

3 files changed

+94
-94
lines changed

3 files changed

+94
-94
lines changed

‎docs/10_domains/20_physical_chemistry.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ As mentioned, the data produced in physical chemistry and its diverse sub-discip
2222

2323
For effective data management, software tools should be selected in a uniform manner within a project or research group with the aim to [organize](/docs/data_organisation) and streamline workflows. This involves establishing clear usage guidelines, including metadata templates drawn from minimum information standards for a given method, where available. These should be outlined in a [data management plan (DMP)](/docs/dmp) for each project. Many universities supply tools and templates for DMPs (see the [respective article](/docs/dmp) for more information).
2424

25-
An [electronic lab notebooks (ELNs)](/docs/eln) helps in the day-to-day planning and structured documentation of experiments, while some also assist in data workflow management. For disciplines with diverse research, ELNs must be flexible and customizable. Certain universities may have a central option, while each research group may chose what best fits their needs and resources if they are able to host or procure their own solution. The [ELN-Finder](https://eln-finder.ulb.tu-darmstadt.de/search?f.K03=Pharmacy,equals&spc.page=1) lists many options and the article on [choosing an ELN](/docs/choose_eln) provides further assistance:
25+
An [electronic lab notebooks (ELN)](/docs/eln) helps in the day-to-day planning and structured documentation of experiments, while some also assist in data workflow management. For disciplines with diverse research, ELNs must be flexible and customizable. Certain universities may have a central option, while each research group may chose what best fits their needs and resources if they are able to host or procure their own solution. The [ELN-Finder](https://eln-finder.ulb.tu-darmstadt.de/search?f.K03=Pharmacy,equals&spc.page=1) lists many options and the article on [choosing an ELN](/docs/choose_eln) provides further assistance:
2626

2727
<ElnFinder subDisc="Physical chemistry" />
2828

2929
In addition to ELNs, tools such as local repository and research dat management tools can assist in making data publication ready.
3030

31-
For those writing scripts and developing research software solutions, [Git](https://git-scm.com/) is a highly recommended versioning tool. May universities also have their own instances of [GitLab](https://about.gitlab.com/) to assist in managing software projects.
31+
For those writing scripts and developing research software solutions, [Git](https://git-scm.com/) is a highly recommended versioning tool. Many universities also have their own instances of [GitLab](https://about.gitlab.com/) to assist in managing software projects.
3232

3333
Specifically for research data, [DataLad](https://www.datalad.org/), which is built on top of git, can greatly assist in tracking the metadata while processing and analyzing data. While it works for steps carried out with GUI applications, its true power comes in handy for those using script-based analysis and processing steps.
3434

‎docs/40_smartlab/10_eln.mdx

+74-92
Original file line numberDiff line numberDiff line change
@@ -4,113 +4,95 @@ slug: "/eln"
44
id: "eln"
55
---
66

7-
import useBaseUrl from '@docusaurus/useBaseUrl';
7+
import useBaseUrl from "@docusaurus/useBaseUrl";
8+
import { BulletContainer, BulletBox } from "@site/src/components/BulletBox";
89

910
# Electronic Lab Notebooks (ELNs)
1011

1112
## Introduction
1213

13-
The world around us is constantly evolving. For example, the smartphones in our pockets are much faster than an 80s supercomputer that could barely fit in an average bedroom. Unfortunately, this development has not yet reached our laboratories. The paper lab notebook is as common as it was 100 years ago, and the way chemical research data is documented - literally with pen and paper - has made little progress in the last century.
14+
The world around us is constantly evolving. For example, the smartphones in our pockets are much faster than an 80s supercomputer that could barely fit in an average bedroom. Unfortunately, this development has not yet reached our laboratories. The paper lab notebook is as common as it was 100 years ago, and the way chemical research data is documented - literally with pen and paper - has made little progress in the last century.
1415

1516
Bringing advances in information technology to our labs (smartlab) does not necessarily mean tablets & touchscreens everywhere in your lab. The term smartlab is more about the interconnectivity of the entire workflow and the handling of research data according to the [FAIR principles](/docs/fair). ELNs help assign rich [metadata](/docs/metadata) to experiments and make the data collected traceable and reusable. With the ability to transfer data from instrumentation directly into the ELN, the ELN has all the data in one place. From the ELN, data can be easily published to repositories and transferred to long-term [archiving](/docs/data_storage).
1617

1718
One of the most important things that distinguishes an ELN from a blank piece of paper is the ability to document [metadata](/docs/metadata) in a structured and ideally human- and machine-readable way. For more information on the differences between simple systems, ELNs and Laboratory Information Management Systems (LIMS), see the following overview.
1819

19-
<div className='container'>
20-
<div className='row'>
21-
<div className="col" style={{ width: 300, padding: 10, }}>
22-
<div className="button button--lg button--primary" style={{ width: 300, height: 480, padding: 20, }}>
23-
<h3>Simple system</h3>
24-
<ul>
25-
<li>Enter text</li>
26-
<li>Add notes</li>
27-
<li>Add files as attachments</li>
28-
<li>Sharing</li>
29-
<li>Searching</li>
30-
</ul>
31-
<em>e.g., Evernote GoogleDrive, Dropbox, MS Sharepoint</em>
32-
</div>
33-
</div>
34-
<div className="col" style={{ width: 300, padding: 10, }}>
35-
<div className="button button--lg button--secondary" style={{ width: 300, height: 480, padding: 20, }}>
36-
<h3>Electronic Lab Notebook (ELN)</h3>
37-
<ul>
38-
<li>Structured metadata in human and machine-readable formats</li>
39-
<li>Discipline-specific functions / editors</li>
40-
<li>Rights management</li>
41-
<li>Audit trail</li>
42-
<li>API</li>
43-
</ul>
44-
<em>e.g., Labfolder, RSpace, eLabFTW, Labguru</em>
45-
</div>
46-
</div>
47-
<div className="col" style={{ width: 300, padding: 10, }}>
48-
<div className="button button--lg button--primary" style={{ width: 300, height: 480, padding: 20, }}>
49-
<h3>Laboratory Information Management System</h3>
50-
<ul>
51-
<li>Sample management</li>
52-
<li>Instrument integration</li>
53-
<li>Electronic signatures</li>
54-
<li>Reporting or statistics modules</li>
55-
</ul>
56-
<em>e.g., Benchling, Starlims, Limesophy</em>
57-
</div>
58-
</div>
59-
</div>
60-
</div>
61-
20+
<BulletContainer>
21+
<BulletBox>
22+
<h3>Simple system</h3>
23+
<ul>
24+
<li>Enter text</li>
25+
<li>Add notes</li>
26+
<li>Add files as attachments</li>
27+
<li>Sharing</li>
28+
<li>Searching</li>
29+
</ul>
30+
<em>e.g., Evernote GoogleDrive, Dropbox, MS Sharepoint</em>
31+
</BulletBox>
32+
<BulletBox secondary>
33+
<h3>Electronic Lab Notebook (ELN)</h3>
34+
<ul>
35+
<li>Structured metadata in human and machine-readable formats</li>
36+
<li>Discipline-specific functions / editors</li>
37+
<li>Rights management</li>
38+
<li>Audit trail</li>
39+
<li>API</li>
40+
</ul>
41+
<em>e.g., Labfolder, RSpace, eLabFTW, Labguru</em>
42+
</BulletBox>
43+
<BulletBox>
44+
<h3>Laboratory Information Management System</h3>
45+
<ul>
46+
<li>Sample management</li>
47+
<li>Instrument integration</li>
48+
<li>Electronic signatures</li>
49+
<li>Reporting or statistics modules</li>
50+
</ul>
51+
<em>e.g., Benchling, Starlims, Limesophy</em>
52+
</BulletBox>
53+
</BulletContainer>
6254

6355
## Advantages of an ELN
6456

6557
ELNs help to link experimental descriptions directly to the collected data so that all information can be found in one place. Furthermore, data loss is avoided by secure data storage and backups. Storing all the data in one central place helps also with knowledge management because the data is easily findable and accessible, even for new members in a research project. The biggest advantage of an ELN is that [metadata](/docs/metadata) is stored in a structured and [standardised](/docs/format_standards) way. This also helps with publishing research results and transferring research data to a repository.
6658

67-
68-
<div className='container'>
69-
<div className='row'>
70-
<div className="col" style={{ width: 400, padding: 10, }}>
71-
<div className="button button--lg button--primary" style={{ width: 400, height: 250, padding: 20, }}>
72-
<h3>Avoid Data Loss</h3>
73-
<ul>
74-
<li>Linking experimental descriptions to collected data (analogue and digital)</li>
75-
<li>Secure data storage, backups</li>
76-
</ul>
77-
</div>
78-
</div>
79-
<div className="col" style={{ width: 400, padding: 10, }}>
80-
<div className="button button--lg button--secondary" style={{ width: 400, height: 250, padding: 20, }}>
81-
<h3>Knowledge Management</h3>
82-
<ul>
83-
<li>Data is findable</li>
84-
<li>Data is accessible</li>
85-
<li>Data is available, even after change of personnel</li>
86-
</ul>
87-
</div>
88-
</div>
59+
<BulletContainer>
60+
<BulletBox>
61+
<h3>Avoid Data Loss</h3>
62+
<ul>
63+
<li>Linking experimental descriptions to collected data (analogue and digital)</li>
64+
<li>Secure data storage, backups</li>
65+
</ul>
66+
</BulletBox>
67+
<BulletBox secondary>
68+
<h3>Knowledge Management</h3>
69+
<ul>
70+
<li>Data is findable</li>
71+
<li>Data is accessible</li>
72+
<li>Data is available, even after change of personnel</li>
73+
</ul>
74+
</BulletBox>
75+
<div className="row buttons">
76+
<img
77+
alt="Data LifeCycle"
78+
width="80%"
79+
src={useBaseUrl("/img/topics/FAIR_data_principles.png")}
80+
/>
8981
</div>
90-
<div className='row'>
91-
<img className='col col--6 col--offset-3' alt="Data LifeCycle" src={useBaseUrl('/img/topics/FAIR_data_principles.png')} vspace="10" hspace="10"/>
92-
</div>
93-
<div className='row'>
94-
<div className="col" style={{ width: 400, padding: 10, }}>
95-
<div className="button button--lg button--secondary" style={{ width: 400, height: 250, padding: 20, }}>
96-
<h3>Standardised Documentation</h3>
97-
<ul>
98-
<li>Structured and standardised collection of metadata</li>
99-
<li>Generation of interoperable (meta)data</li>
100-
</ul>
101-
</div>
102-
</div>
103-
<div className="col" style={{ width: 400, padding: 10, }}>
104-
<div className="button button--lg button--primary" style={{ width: 400, height: 250, padding: 20, }}>
105-
<h3>Publication</h3>
106-
<ul>
107-
<li>Data provision for publication of research results</li>
108-
<li>Simple transfer of data to repositories</li>
109-
</ul>
110-
</div>
111-
</div>
112-
</div>
113-
</div>
114-
82+
<BulletBox secondary>
83+
<h3>Standardised Documentation</h3>
84+
<ul>
85+
<li>Structured and standardised collection of metadata</li>
86+
<li>Generation of interoperable (meta)data</li>
87+
</ul>
88+
</BulletBox>
89+
<BulletBox >
90+
<h3>Publication</h3>
91+
<ul>
92+
<li>Data provision for publication of research results</li>
93+
<li>Simple transfer of data to repositories</li>
94+
</ul>
95+
</BulletBox>
96+
</BulletContainer>
11597

11698
FAIR Image Attribution: SangyaPundir, [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0).

‎src/components/BulletBox.js

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
function BulletContainer({ children }) {
2+
return <div className="container row">{children}</div>;
3+
}
4+
5+
function BulletBox({ children, secondary }) {
6+
let boxStyle = secondary ? "button--secondary" : "button--primary";
7+
8+
return (
9+
<div
10+
className={"col button button--lg " + boxStyle}
11+
style={{ padding: "0.75em", margin: "0.4em", flexGrow: 1 }}
12+
>
13+
{children}
14+
</div>
15+
);
16+
}
17+
18+
export { BulletContainer, BulletBox };

0 commit comments

Comments
 (0)