Skip to content

Commit 20cea03

Browse files
committed
[docs/index] Add tools summarization
1 parent 21b5eef commit 20cea03

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

docs/index.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,31 @@
55
odML (open metadata Markup Language) is a file format for storing
66
arbitrary metadata. The underlying [data model](./data_model.md)
77
offers a way to store metadata in a structured human- and
8-
machine-readable way. Well organized metadata management is a key
8+
machine-readable way. Well organized metadata management is a key
99
component to guarantee reproducibility of experiments and to track
1010
provenance of performed analyses.
1111

1212

13-
*python-odml* is the python library for reading and writing odml metadata files. It is a registered research resource with
14-
the [RRID:SCR_001376](https://scicrunch.org/browse/resources/SCR_001376)
13+
*python-odml* is the python library for reading and writing odml metadata files.
14+
It is a registered research resource with the
15+
[RRID:SCR_001376](https://scicrunch.org/browse/resources/SCR_001376)
1516
.
1617

17-
## APIs
18+
## The odML eco system
19+
20+
### APIs
1821

1922
- [*odml* python library](https://github.com/g-node/python-odml "python library for odml files"). Python library for reading and writing odml files.
2023
- [*java-odml-lib*](https://github.com/g-node/odml-java-lib "Java library for odml files") Java implementation of the data model.
2124
- [*matlab-odml*](https://github.com/g-node/matlab-odml "Matlab interface for odml files") Matlab interface for odml files.
2225

23-
## Viewer/Editor
26+
### Viewer/Editor
2427

2528
- [odml-ui](https://github.com/g-node/odml-ui "odml-ui - editor for odml metadata files"): Graphical editor
2629
- [odmlTables](https://github.com/INM-6/python-odmltables) Spreadsheet interface (by INM-6 FZ JÛlich) for odml files.
2730

28-
## Terminologies
29-
*odML* facilitates and encourages standardization by
30-
providing
31+
### Terminologies
32+
*odML* facilitates and encourages standardization by providing
3133
[terminologies](https://github.com/G-Node/odml-terminologies). An
3234
odml-file can be based on such a terminology. In that case one does
3335
not need to provide definitions since they are part of the linked
@@ -101,20 +103,22 @@ The source code of the converter can be found
101103
## Support
102104

103105
If you experience problems using *odml* feel free to join our IRC channel
104-
[#gnode at FreeNode](irc://irc.freenode.net/gnode) or write an email to <[email protected]>. If you find a
105-
bug please report it using
106-
the [project issue tracker](https://github.com/G-Node/python-odml/issues "pyhton-odml issue tracker").
106+
[#gnode at FreeNode](irc://irc.freenode.net/gnode) or write an email to <[email protected]>.
107+
If you find a bug please report it using the
108+
[project issue tracker](https://github.com/G-Node/python-odml/issues "pyhton-odml issue tracker").
107109

108110

109111
## License
110112

111-
This project is open source published under an MIT license-like see [license file](https://github.com/G-Node/python-odml/blob/master/LICENSE) for details.
113+
This project is open source published under an MIT license-like see
114+
[license file](https://github.com/G-Node/python-odml/blob/master/LICENSE) for details.
112115

113116
* * *
114117

115118
## Citing
116119

117-
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:
120+
If you use *odml*, it would be much appreciated if you would cite it in publications with
121+
its identifier RRID:SCR_001376 and/or the reference:
118122

119123
*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)*
120124

0 commit comments

Comments
 (0)