1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
Introduction
============
This package provides a Python API to open, create, and manipulate [NeXus
data](http://www.nexusformat.org/) written in the HDF5 format. The
'nexusformat' package provides the underlying API for
[NeXpy](http://nexpy.github.io/nexpy), which provides a GUI interface for
visualizing and analyzing NeXus data.
The latest development version is always available from [NeXpy's GitHub
repository](https://github.com/nexpy/nexusformat).
Installing and Running
======================
Released versions of `nexusformat` can be installed using either
```
$ pip install nexusformat
```
or, if you are in a conda environment::
```
$ conda install -c conda-forge nexusformat
```
The source code can be downloaded from the NeXpy Git repository:
```
$ git clone http://github.com/nexpy/nexusformat.git
```
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](http://nexpy.github.io/nexpy).
* h5py http://www.h5py.org
* numpy http://numpy.org
* scipy http://scipy.org
User Support
============
Consult the [NeXpy documentation](http://nexpy.github.io/nexpy) 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](http://download.nexusformat.org/doc/html/mailinglist.html).
If you discover any bugs, please submit a
[Github issue](https://github.com/nexpy/nexusformat/issues), preferably with
relevant tracebacks.
|
