Metadata-Version: 2.4 Name: nexusformat Version: 2.0.1 Summary: Python API to access NeXus data Author-email: Raymond Osborn License: Licensing Terms for NeXpy ------------------------- NeXpy is licensed under the terms of the Modified BSD License (also known as New or Revised BSD), as follows: Copyright (c) 2014-2025, NeXpy Development Team All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the NeXpy Development Team nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. About the NeXpy Development Team ---------------------------------- The NeXpy Development Team is the set of all contributors to the NeXpy project on the Github at https://github.com/nexpy. The project is currently led by Ray Osborn. Copyright --------- The following banner should be used in any source code file to indicate the copyright and license terms: # ----------------------------------------------------------------------------- # Copyright (c) 2014-2025, NeXpy Development Team. # # Distributed under the terms of the Modified BSD License. # # The full license is in the file COPYING, distributed with this software. # ----------------------------------------------------------------------------- Project-URL: Homepage, https://nexpy.github.io/nexpy Project-URL: Repository, https://github.com/nexpy/nexusformat.git Project-URL: Issues, https://github.com/nexpy/nexusformat/issues Project-URL: Documentation, https://nexpy.github.io/nexpy/pythonshell.html Project-URL: Changelog, https://github.com/nexpy/nexusformat/releases Keywords: data format,HDF5,neutron scattering,x-ray scattering Classifier: Development Status :: 5 - Production/Stable Classifier: License :: OSI Approved :: BSD License Classifier: Intended Audience :: Developers Classifier: Intended Audience :: Science/Research Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 Classifier: Programming Language :: Python :: 3.12 Classifier: Programming Language :: Python :: 3.13 Classifier: Programming Language :: Python :: 3.14 Classifier: Topic :: Scientific/Engineering Classifier: Topic :: Scientific/Engineering :: Visualization Requires-Python: >=3.9 Description-Content-Type: text/markdown License-File: COPYING Requires-Dist: colored Requires-Dist: h5py Requires-Dist: hdf5plugin Requires-Dist: numpy Requires-Dist: packaging Requires-Dist: pygments Requires-Dist: python-dateutil Requires-Dist: scipy Requires-Dist: importlib_resources; python_version <= "3.9" Provides-Extra: testing Requires-Dist: pytest; extra == "testing" Dynamic: license-file 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.