Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 2.28 KB

README.rst

File metadata and controls

64 lines (48 loc) · 2.28 KB

Installation

Released versions of the NeXus Python API are available on PyPI. If you have the Python Setup Tools installed, then you can install using either:

$ pip install nexusformat

or:

$ easy_install nexusformat

or:

$ conda install -c https://conda.anaconda.org/nexpy nexusformat

If you have trouble with the pip or easy_install installations, you can install the package from the source code either by downloading one of the Github releases or by cloning the latest development version in the NeXpy Git repository:

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

You can then install NeXpy by changing to the source directory and typing:

$ python setup.py install

To install in an alternate location:

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

Required Libraries

Library URL
h5py http://www.h5py.org
numpy http://numpy.scipy.org/

Versioning

This package uses Semantic Versioning.

User Support

Consult the NeXpy documentation for help. If you have any general questions concerning the use of this module, please address them to the NeXus Mailing List. If you discover any bugs, please submit a Github issue, preferably with relevant tracebacks.

Acknowledgements

The NeXus format for neutron, x-ray and muon data is developed by an international collaboration under the supervision of the NeXus International Advisory Committee. The Python tree API used in NeXpy was originally developed by Paul Kienzle, who also wrote the standard Python interface to the NeXus C-API.