The Python G-Node Client is a library, that provides access to the G-Node REST-API for the Python programming language. The client provides a high-level interface to this service which includes useful features such as lazy loading, caching and the prevention of so called lost updates. Further more this client library can handle native neo and odml objects.
Using the G-Node Client requires some other python packages to be installed:
- neo A package for representing electrophysiology data in Python
- quantities Arithmetic and conversions of physical quantities
- odml Open metadata markup language
- appdirs Get appropriate platform-specific user dirs
- request-futures Asynchronous Python HTTP Request
- h5py HDF5 for Python
In order to build the documentation and install the package using setup.py the following packages are recommended.
All dependencies with the exception of the python odml package, can be installed using easy_install. On debian bases linux distributions one install packages for quantities (python-quantities), neo (python-neo), sphinx (python-sphinx), setuptools (python-setuptools) and h5py (python-h5py) using the package manager (apt-get, aptitude).
To install the odml package use the following commands, with appropriate permissions (e.g. with sudo for the last command).
git clone https://github.com/G-Node/python-odml.git
cd python-odml
python setup.py install
To install the client invoke the following commands using appropriate permissions.
git clone https://github.com/G-Node/python-gnode-client.git
cd python-gnode-client
python setup.py install
More information about how to use the client can be found in the online documentation.
If this packages sphinx and setuptools are installed on your system, the documentation can also be build from the cloned repository by executing the following command:
python setup.py build_sphinx