Debian Codegraph @

PKG-INFO

raw
1 Metadata-Version: 2.1
2 Name: hdf_compass
3 Version: 0.7b15
4 Summary: An experimental viewer program for HDF5 and related formats.
5 Home-page: https://github.com/HDFGroup/hdf-compass/
6 Author: HDFGroup
7 Author-email: [email protected]
8 License: BSD-like license
9 Keywords: data hdf bag ascii grid opendap
10 Classifier: Development Status :: 5 - Production/Stable
11 Classifier: Intended Audience :: Science/Research
12 Classifier: Natural Language :: English
13 Classifier: License :: OSI Approved :: BSD License
14 Classifier: Operating System :: OS Independent
15 Classifier: Programming Language :: Python
16 Classifier: Programming Language :: Python :: 3
17 Classifier: Programming Language :: Python :: 3.8
18 Classifier: Programming Language :: Python :: 3.9
19 Classifier: Programming Language :: Python :: 3.10
20 Classifier: Programming Language :: Python :: 3.11
21 Classifier: Topic :: Scientific/Engineering :: Information Analysis
22 Classifier: Topic :: Office/Business :: Office Suites
23 Classifier: Topic :: Utilities
24 License-File: COPYING
25 Requires-Dist: numpy
26 Requires-Dist: matplotlib
27 Requires-Dist: h5py
28 Requires-Dist: pypubsub
29 Requires-Dist: wxPython
30 Requires-Dist: requests
31 Provides-Extra: geonodes
32 Requires-Dist: cartopy[plotting]; extra == "geonodes"
33 Provides-Extra: bag
34 Requires-Dist: hyo2.bag>=1.2.4; extra == "bag"
35 Provides-Extra: opendap
36 Requires-Dist: pydap>=3.2; extra == "opendap"
37 Provides-Extra: adios
38 Requires-Dist: adios>=1.9.1b19; extra == "adios"
39
40 HDF Compass
41 ===========
42
43 .. image:: https://badge.fury.io/py/hdf_compass.svg
44 :target: https://badge.fury.io/py/hdf_compass
45 :alt: PyPI Status
46
47 .. image:: https://readthedocs.org/projects/hdf-compass/badge/?version=stable
48 :target: http://hdf-compass.readthedocs.org/en/stable/?badge=stable
49 :alt: Stable Documentation Status
50
51 .. image:: https://readthedocs.org/projects/hdf-compass/badge/?version=latest
52 :target: http://hdf-compass.readthedocs.org/en/latest/?badge=latest
53 :alt: Latest Documentation Status
54
55 .. image:: https://github.com/HDFGroup/hdf-compass/actions/workflows/hdf-compass_on_windows.yml/badge.svg?branch=py3
56 :target: https://github.com/HDFGroup/hdf-compassg/actions/workflows/hdf-compass_on_windows.yml
57 :alt: Windows
58
59 .. image:: https://github.com/HDFGroup/hdf-compass/actions/workflows/hdf-compass_on_linux.yml/badge.svg?branch=py3
60 :target: https://github.com/HDFGroup/hdf-compass/actions/workflows/hdf-compass_on_linux.yml
61 :alt: Linux
62
63 .. image:: https://coveralls.io/repos/github/HDFGroup/hdf-compass/badge.svg?branch=py3
64 :target: https://coveralls.io/github/HDFGroup/hdf-compass?branch=py3
65 :alt: coverall
66
67
68 Welcome to the project! HDF Compass is an experimental viewer program for
69 HDF5 and related formats, designed to complement other more complex
70 applications like HDFView. Strong emphasis is placed on clean minimal design,
71 and maximum extensibility through a plugin system for new formats.
72
73 HDF Compass is written in Python, but ships as a native application on
74 Windows, OS X, and Linux, by using PyInstaller to package the app.
75
76 Binary executables are available for Windows (Windows 7 or later) and Mac OS X (Yosemite or later) at
77 the Project Page listed below.
78
79 Bug reports and pull requests are welcome! For non-trivial PRs please
80 open an issue first, so the core developers can give feedback on your idea.
81
82
83
84 Development Environment
85 -----------------------
86
87 You will need:
88
89 * `Python 3.6 <https://www.python.org/downloads/>`_
90 * `NumPy <https://github.com/numpy/numpy>`_
91 * `Matplotlib <https://github.com/matplotlib/matplotlib>`_
92 * `wxPython Phoenix 4.0.0+ <https://github.com/wxWidgets/Phoenix>`_ (`PyPI <https://pypi.python.org/pypi/wxPython>`_ and `extra wheels for Linux <https://wxpython.org/pages/downloads/>`_)
93 * `Cartopy <https://github.com/SciTools/cartopy>`_
94 * `h5py <https://github.com/h5py/h5py>`_ *[HDF plugin]*
95 * `hyo2.bag <https://bitbucket.org/ccomjhc/hyo_bag>`_ *[BAG plugin]*
96 * `Pydap <https://github.com/robertodealmeida/pydap>`_ *[OPeNDAP plugin]* (>=3.3)
97 * `Requests <https://github.com/kennethreitz/requests>`_ *[HDF Rest API plugin]*
98 * `adios <https://github.com/ornladios/ADIOS>`_ *[ADIOS Plugin]* (Linux/OSX only)
99
100 For packaging the app:
101
102 * `PyInstaller <https://github.com/pyinstaller/pyinstaller>`_ *(>= 3.3 or `latest dev <https://github.com/pyinstaller/pyinstaller/archive/develop.zip>`_ )*
103
104
105 Running the Program
106 -------------------
107
108 ``$ python HDFCompass.py``
109
110
111 Note: If you are using the Anaconda distribution on the Mac, you will see the
112 message: "This program needs access to the screen. Please run with a Framework
113 build of python...". In this case use the pythonw command:
114
115 ``$ pythonw HDFCompass.py``
116
117 Note: on Mac, HDF Compass doesn't create an initial window, use the system Application
118 menu to open a file or remote resource.
119
120 Note: If you are using conda and see debug message like "No module named 'h5py'" with the h5py package installed,
121 install python.app: ``$ conda install python.app``
122
123
124
125 Packaging
126 ---------
127
128 Single-file:
129
130 ``$ pyinstaller --clean -y HDFCompass.1file.spec``
131
132 Single-folder (useful for debugging the ``pyinstaller`` settings):
133
134 ``$ pyinstaller --clean -y HDFCompass.1folder.spec``
135
136
137 Other info
138 ----------
139
140 * Github: `http://github.com/HDFGroup/hdf-compass <http://github.com/HDFGroup/hdf-compass>`_
141 * Project page: `https://www.hdfgroup.org/projects/compass/ <https://www.hdfgroup.org/projects/compass/>`_
142 * License: BSD-like HDF Group license (See `COPYING <https://raw.githubusercontent.com/HDFGroup/hdf-compass/master/COPYING>`_)