Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 1.46 KB

index.rst

File metadata and controls

66 lines (46 loc) · 1.46 KB
Raw

punx

Python Utilities for NeXus HDF5 files: validation, structure, hierarchy

  • Validation of NeXus NXDL files
  • Validation of NeXus HDF5 data files
  • Display of NeXus HDF5 data file tree structure
  • Display of NeXus base class hierarchy (stretch goal, graphical output)

NOTE: project is under initial construction

Use these steps to :ref:`install <install>` and try the :ref:`demo <demo>`:

.. tabs::

   .. tab:: conda

      .. code-block:: console
         :linenos:

         conda install punx -c conda-forge
         punx demo

   .. tab:: pip

      .. code-block:: console
         :linenos:

         pip install punx
         punx demo

   .. tab:: source

      .. code-block:: console
         :linenos:

         git clone https://github.com/prjemian/punx
         cd punx
         pip install -e .
         punx demo



.. toctree::
   :maxdepth: 2
   :hidden:

   contents

See the :ref:`overview` for how to use this application or the :ref:`contents` for more details.

author:Pete R. Jemian
email:prjemian@gmail.com
copyright:2014-2023, Pete R. Jemian
license:Creative Commons Attribution 4.0 International Public License (see LICENSE.txt)
URL:https://prjemian.github.io/punx
git:https://github.com/prjemian/punx
conda:https://anaconda.org/conda-forge/punx
PyPI:https://pypi.python.org/pypi/punx
TODO list:https://github.com/prjemian/punx/issues
release:|release|
version:|version|
published:|today|