https://github.com/hdfgroup/hdf-compass

Python-based viewer for HDF5 and other HDF5-like file formats
https://github.com/hdfgroup/hdf-compass

Last synced: about 1 year ago
JSON representation

Python-based viewer for HDF5 and other HDF5-like file formats

• Host: GitHub
• URL: https://github.com/hdfgroup/hdf-compass
• Owner: HDFGroup
• License: other
• Created: 2014-06-03T19:05:11.000Z (about 12 years ago)
• Default Branch: develop
• Last Pushed: 2025-02-09T12:13:50.000Z (over 1 year ago)
• Last Synced: 2025-05-16T14:04:28.479Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 93.5 MB
• Stars: 131
• Watchers: 22
• Forks: 26
• Open Issues: 39
• Metadata Files:
  • Readme: README.rst
  • License: COPYING

Awesome Lists containing this project

README

          
HDF Compass

===========

.. image:: https://badge.fury.io/py/hdf_compass.svg

    :target: https://badge.fury.io/py/hdf_compass

    :alt: PyPI Status

.. 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

        

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 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.

Development Environment

-----------------------

You will need:

* `Python 2.7 `_ *(support for Python 3.4+ in progress)*

* `NumPy `_

* `Matplotlib `_

* `wxPython Phoenix 3.0.2 `_ *(later releases have not been tested)*

* `Cartopy `_

* `h5py `_ *[HDF plugin]*

* `hydroffice.bag `_ *[BAG plugin]*

* `Pydap `_ *[OPeNDAP plugin]* (<3.2)

* `Requests `_ *[HDF Rest API plugin]*

* `adios `_ *[ADIOS Plugin]* (Linux/OSX only)

For packaging the app:

* `PyInstaller `_ *(>= 3.0)*

Running the Program  

-------------------

    ``$ 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.

Packaging

---------

Single-file:

    ``$ pyinstaller --clean -y HDFCompass.1file.spec``

Single-folder (useful for debugging the ``pyinstaller`` settings):

    ``$ pyinstaller --clean -y HDFCompass.1folder.spec``

Other info

----------

* Github: `http://github.com/HDFGroup/hdf-compass `_

* Project page: `https://www.hdfgroup.org/projects/compass/ `_

* License: BSD-like HDF Group license (See `COPYING `_)