Administrative Matters¶
Author¶
| Author: | Pete R. Jemian jemian@anl.gov |
|---|
Documentation¶
| html: | http://hdf5gateway.readthedocs.org |
|---|---|
| pdf: | http://hdf5gateway.readthedocs.org/en/latest/_downloads/HDF5gateway.pdf |
Downloads¶
IgorExchange
http://www.igorexchange.com/project/HDF5gateway
- Just the most recent IgorPro procedure file (text) from the development trunk:
- https://github.com/prjemian/hdf5gateway/blob/master/HDF5gateway.ipf
source code repository
https://github.com/prjemian/hdf5gateway
subversion repository retired 2015-05-14
https://subversion.xray.aps.anl.gov/small_angle/hdf5gateway
Changes¶
| version | date | comments |
|---|---|---|
| 0.1 | 2012-11-24 | development version for user testing |
| 1.0 | 2012-11-26 | initial production version |
Known Problems¶
HDF5 links are not handled properly.
Additional code will be necessary to identify linked items and structures will be needed to establish/preserve this information within IgorPro. Notably, linked datasets will be replicated while linked groups will be empty on reading into IgorPro. How external file links are handled is not known at this time but likely, datasets will be replicated, groups will not, and the association with the external file willl not be preserved. The HDF5 XOP has capabilities to write all these structures so it is likely to provide a scheme to write links, once a scheme is devised to describe this within IgorPro.
Building the documentation¶
The documentation for HDF5gateway is built from .rst files and from content in the hdf5gateway.ipf IgorPro procedure file by a Python script called extractor.py, located in the same directory.
The current documentation was built: Sep 27, 2017.
Required:
- Python
- Sphinx
- LaTeX
How to build the documentation
change to the directory with the file extractor.py
extract the docs from the .ipf file and build the HTML docs:
python extractor.py
build the LaTeX and then PDF files:
make latexpdf
copy the PDF file to the source directory and rebuild the HTML:
cp _build/latex/HDF5gateway.pdf ./ python extractor.py