.. image:: https://readthedocs.org/projects/hdf-compass/badge/?version=stable :target: http://hdf-compass.readthedocs.org/en/stable/?badge=stable :alt: Stable Documentation Status
.. image:: https://readthedocs.org/projects/hdf-compass/badge/?version=latest :target: http://hdf-compass.readthedocs.org/en/latest/?badge=latest :alt: Latest Documentation Status
.. image:: https://ci.appveyor.com/api/projects/status/tfg350xo8t7h70ix?svg=true :target: https://ci.appveyor.com/project/giumas/hdf-compass :alt: AppVeyor Status
.. image:: https://travis-ci.org/giumas/hdf-compass.svg?branch=develop :target: https://travis-ci.org/giumas/hdf-compass :alt: Travis-CI Status
Welcome to the project! HDF Compass is an experimental viewer program for HDF5 and related formats, designed to complement other more complex applications like HDFView. Strong emphasis is placed on clean minimal design, and maximum extensibility through a plugin system for new formats.
HDF Compass is written in Python, but ships as a native application on Windows, OS X, and Linux, by using PyInstaller and Py2App to package the app.
Binary executables are available for Windows (Windows 7 or later) and Mac OS X (Yosemite or later) at the Project Page listed below.
Bug reports and pull requests are welcome! For non-trivial PRs please open an issue first, so the core developers can give feedback on your idea.
You will need:
Python 2.7 <https://www.python.org/downloads/>_ (support for Python 3.4+ in progress)
wxPython Phoenix 3.0.2 <https://github.com/wxWidgets/Phoenix>_ (later releases have not been tested)
h5py <https://github.com/h5py/h5py>_ [HDF plugin]
hydroffice.bag <https://bitbucket.org/ccomjhc/hyo_bag>_ [BAG plugin]
Pydap <https://github.com/robertodealmeida/pydap>_ [OPeNDAP plugin]
Requests <https://github.com/kennethreitz/requests>_ [HDF Rest API plugin]
For packaging the app:
PyInstaller <https://github.com/pyinstaller/pyinstaller>_ (Linux & Windows, experimental for OS X) (>= 3.0)
Py2App <https://bitbucket.org/ronaldoussoren/py2app>_ (OS X)
``$ python HDFCompass.py``
Note: If you are using the Anaconda distribution on the Mac, you will see the message: "This program needs access to the screen. Please run with a Framework build of python...". In this case use the pythonw command:
``$ pythonw HDFCompass.py``
Note: on Mac, HDF Compass doesn't create an initial window, use the system Application menu to open a file or remote resource.
``$ python setup.py py2app``
``$ pyinstaller --clean -y HDFCompass.1file.spec``
Single-folder (useful for debugging the
``$ pyinstaller --clean -y HDFCompass.1folder.spec``