Skip to content

Commit 8de0721

Browse files
committed
[docs] small changes
1 parent 8a0b604 commit 8de0721

2 files changed

Lines changed: 27 additions & 27 deletions

File tree

docs/data_model.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ exchanged. In oder to allow interoperability we need both a common
55
(meta) data model, the format in which the metadata are exchanged, and
66
a common terminology.
77

8-
Here we briefly describe the data model of the odML. It is based on
9-
the idea of key-value pairs like temperature = 26°C.
8+
Here, we briefly describe the *odML* data model. It is based on
9+
the idea of key-value pairs like ``temperature = 26°C``.
1010

11-
We tried to keep the model as simple as possible while being flexible,
12-
allowing interoperability, and being customizable. The model defines
13-
four entities (Property, Section, Value, RootSection) who's relations
14-
and elements are shown in the figure below.
11+
The model is as simple as possible while being flexible, allowing
12+
interoperability, and being customizable. The model defines four
13+
entities (Property, Section, Value, RootSection) whose relations and
14+
elements are shown in the figure below.
1515

1616
![odml_logo](./images/erModel.png "odml data model")
1717

18-
Property and Section entities are the core of the odml. A Section
19-
contains Properties and can further have subsection thus building a
20-
tree-like structure. The model further does not control the content
21-
which is a risk, on the one hand, but offers the flexibility we
22-
consider essential.
18+
Property and Section are the core entities. A Section contains
19+
Properties and can further have subsection thus building a tree-like
20+
structure. The model does not constrain the content, which offers the
21+
flexibility essential for comprehensive annotation of neuroscience
22+
data.

docs/index.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# odml
1+
# odML
22

33
<img src="./images/odMLLogo.png" alt="odml" style="width: 150px;"/>
44

5-
odML (open metadata Markup Language) is an [data model](./data_model.md) for storing
6-
arbitrary metadata. The underlying data model offers a way to store
7-
metadata in a structured human- and machine-readable way. Well
8-
organized metadata management is a key component to guarantee
9-
reproducibility of experiments and to track provenance of performed
10-
analyses.
5+
odML (open metadata Markup Language) is a file format for storing
6+
arbitrary metadata. The underlying [data model](./data_model.md)
7+
offers a way to store metadata in a structured human- and
8+
machine-readable way. Well organized metadata management is a key
9+
component to guarantee reproducibility of experiments and to track
10+
provenance of performed analyses.
1111

1212

1313
*python-odml* is the python library for reading and writing odml metadata files. It is a registered research resource with
@@ -22,16 +22,16 @@ the [RRID:SCR_001376](https://scicrunch.org/browse/resources/SCR_001376)
2222

2323
## Viewer/Editor
2424

25-
- Editor for odml files [odml-ui](https://github.com/g-node/odml-ui "odml-ui - editor for odml metadata files")
26-
- Converter for odml files to form or spreadsheets [odmlTables](https://github.com/INM-6/python-odmltables).
25+
- [odml-ui](https://github.com/g-node/odml-ui "odml-ui - editor for odml metadata files"): Graphical editor
26+
- [odmlTables](https://github.com/INM-6/python-odmltables) Spreadsheet interface (by INM-6 FZ JÛlich) for odml files.
2727

2828
## Terminologies
29-
30-
*odml* does not enforce standardization, but welcomes it. We assembled
31-
definitions of terms that can be used to provide metadata,
32-
i.e. [odml-terminologies](https://github.com/G-Node/odml-terminologies). An odml-file
33-
can be based on such a terminology. In that case one does not need to
34-
provide definitions since they are part of the linked terminology.
29+
*odML* facilitates and encourages standardization by
30+
providing
31+
[terminologies](https://github.com/G-Node/odml-terminologies). An
32+
odml-file can be based on such a terminology. In that case one does
33+
not need to provide definitions since they are part of the linked
34+
terminology.
3535

3636
* * *
3737

@@ -68,7 +68,7 @@ This project is open source published under an MIT license-like see [license fil
6868

6969
If you use *odml*, it would be much appreciated if you would cite it in publications with its identifier RRID:SCR_001376 and/or the reference:
7070

71-
*Grewe J., Wachtler T., and Benda J. (2011). A bottom-up approach to data annotation in neurophysiology. Front. Neuroinform. 5:16*
71+
*Grewe J., Wachtler T., and Benda J. (2011). A bottom-up approach to data annotation in neurophysiology. Front. Neuroinform. 5:16, [doi:10.3389/fninf.2011.00016](https://doi.org/10.3389/fninf.2011.00016)*
7272

7373

7474
### Referenced By

0 commit comments

Comments
 (0)