Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 2.1 KB

README.md

File metadata and controls

73 lines (54 loc) · 2.1 KB

Introduction

This package provides a Python API to open, create, and manipulate NeXus data written in the HDF5 format. It also includes a remote file server to allow files to be opened across a network. The 'nexusformat' package provides the underlying API for NeXpy, which provides a GUI interface for visualizing and analyzing NeXus data.

The latest development version is always available from NeXpy's GitHub repository.

Installing and Running

Released versions of nexusformat can be installed using either

    $ pip install nexusformat

or

    $ easy_install nexusformat

The source code can be downloaded from the NeXpy Git repository:

    $ git clone http://github.com/nexpy/nexusformat.git

To install in the standard Python location:

    $ python setup.py install

To install in an alternate location:

    $ python setup.py install --prefix=/path/to/installation/dir

Prerequisites

The following libraries are used by the full installation of NeXpy. There is more details of the nature of these dependencies in the NeXpy documentation.

The remote server requires the Pyro4 package.

The following environment variable may need to be set

PYTHONPATH --> paths to numpy if installed in a nonstandard place

All of the above are included in the Enthought Python Distribution v7.3.

User Support

Consult the NeXpy documentation for details of both the Python command-line API and how to use the NeXpy GUI. If you have any general questions concerning the use of NeXpy, please address them to the NeXus Mailing List. If you discover any bugs, please submit a Github issue, preferably with relevant tracebacks.