2
2
[ ![ Build status] ( https://ci.appveyor.com/api/projects/status/br7pe6atlwdg5618/branch/master?svg=true )] ( https://ci.appveyor.com/project/G-Node/python-odml/branch/master )
3
3
![ Test coverage] ( https://coveralls.io/repos/github/G-Node/python-odml/badge.svg?branch=master )
4
4
[ ![ PyPI version] ( https://img.shields.io/pypi/v/odml.svg )] ( https://pypi.org/project/odML/ )
5
+ [ ![ Read the Docs] ( https://img.shields.io/readthedocs/python-odml )] ( https://python-odml.readthedocs.io/en/latest/ )
6
+
5
7
6
8
# odML (Open metaData Markup Language) core library
7
9
@@ -15,8 +17,43 @@ with the version control system **git**, but still want to use it, have a look a
15
17
documentation available on the [ git-scm website] ( https://git-scm.com/ ) .
16
18
17
19
18
- # Breaking changes
20
+ # odML Project page
21
+
22
+ More information about the project including related projects as well as tutorials and
23
+ examples can be found at our odML [ project page] ( https://g-node.github.io/python-odml ) .
24
+
25
+
26
+ # Getting started
27
+
28
+ ## Installation
29
+
30
+ * python-odml* is most conveniently installed via pip.
31
+
32
+ ```
33
+ pip install odml
34
+ ```
35
+
36
+ ## Tutorial and examples
37
+
38
+ - We have assembled a set of
39
+ [ tutorials] ( http://github.com/G-Node/python-odml/blob/master/doc/tutorial.rst " Python Tutorial ") .
40
+
41
+ ## Python convenience scripts
42
+
43
+ The Python installation features multiple convenience commandline scripts.
44
+
45
+ - ` odmlconversion ` : Converts odML files of previous file versions into the current one.
46
+ - ` odmltordf ` : Converts odML files to the supported RDF version of odML.
47
+ - ` odmlview ` : Render and browse local XML odML files in the webbrowser.
19
48
49
+ All scripts provide detailed usage descriptions by adding the ` help ` flag to the command.
50
+
51
+ odmlconversion -h
52
+ odmltordf -h
53
+ odmlview -h
54
+
55
+
56
+ # Breaking changes
20
57
21
58
odML Version 1.4 introduced breaking format and API changes compared to the previous
22
59
versions of odML. Files saved in the previous format versions can be converted to a 1.4
@@ -57,21 +94,6 @@ release notes](https://github.com/G-Node/python-odml/releases).
57
94
* lib32z1-dev
58
95
59
96
60
- # Installation
61
-
62
- The simplest way to install Python-odML is from PyPI using the pip tool:
63
-
64
-
65
- ```
66
- $ pip install odml
67
- ```
68
-
69
- On Ubuntu, the pip package manager is available in the repositories as ``` python-pip ``` .
70
-
71
- If this method is used, the appropriate Python dependencies are downloaded and installed
72
- automatically.
73
-
74
-
75
97
# Building from source
76
98
77
99
To download the Python-odML library please either use git and clone
@@ -95,15 +117,12 @@ To install the Python-odML library, enter the corresponding directory and run:
95
117
** Note** The master branch is our current development branch, not all features might be
96
118
working as expected. Use the release tags instead.
97
119
98
- # odML Project page
99
-
100
- More information about the project including related projects as well as tutorials and
101
- examples can be found at our odML [ project page] ( https://g-node.github.io/python-odml ) .
102
120
103
121
# Contributing and Governance
104
122
105
123
See the [ CONTRIBUTING] ( CONTIBUTING.md ) document for more information on this.
106
124
125
+
107
126
# Bugs & Questions
108
127
109
128
Should you find a behaviour that is likely a bug, please file a bug report at
0 commit comments