Skip to content

Latest commit

 

History

History
76 lines (49 loc) · 2.56 KB

README.rst

File metadata and controls

76 lines (49 loc) · 2.56 KB

odML libraries and editor

https://travis-ci.org/G-Node/python-odml.svg?branch=master https://coveralls.io/repos/github/G-Node/python-odml/badge.svg?branch=master

The Python-odML library (including the odML-Editor) is available on GitHub. 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.

Dependencies

  • Python 2.7 or 3.5
  • Python packages:
    • enum (version 0.4.4)
    • lxml (version 3.7.2)
  • These packages will be downloaded and installed automatically if the pip method is used to install odML. Alternatively, they can be installed from the OS package manager. On Ubuntu, they are available as:
    • python-enum
    • python-lxml
  • If you prefer installing using the Python package manager, the following packages are required to build the lxml Python package on Ubuntu 14.04:
    • libxml2-dev
    • libxslt1-dev
    • lib32z1-dev

Installation

The simplest way to install Python-odML is from PyPI using the pip tool:

$ pip install odml

On Ubuntu, the pip package manager is available in the repositories as python-pip.

If this method is used, the appropriate Python dependencies (enum and lxml) are downloaded and installed automatically.

Building from source

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

$ git clone https://github.com/G-Node/python-odml.git

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 python-odml
$ python setup.py install

Note The master branch is our current development branch, not all features might be working as expected. Use the release tags instead.

Documentation

Documentation

Bugs & Questions

Should you find a behaviour that is likely a bug, please file a bug report at the github bug tracker.

If you have questions regarding the use of the library or the editor, feel free to join the #gnode IRC channel on freenode.