This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
HydrOffice BAG Explorer
=======================


General info
------------

.. image:: https://www.hydroffice.org/static/mybag/img/logo.png
:alt: logo

.. image:: https://img.shields.io/pypi/v/hydroffice.bagexplorer.svg
:target: https://pypi.python.org/pypi/hydroffice.bagexplorer
:alt: PyPi version

HydrOffice is a research development environment for ocean mapping. It provides a collection of hydro-packages, each of them dealing with a specific issue of the field.
The main goal is to speed up both algorithms testing and research-2-operation.

BAG Explorer is a light application, based on HDF Compass and the HydrOffice BAG library tools, to explore BAG data files.

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.
For more info about HDF Compass, visit the `GitHub <http: github.com="" hdfgroup="" hdf-compass="">`_ repository and the `project <https: www.hdfgroup.org="" projects="" compass=""/>`_ web page.

HydrOffice BAG library provides access to BAG-specific features, as well as a collection of tools to verify and manipulate BAG data files.


Dependencies
------------

For executing and packaging the *BAG Explorer* app:

* ``hdf_compass`` (that requires several dependencies as ``matplotlib``, ``wxPython``, ``h5py``)
* ``hydroffice.bag`` (that also requires ``lxml`` and ``osgeo.gdal``)
* ``PyInstaller`` *[for freezing the application]*
* ``appdmg`` *[for creating a dmg on Mac]*


Freezing
--------

Use of Pyinstaller
~~~~~~~~~~~~~~~~~~

* ``pyinstaller --clean -y freeze/BAGExplorer.1file.spec``
* ``pyinstaller --clean -y freeze/BAGExplorer.1folder.spec``

Creation of MAC OS dmg
~~~~~~~~~~~~~~~~~~~~~~

* ``appdmg spec.json dist/BAGExplorer.dmg``


Other info
----------

* Bitbucket: `repo <https: bitbucket.org="" ccomjhc="" hyo_bagexplorer="" <https:="" bitbucket.org="" ccomjhc="" hyo_bagexplorer="">`_
* Project page: `https://www.hydroffice.org/bag/main>`_
* License: LGPLv3 license (See `LICENSE <https: www.hydroffice.org="" license=""/>`_)


"""""""

History
-------

0.2
~~~

2015-10-24

- Split from hydroffice.bag as stand-alone hydro-package



"""""""

Credits
-------

Authors
~~~~~~~

HydrOffice BAG and BAG Explorer are written and maintained by:

- `Giuseppe Masetti <mailto:gmasetti@ccom.unh.edu>`_

- `Brian Calder <mailto:brc@ccom.unh.edu>`_

Contributors
~~~~~~~~~~~~

The following wonderful people contributed directly or indirectly to this project:

- `Matt Wilson <mailto:matt.wilson@noaa.gov>`_

Please add yourself here alphabetically when you submit your first pull request.


"""""""

How to contribute
=================

Every open source project lives from the generous help by contributors that sacrifice their time and this is no different.

To make participation as pleasant as possible, this project adheres to the `Code of Conduct`_ by the Python Software Foundation.

Here are a few hints and rules to get you started:

- Add yourself to the AUTHORS.txt_ file in an alphabetical fashion. Every contribution is valuable and shall be credited.
- If your change is noteworthy, add an entry to the changelog_.
- No contribution is too small; please submit as many fixes for typos and grammar bloopers as you can!
- Don't *ever* break backward compatibility.
- *Always* add tests and docs for your code. This is a hard rule; patches with missing tests or documentation won't be merged.
If a feature is not tested or documented, it does not exist.
- Obey `PEP 8`_ and `PEP 257`_.
- Write `good commit messages`_.
- Ideally, `collapse`_ your commits, i.e. make your pull requests just one commit.

.. note::
If you have something great but aren't sure whether it adheres -- or even can adhere -- to the rules above: **please submit a pull request anyway**!
In the best case, we can mold it into something, in the worst case the pull request gets politely closed.
There's absolutely nothing to fear.

Thank you for considering to contribute! If you have any question or concerns, feel free to reach out to us.

.. _`Code of Conduct`: http://www.python.org/psf/codeofconduct/
.. _AUTHORS.txt: https://bitbucket.org/ccomjhc/hyo_bag/raw/tip/AUTHORS.rst
.. _changelog: https://bitbucket.org/ccomjhc/hyo_bag/raw/tip/HISTORY.rst
.. _`PEP 8`: http://www.python.org/dev/peps/pep-0008/
.. _`PEP 257`: http://www.python.org/dev/peps/pep-0257/
.. _collapse: https://www.mercurial-scm.org/wiki/RebaseExtension
.. _`good commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html


"""""""

Banner
======

.. code-block:: python

| ========================================================== |
| _ _ _ _____ __ __ _ |
| | | | | | | | _ |/ _|/ _(_) |
| | |_| |_ _ __| |_ __| | | | |_| |_ _ ___ ___ |
| | _ | | | |/ _\ | '__| | | | _| _| |/ __/ _ \ |
| | | | | |_| | (_| | | \ \_/ / | | | | | (_| __/ |
| \_| |_/\__, |\__,_|_| \___/|_| |_| |_|\___\___| |
| __/ | |
| |___/ |
| |
| ---------------------------------------------------------- |
| Office Tools to Facilitate |
| Hydrographic Surveys, Data Review and |
| Nautical Chart Compilation |
| |
| ---------------------------------------------------------- |
| For comments/suggestions: |
| - matt.wilson@noaa.gov |
| - brc@ccom.unh.edu |
| - gmasetti@ccom.unh.edu |
| |
| ========================================================== |
Release History

Release History

0.2.1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting