Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need new links to h5toText program #705

Closed
prjemian opened this issue Jan 22, 2020 · 3 comments · Fixed by #707
Closed

Need new links to h5toText program #705

prjemian opened this issue Jan 22, 2020 · 3 comments · Fixed by #707
Assignees
Milestone

Comments

@prjemian
Copy link
Contributor

The h5toText program, has been removed from spec2nexus, release 2020.0.0.

The code is now part of the punx project (this project is still in development while some parts are robust). The specific module has been renamed h5tree. Similar functionality of the h5toText program is provided by the punx tree comand line program, an example of which is provided here:

(base) mintadmin@mint-vm:~/.../NeXus/exampledata$ punx tree simple3D.h5 

!!! WARNING: this program is not ready for distribution.

/home/mintadmin/Documents/eclipse/NeXus/exampledata/simple3D.h5 : NeXus data file
  @HDF5_Version = 1.6.6
  @NeXus_version = 4.1.0
  @file_name = simple3D.h5
  @file_time = 2011-11-18 17:26:27+0100
  entry:NXentry
    @NX_class = NXentry
    data:NXdata
      @NX_class = NXdata
      test:NX_INT32[2,3,4] = __array
        __array = [
            [
                [0, 1, 2, 3]
                [4, 5, 6, 7]
                [8, 9, 10, 11]
              ]
            [
                [12, 13, 14, 15]
                [16, 17, 18, 19]
                [20, 21, 22, 23]
              ]
          ]
        @signal = 1
@prjemian
Copy link
Contributor Author

In the manual source, h5toText appears 22 times:

manual/source/examples/code_napi.rst:View a NeXus HDF5 file using *h5toText.py*
manual/source/examples/code_napi.rst:Next, we show the output from a custom Python tool (``h5toText.py``) built for
manual/source/examples/code_napi.rst:NAPI Python Example: ``h5toText`` output of NeXus HDF5 file
manual/source/examples/h5py/create_data.sh:# h5toText comes from the spec2nexus package
manual/source/examples/h5py/create_data.sh:h5toText prj_test.nexus.hdf5 > prj_test.nexus_structure.txt
manual/source/examples/h5py/create_data.sh:h5toText external_angles.hdf5 > external_angles_structure.txt
manual/source/examples/h5py/create_data.sh:h5toText external_counts.hdf5 > external_counts_structure.txt
manual/source/examples/h5py/create_data.sh:h5toText external_master.hdf5 > external_master_structure.txt
manual/source/examples/h5py/create_data.sh:h5toText writer_1_3.hdf5 > writer_1_3_structure.txt
manual/source/examples/h5py/create_data.sh:h5toText writer_2_1.hdf5 > writer_2_1_structure.txt
manual/source/examples/h5py/index.rst::download:`external_angles_structure.txt`    *h5toText* analysis of *external_angles.hdf5*
manual/source/examples/h5py/index.rst::download:`external_counts_structure.txt`    *h5toText* analysis of *external_counts.hdf5*
manual/source/examples/h5py/index.rst::download:`external_master_structure.txt`    *h5toText* analysis of *external_master.hdf5*
manual/source/examples/h5py/index.rst::download:`prj_test.nexus_structure.txt`     *h5toText* analysis of the NeXus file
manual/source/examples/h5py/writer_1_3.rst:the *h5toText* tool [#]_ was used to
manual/source/examples/h5py/writer_1_3.rst:the information density provided by *h5toText*.
manual/source/examples/h5py/writer_1_3.rst:.. [#] *h5toText* : http://spec2nexus.readthedocs.org/en/latest/h5toText.html
manual/source/examples/h5py/writer_1_3.rst::download:`writer_1_3_structure.txt`   *h5toText* analysis of the NeXus file
manual/source/examples/h5py/writer_2_1.rst:The ``h5toText.py`` tool knows about the additional NeXus
manual/source/examples/h5py/writer_2_1.rst::download:`writer_2_1_structure.txt`   *h5toText* analysis of the NeXus file
manual/source/faq.rst:    and *h5toText* provide text renditions of content and structure.
manual/source/utilities.rst:    Provides *h5toText* utility program to inspect HDF5 file content.

@prjemian
Copy link
Contributor Author

@FreddieAkeroyd : thanks for finding this!

@prjemian prjemian self-assigned this Jan 22, 2020
@prjemian
Copy link
Contributor Author

@RussBerg: You might be interested in this tool, as well. punx tree filename prints the structure of an HDF5 file to the console. Easier to use than HDFview. It collapses large arrays, as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant