Skip to content

lzehl/python-odmltables

 
 

Repository files navigation

python-odmltables

An interface to convert odML structures to and from table-like representations, such as spreadsheets.

odMLtables provides a set of functions to simplify the setup, maintenance and usage of a metadata management structure using odML. In addition to the Python API, python-odmltables provides its main functionality also via a graphical user interface.

Dependencies

The following packages are required to use python-odmltables:

  • Python >= 2.7
  • numpy >= 1.8.2
  • quantities >= 0.10.1
  • odml >= 1.1
  • xlrd >= 0.9.4
  • xlwt >= 1.0.0
  • For building the documentation:
    • numpydoc >= 0.5
    • sphinx >= 1.2.2
  • For running tests:
    • nose >= 1.3.3
  • For the graphical user interface:
    • pyqt4 >= 4.11.4

Release Versions

Official release versions are available at the [Python Package Index] (https://pypi.python.org/pypi/python-odmltables/) and can be installed using pip:

$ pip install --process-dependency-links python-odmltables

Latest version

To install the latest version of odmltables you first need to download the odmltables source files and install it in a second step.

Download

The latest version of python-odmltables is available on [GitHub] (https://github.com/INM-6/python-odmltables). You can either use git and download python-odmltables directly under Linux using:

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

or alternatively download python-odmltables as ZIP file and unzip it to a folder.

Documentation

The documentation of odmltables is based on [sphinx] (http://www.sphinx-doc.org/en/stable/) and can be vizualized in multiple formats. E.g., to access the documentation in html format navigate to the documentation folder within odmltables and compile the html documentation:

$ cd /home/usr/toolbox/python-odmltables/doc
$ make html

All output format available can be listed using:

$ make -n

Installation

Linux

On Linux, to set up python-odmltables you navigate to your python-odmltables folder and install it via:

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

You can start the odmltables graphical wizard by calling:

$ odml-tables

Alternatively, you may navigate to the python-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 neuroscience python numpy scipy pip six
$ source activate neuroscience

Then navigate to the folder where you downloaded python-odmltables and run:

$ python setup.py install

On Windows, to run the graphical wizard, execute odml-tables.exe in the Anaconda/Envs/neuroscience/Scripts folder in your User directory.

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

$ python odmltables-gui.py

Bugs

If you observe a bug in odMLtables please add a bug report at [the github bug tracker] (https://github.com/INM-6/python-odmltables/issues)

About

An interface to convert odML structues to and from table-like representations, such as spreadsheets

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%