| Name | nxvalidate JSON |
| Version |
0.3.5b3
JSON |
| download |
| home_page | None |
| Summary | A Python package for validating NeXus files |
| upload_time | 2024-11-12 19:26:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Licensing Terms for NeXpy Packages ---------------------------------- NeXpy packages are licensed under the terms of the Modified BSD License (also known as New or Revised BSD), as follows: Copyright (c) 2014-2024, 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-2024, NeXpy Development Team. # # Distributed under the terms of the Modified BSD License. # # The full license is in the file COPYING, distributed with this software. # ----------------------------------------------------------------------------- |
| keywords |
data format
hdf5
neutron scattering
x-ray scattering
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Introduction
============
This package provides a Python API to inspect and validate [NeXus
files](http://www.nexusformat.org/) written in the HDF5 format.
The latest development version is always available from [NeXpy's GitHub
repository](https://github.com/nexpy/nxvalidate).
Installation
============
Released versions of `nxvalidate` can be installed using
```
% pip install nxvalidate
```
The source code can be downloaded from the NeXpy Git repository:
```
% git clone http://github.com/nexpy/nxvalidate.git
```
Prerequisites
-------------
The only prerequisite required to install the `nxvalidate` package is
the [nexusformat package](https://github.com/nexpy/nexusformat). There
are more details of further dependencies in the [NeXpy
documentation](http://nexpy.github.io/nexpy).
Usage
=====
At the moment, the `nxvalidate` package provides a single command-line script.
```
% nxinspect -h
usage: nxinspect [-h] [-f FILENAME] [-p PATH] [-a [APPLICATION]]
[-b BASECLASS] [-i] [-w] [-e] [-v]
Inspects and validates NeXus files.
options:
-h, --help show this help message and exit
-f FILENAME, --filename FILENAME
name of the NeXus file to be validated
-p PATH, --path PATH path to group to be validated in the NeXus file
-b BASECLASS, --baseclass BASECLASS
name of the base class to be listed
-a [APPLICATION], --application [APPLICATION]
validate the NeXus file against its application definition
-d DEFINITIONS, --definitions DEFINITIONS
path to the directory containing NeXus definitions
-i, --info output info messages in addition to warnings and errors
-w, --warning output info messages in addition to warnings and errors
-e, --error output info messages in addition to warnings and errors
-v, --version show program's version number and exit
```
> *N.B.*, the command is `nxinspect`, rather than `nxvalidate` to avoid
> confusion with the [C-library](https://github.com/nexusformat/cnxvalidate).
Examples
--------
1. To compare the contents of a NeXus file with the base classes defined
by the NeXus standard and print conflicting fields or groups, type:
```
% nxinspect -f <filename.nxs> -e
```
The `--info`, `--warning` and `--error` switches control how much
information is output. The default is `--warning`.
2. To compare the contents of a NeXus file with the base classes defined
in a different directory to the installed package, type:
```
% nxinspect -f <filename.nxs> -d /path/to/definitions
```
The directory should contain two sub-directories, `applications` and
`base_classes` containing the NXDL files needed to validate the
specified NeXus file.
3. To check whether the contents of the NeXus file conform to the
required contents of the application definition specified in the
file, type:
```
% nxinspect -f <filename.nxs> -a
```
4. To check whether the contents of the NeXus file conform to the
required contents of an application definition file, type:
```
% nxinspect -f <filename.nxs> -a <application.nxdl.xml>
```
5. To print the contents of a base class, type:
```
% nxinspect -b <base-class-name>
```
User Support
============
Information about the Python API for reading and writing NeXus files is
available as part of the [NeXpy
documentation](https://nexpy.github.io/nexpy). If you have any general
questions concerning the use of this package, please address them to the
[NeXus Mailing
List](http:s//download.nexusformat.org/doc/html/mailinglist.html). If
you discover any bugs, please submit a [Github
issue](https://github.com/nexpy/nxvalidate/issues), preferably with
relevant tracebacks.
Acknowledgements
================
This package was developed jointly by Kaitlyn Marlor, Justin Wozniak,
and Ray Osborn. The NeXus data format standard has been developed under
the supervision of the [NeXus International Advisory
Committee](https://www.nexusformat.org/NIAC.html).
Raw data
{
"_id": null,
"home_page": null,
"name": "nxvalidate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "data format, HDF5, neutron scattering, x-ray scattering",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3c/e9/6eac1db978baff077361b77d08e886401afbb65f5517e21d87ed672cc7a0/nxvalidate-0.3.5b3.tar.gz",
"platform": null,
"description": "Introduction\n============\nThis package provides a Python API to inspect and validate [NeXus \nfiles](http://www.nexusformat.org/) written in the HDF5 format. \n\nThe latest development version is always available from [NeXpy's GitHub\nrepository](https://github.com/nexpy/nxvalidate).\n\nInstallation\n============\nReleased versions of `nxvalidate` can be installed using\n\n```\n % pip install nxvalidate\n```\n\nThe source code can be downloaded from the NeXpy Git repository:\n\n```\n % git clone http://github.com/nexpy/nxvalidate.git\n```\n\nPrerequisites\n-------------\nThe only prerequisite required to install the `nxvalidate` package is\nthe [nexusformat package](https://github.com/nexpy/nexusformat). There\nare more details of further dependencies in the [NeXpy\ndocumentation](http://nexpy.github.io/nexpy).\n\nUsage\n=====\nAt the moment, the `nxvalidate` package provides a single command-line script.\n\n```\n% nxinspect -h\nusage: nxinspect [-h] [-f FILENAME] [-p PATH] [-a [APPLICATION]]\n [-b BASECLASS] [-i] [-w] [-e] [-v]\n\nInspects and validates NeXus files.\n\noptions:\n -h, --help show this help message and exit\n -f FILENAME, --filename FILENAME\n name of the NeXus file to be validated\n -p PATH, --path PATH path to group to be validated in the NeXus file\n -b BASECLASS, --baseclass BASECLASS\n name of the base class to be listed\n -a [APPLICATION], --application [APPLICATION]\n validate the NeXus file against its application definition\n -d DEFINITIONS, --definitions DEFINITIONS\n path to the directory containing NeXus definitions\n -i, --info output info messages in addition to warnings and errors\n -w, --warning output info messages in addition to warnings and errors\n -e, --error output info messages in addition to warnings and errors\n -v, --version show program's version number and exit\n```\n\n> *N.B.*, the command is `nxinspect`, rather than `nxvalidate` to avoid\n> confusion with the [C-library](https://github.com/nexusformat/cnxvalidate).\n\nExamples\n--------\n1. To compare the contents of a NeXus file with the base classes defined\n by the NeXus standard and print conflicting fields or groups, type:\n ```\n % nxinspect -f <filename.nxs> -e\n ```\n The `--info`, `--warning` and `--error` switches control how much \n information is output. The default is `--warning`.\n2. To compare the contents of a NeXus file with the base classes defined\n in a different directory to the installed package, type:\n ```\n % nxinspect -f <filename.nxs> -d /path/to/definitions\n ```\n The directory should contain two sub-directories, `applications` and\n `base_classes` containing the NXDL files needed to validate the\n specified NeXus file.\n3. To check whether the contents of the NeXus file conform to the\n required contents of the application definition specified in the\n file, type:\n ```\n % nxinspect -f <filename.nxs> -a\n ```\n4. To check whether the contents of the NeXus file conform to the\n required contents of an application definition file, type:\n ```\n % nxinspect -f <filename.nxs> -a <application.nxdl.xml>\n ```\n5. To print the contents of a base class, type:\n ```\n % nxinspect -b <base-class-name>\n ```\n\nUser Support\n============\nInformation about the Python API for reading and writing NeXus files is\navailable as part of the [NeXpy\ndocumentation](https://nexpy.github.io/nexpy). If you have any general\nquestions concerning the use of this package, please address them to the\n[NeXus Mailing\nList](http:s//download.nexusformat.org/doc/html/mailinglist.html). If\nyou discover any bugs, please submit a [Github\nissue](https://github.com/nexpy/nxvalidate/issues), preferably with\nrelevant tracebacks.\n\nAcknowledgements\n================\nThis package was developed jointly by Kaitlyn Marlor, Justin Wozniak,\nand Ray Osborn. The NeXus data format standard has been developed under\nthe supervision of the [NeXus International Advisory\nCommittee](https://www.nexusformat.org/NIAC.html).\n",
"bugtrack_url": null,
"license": "Licensing Terms for NeXpy Packages ---------------------------------- NeXpy packages are licensed under the terms of the Modified BSD License (also known as New or Revised BSD), as follows: Copyright (c) 2014-2024, 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-2024, NeXpy Development Team. # # Distributed under the terms of the Modified BSD License. # # The full license is in the file COPYING, distributed with this software. # ----------------------------------------------------------------------------- ",
"summary": "A Python package for validating NeXus files",
"version": "0.3.5b3",
"project_urls": {
"Issues": "https://github.com/nexpy/nxvalidate/issues",
"Repository": "https://github.com/nexpy/nxvalidate.git"
},
"split_keywords": [
"data format",
" hdf5",
" neutron scattering",
" x-ray scattering"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e0b266c1f81283075a032c08deb120c601c3f19233ce938688610c89e7500ad2",
"md5": "ff880c5cf27d93fc71130853809a3d2c",
"sha256": "ec275d7096668494b49f716b8d57af355298fad6f80a974f48e73bd87db03998"
},
"downloads": -1,
"filename": "nxvalidate-0.3.5b3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff880c5cf27d93fc71130853809a3d2c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 835662,
"upload_time": "2024-11-12T19:26:30",
"upload_time_iso_8601": "2024-11-12T19:26:30.889307Z",
"url": "https://files.pythonhosted.org/packages/e0/b2/66c1f81283075a032c08deb120c601c3f19233ce938688610c89e7500ad2/nxvalidate-0.3.5b3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ce96eac1db978baff077361b77d08e886401afbb65f5517e21d87ed672cc7a0",
"md5": "39724b2448b69ee7435e57e38b016a92",
"sha256": "9f061862997e048a5a90bdbbd86902c72aca435e8be3789c44cb7b2433aa5157"
},
"downloads": -1,
"filename": "nxvalidate-0.3.5b3.tar.gz",
"has_sig": false,
"md5_digest": "39724b2448b69ee7435e57e38b016a92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 603259,
"upload_time": "2024-11-12T19:26:33",
"upload_time_iso_8601": "2024-11-12T19:26:33.102813Z",
"url": "https://files.pythonhosted.org/packages/3c/e9/6eac1db978baff077361b77d08e886401afbb65f5517e21d87ed672cc7a0/nxvalidate-0.3.5b3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 19:26:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nexpy",
"github_project": "nxvalidate",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nxvalidate"
}
