Debian Codegraph @

PKG-INFO

raw
1 Metadata-Version: 2.4
2 Name: nexusformat
3 Version: 2.0.1
4 Summary: Python API to access NeXus data
5 Author-email: Raymond Osborn <[email protected]>
6 License: Licensing Terms for NeXpy
7 -------------------------
8
9 NeXpy is licensed under the terms of the Modified BSD License (also known as
10 New or Revised BSD), as follows:
11
12 Copyright (c) 2014-2025, NeXpy Development Team
13
14 All rights reserved.
15
16 Redistribution and use in source and binary forms, with or without
17 modification, are permitted provided that the following conditions are met:
18
19 Redistributions of source code must retain the above copyright notice, this
20 list of conditions and the following disclaimer.
21
22 Redistributions in binary form must reproduce the above copyright notice, this
23 list of conditions and the following disclaimer in the documentation and/or
24 other materials provided with the distribution.
25
26 Neither the name of the NeXpy Development Team nor the names of its
27 contributors may be used to endorse or promote products derived from this
28 software without specific prior written permission.
29
30 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
31 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
32 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
33 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
34 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
36 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
37 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
38 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40
41 About the NeXpy Development Team
42 ----------------------------------
43
44 The NeXpy Development Team is the set of all contributors to the NeXpy
45 project on the Github at https://github.com/nexpy. The project is
46 currently led by Ray Osborn.
47
48 Copyright
49 ---------
50
51 The following banner should be used in any source code file to indicate the
52 copyright and license terms:
53
54 # -----------------------------------------------------------------------------
55 # Copyright (c) 2014-2025, NeXpy Development Team.
56 #
57 # Distributed under the terms of the Modified BSD License.
58 #
59 # The full license is in the file COPYING, distributed with this software.
60 # -----------------------------------------------------------------------------
61
62 Project-URL: Homepage, https://nexpy.github.io/nexpy
63 Project-URL: Repository, https://github.com/nexpy/nexusformat.git
64 Project-URL: Issues, https://github.com/nexpy/nexusformat/issues
65 Project-URL: Documentation, https://nexpy.github.io/nexpy/pythonshell.html
66 Project-URL: Changelog, https://github.com/nexpy/nexusformat/releases
67 Keywords: data format,HDF5,neutron scattering,x-ray scattering
68 Classifier: Development Status :: 5 - Production/Stable
69 Classifier: License :: OSI Approved :: BSD License
70 Classifier: Intended Audience :: Developers
71 Classifier: Intended Audience :: Science/Research
72 Classifier: Programming Language :: Python :: 3
73 Classifier: Programming Language :: Python :: 3.9
74 Classifier: Programming Language :: Python :: 3.10
75 Classifier: Programming Language :: Python :: 3.11
76 Classifier: Programming Language :: Python :: 3.12
77 Classifier: Programming Language :: Python :: 3.13
78 Classifier: Programming Language :: Python :: 3.14
79 Classifier: Topic :: Scientific/Engineering
80 Classifier: Topic :: Scientific/Engineering :: Visualization
81 Requires-Python: >=3.9
82 Description-Content-Type: text/markdown
83 License-File: COPYING
84 Requires-Dist: colored
85 Requires-Dist: h5py
86 Requires-Dist: hdf5plugin
87 Requires-Dist: numpy
88 Requires-Dist: packaging
89 Requires-Dist: pygments
90 Requires-Dist: python-dateutil
91 Requires-Dist: scipy
92 Requires-Dist: importlib_resources; python_version <= "3.9"
93 Provides-Extra: testing
94 Requires-Dist: pytest; extra == "testing"
95 Dynamic: license-file
96
97 Introduction
98 ============
99 This package provides a Python API to open, create, and manipulate [NeXus
100 data](http://www.nexusformat.org/) written in the HDF5 format. The
101 'nexusformat' package provides the underlying API for
102 [NeXpy](http://nexpy.github.io/nexpy), which provides a GUI interface for
103 visualizing and analyzing NeXus data.
104
105 The latest development version is always available from [NeXpy's GitHub
106 repository](https://github.com/nexpy/nexusformat).
107
108 Installing and Running
109 ======================
110 Released versions of `nexusformat` can be installed using either
111
112 ```
113 $ pip install nexusformat
114 ```
115
116 or, if you are in a conda environment::
117
118 ```
119 $ conda install -c conda-forge nexusformat
120 ```
121
122 The source code can be downloaded from the NeXpy Git repository:
123
124 ```
125 $ git clone http://github.com/nexpy/nexusformat.git
126 ```
127 Prerequisites
128 =============
129 The following libraries are used by the full installation of NeXpy. There is
130 more details of the nature of these dependencies in the
131 [NeXpy documentation](http://nexpy.github.io/nexpy).
132
133 * h5py http://www.h5py.org
134 * numpy http://numpy.org
135 * scipy http://scipy.org
136
137 User Support
138 ============
139 Consult the [NeXpy documentation](http://nexpy.github.io/nexpy) for details
140 of both the Python command-line API and how to use the NeXpy GUI. If you have
141 any general questions concerning the use of NeXpy, please address
142 them to the
143 [NeXus Mailing List](http://download.nexusformat.org/doc/html/mailinglist.html).
144 If you discover any bugs, please submit a
145 [Github issue](https://github.com/nexpy/nexusformat/issues), preferably with
146 relevant tracebacks.