Metadata-Version: 2.0
Name: nixio
Version: 1.3.0
Summary: Python bindings for NIX
Home-page: https://github.com/G-Node/nixpy
Author: Christian Kellner, Adrian Stoewer, Andrey Sobolev, Jan Grewe, Balint Morvai, Achilleas Koutsou
Author-email: kellner@bio.lmu.de
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Scientific/Engineering
Requires-Dist: h5py
Requires-Dist: numpy

.. image:: https://travis-ci.org/G-Node/nixpy.svg?branch=v1.3
    :target: https://travis-ci.org/G-Node/nixpy
.. image:: https://ci.appveyor.com/api/projects/status/8hi7323w3lijr16y/branch/master?svg=true
    :target: https://ci.appveyor.com/project/achilleas-k/nixpy/branch/master
.. image:: https://coveralls.io/repos/github/G-Node/nixpy/badge.svg?branch=v1.3
    :target: https://coveralls.io/github/G-Node/nixpy?branch=v1.3

----

Versions
--------

This repository's `master` is the development branch of *NIXPY*.
It is not guaranteed to build or work properly with the *NIX* (HDF5) backend.
At times it may not even work at all.
We strongly recommend using the latest stable version, which can be found on PyPI as nixio_.

About NIXPY
-----------

The *NIXPY* project is an extension to `NIX <https://github.com/G-Node/nix>`_ and provides Python bindings for *NIX*.

Getting Started
---------------

The simplest way to install *NIXPY* is from PyPI using pip. The name of the package is nixio_::

    pip install nixio

Bindings for C++ NIX
--------------------

The setup script will automatically build the bindings for *NIX* if it is detected on the system, otherwise only the pure Python version will be installed.

For instructions on building *NIX*, see the `NIX README <https://github.com/G-Node/nix/blob/master/README.rst>`_ file.


To check if installed properly
------------------------------

Try importing nixio::

    >>> import nixio
    >>>

If python successfully executes :code:`import nixio`, the installation went well.
Check out the API documentation for further tutorials.


NIXPY API Documentation
-----------------------

The API documentation can be found `here <http://g-node.github.io/nixpy/>`_.


.. _nixio: https://pypi.python.org/pypi/nixio


