Prerequisites / Installation

odMLtables is a pure Python package so that it should be easy to install on any system.

Dependencies

The following packages are required to use odMLtables:

  • xlrd >= 0.9.4

  • xlwt >= 1.0.0

  • numpy >= 1.8.2

  • quantities >= 0.10.1

  • odml >= 1.4.2

  • future >= 0.16.0

  • argparse >= 1.0.0

  • enum34 >= 0.4.6 in case of python_version<”3.4”

For installation of the graphical user interface the additional requirements are:

  • PyQt5>=5.0.0

and for building the documentation locally you need

  • numpydoc>=0.5.0

  • sphinx>=1.2.2

and running the odMLtables tests requires

  • pytest>=3.0.0

Installation of released versions

Independent of the operating system odMLtables can be installed using pip:

pip install odMLtables

For installation of the graphical user interface run:

pip install odMLtables[gui]

Especially for the graphical user interface we recommend using Python 3. To be able to run the graphical user interface with Python 2.x please install PyQt version 5.0 or later manually (see below).

Installation from source

The latest version of odMLtables is available on GitHub. You can either use git and download odMLtables directly under Linux using:

cd /home/usr/toolbox/
git clone https://github.com/INM-6/python-odmltables.git

or alternatively download odMLtables as ZIP file and unzip it.

Linux

On Linux, to set up odMLtables navigate to your odMLtables folder and install odMLtables core via:

cd /home/usr/toolbox/python-odmltables/
python setup.py install

For installing also the grapical user interface run:

cd /home/usr/toolbox/python-odmltables/
pip install .[gui]

Please note that when using Python 2, the PyQt5 module needs to be manually installed beforehand, eg using conda:

conda install pyqt5

Now you can start the odMLtables graphical wizard by calling:

odmltables

Alternatively, you may navigate to the odMLtables folder and run:

./odmltables-gui

Windows/Mac OS X

On non-Linux operating systems we recommend using the Anaconda Python distribution, and installing all dependencies in a Conda environment, e.g.:

conda create -n metadataenv python numpy scipy pip six

activate metadataenv

Then navigate to the folder where you downloaded odMLtables and run:

python setup.py install

or:

pip install .

For installing also the odMLtables gui, please run:

pip install .[gui]

Please note, that for Python 2 you need to manually install PyQt when using the graphical user interface, e.g. using conda:

conda install PyQt>=5.0.0

On Windows, to run the graphical wizard, execute the odmltables.exe in the Anaconda/Envs/metadataenv/Scripts in your User directory.

Alternatively, on Windows or Mac OS X you may navigate to the odMLtables folder and run:

python odmltables-gui.py

Bugs

If you observe a bug in odMLtables please add a bug report at the GitHub issue tracker