odML libraries
==============

The Python-odML library is available on
`GitHub <https://github.com/G-Node/python-odml>`_. If you are not familiar with 
the version control system **git**, but still want to use it, have a look at 
the documentaion available on the `git-scm website <https://git-scm.com/>`_. 

Dependencies
------------

* The Python-odML library runs under Python 2.7. 
* The Python-odML library depends on Enum (version 0.4.4).


Installation
------------

To download the Python-odML library please either use git and clone the 
repository from GitHub:

	$ cd /home/usr/toolbox/
	$ git clone https://github.com/G-Node/python-odml.git
	
... or if you don't want to use git download the ZIP file also provided on 
GitHub to your computer (e.g. as above on your home directory under a "toolbox" 
folder).

To install the Python-odML library, enter the corresponding directory and run::

	$ cd /home/usr/toolbox/python-odml/
	$ python setup.py install
	

Documentation
-------------

[Documentation](http://g-node.github.io/python-odml)

Bugs & Questions
----------------

Should you find a behaviour that is likely a bug, please file a bug report at 
[the github bug tracker](https://github.com/G-Node/python-odml/issues).

If you have questions regarding the use of the library or the editor, ask
the question on [Stack Overflow](http://stackoverflow.com/), be sure to tag
it with `odml` and we'll do our best to quickly solve the problem.
