Skip to content

Commit b7373a7

Browse files
committed
[docs] preparations for github pages
1 parent 23f9181 commit b7373a7

3 files changed

Lines changed: 89 additions & 0 deletions

File tree

docs/_config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
theme: jekyll-theme-leap-day
2+
title: Open metadata markup language - omdl -
3+
description: data model for storing arbitratry metadata
4+
show_downloads: "false"

docs/images/odMLLogo.png

11.6 KB
Loading

docs/index.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
![odml_logo](./images/odMLLogo.png "odml")
2+
3+
4+
odML (open metadata Markup Language) is an data model for storing
5+
arbitrary metadata. Teh underlying datamodel offers a way to store
6+
metadata in a structured human- and machine-readable way. Well
7+
organized metadata management is a key component to guarantee
8+
reproducibility of experiments and to track provenance of performed
9+
analyses.
10+
11+
12+
*python-odml* is the python library for reading and writing odml metadata files. It is a registered research resource with
13+
the [RRID:SCR_001376](https://scicrunch.org/browse/resources/SCR_001376)
14+
.
15+
16+
## APIs
17+
18+
- [*odml* python library](https://github.com/g-node/python-odml "python library for odml files"). Python library for reading and writing odml files.
19+
- [*java-odml-lib*](https://github.com/g-node/odml-java-lib "Java library for odml files") Java implementation of the data model.
20+
- [*matlab-odml*](https://github.com/g-node/matlab-odml "Matlab interface for odml files") Matlab interface for odml files.
21+
22+
## Viewer/Editor
23+
24+
- Editor for odml files [odml-ui](https://github.com/g-node/odml-ui "odml-ui - editor for odml metadata files")
25+
- Converter for odml files to form or spreadsheets [odmlTables](https://github.com/INM-6/python-odmltables).
26+
27+
* * *
28+
29+
# Getting started
30+
31+
## Installation
32+
33+
*python-odml* is most conveniently installed via pip.
34+
35+
```
36+
pip install odml
37+
```
38+
39+
## Tutorial and examples
40+
41+
- We have assembled a set of
42+
[tutorials](http://g-node.github.io/python-odml/doc/tutorial.hrst "Python Tutorial").
43+
44+
# Getting support
45+
46+
If you experience problems using *odml* feel free to join our IRC channel
47+
[#gnode at FreeNode](irc://irc.freenode.net/gnode) or write an email to <dev@g-node.org>. If you find a
48+
bug please report it using
49+
the [project issue tracker](https://github.com/G-Node/python-odml/issues "pyhton-odml issue tracker").
50+
51+
52+
# License
53+
54+
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.
55+
56+
* * *
57+
58+
## Citing
59+
60+
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:
61+
62+
*Grewe J., Wachtler T., and Benda J. (2011). A bottom-up approach to data annotation in neurophysiology. Front. Neuroinform. 5:16*
63+
64+
65+
### Referenced By
66+
67+
Dragly et al (2018) [doi:10.3389/fninf.2018.000169](https://doi.org/10.3389/fninf.2018.000169)
68+
Brochier et al (2018) [doi:10.1038/sdata.2018.55](https://doi.org/10.1038/sdata.2018.55)
69+
Moucek et al (2017) [doi:10.1038/sdata.2016.121](https://doi.org/10.1038/sdata.2016.121)
70+
Papez et al (2017) [doi:10.3389/fninf.2017.00024](https://doi.org/10.3389/fninf.2017.00024)
71+
Bigdely-Shamlo et al (2016) [doi:10.3389/fninf.2016.00007](https://doi.org/10.3389/fninf.2016.00007)
72+
Rübel et al (2016) [doi:10.3389/fninf.2016.00048](https://doi.org/10.3389/fninf.2016.00048)
73+
Wiener et al (2016) [doi:10.1016/j.neuron.2016.10.037](https://doi.org/10.1016/j.neuron.2016.10.037)
74+
Zehl et al (2016) [doi:10.3389/fninf.2016.00026](https://doi.org/10.3389/fninf.2016.00026)
75+
Jayapandian et al (2015) [doi:10.3389/fninf.2015.00004](https://doi.org/10.3389/fninf.2015.00004)
76+
Jezek et al (2015) [doi:10.3389/fninf.2015.00003](https://doi.org/10.3389/fninf.2015.00003)
77+
Kocaturk et al (2015) [doi:10.3389/fnbot.2015.00008](https://doi.org/10.3389/fnbot.2015.00008)
78+
Maccione et al (2015) [doi:10.1016/j.brainresbull.2015.07.008](https://doi.org/10.1016/j.brainresbull.2015.07.008)
79+
Vanek et al (2015) [doi:10.1109/Informatics.2015.7377849](https://doi.org/10.1109/Informatics.2015.7377849)
80+
Garcia et al (2014) [doi:10.3389/fninf.2014.00010](https://doi.org/10.3389/fninf.2014.00010)
81+
Moucek et al (2014) [doi:10.3389/fninf.2014.00020](https://doi.org/10.3389/fninf.2014.00020)
82+
Sobolev et al (2014) [doi:10.3389/fninf.2014.00015](https://doi.org/10.3389/fninf.2014.00015)
83+
Cockfield et al (2013) [doi:10.3389/fninf.2013.00020](https://doi.org/10.3389/fninf.2013.00020)
84+
Papez et al (2013) [doi:10.1109/BIBM.2013.6732554](https://doi.org/10.1109/BIBM.2013.6732554)
85+
Bakker et al (2012) [doi:10.3389/fninf.2012.00030](https://doi.org/10.3389/fninf.2012.00030)

0 commit comments

Comments
 (0)