Metadata-Version: 2.1
Name: hyo2.bag
Version: 1.2.4
Summary: A package to manage Bathymetric Attributed Grid (BAG) data files.
Home-page: https://www.hydroffice.org/bag
Author: Giuseppe Masetti (CCOM,UNH)
Author-email: gmasetti@ccom.unh.edu
License: LGPLv3 license
Keywords: hydrography ocean mapping survey bag openns
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Office/Business :: Office Suites
Requires-Python: >=3.8
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: hyo2.abc2>=2.3.7
Requires-Dist: dateutil
Requires-Dist: lxml
Requires-Dist: numpy
Requires-Dist: gdal
Requires-Dist: h5py

HydrOffice BAG Tools
====================

.. image:: https://github.com/hydroffice/hyo2_bag/raw/master/hyo2/bag/media/favicon.png
    :alt: logo

|

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

.. image:: https://github.com/hydroffice/hyo2_bag/actions/workflows/bag_on_windows.yml/badge.svg
    :target: https://github.com/hydroffice/hyo2_bag/actions/workflows/bag_on_windows.yml
    :alt: Windows

.. image:: https://github.com/hydroffice/hyo2_bag/actions/workflows/bag_on_linux.yml/badge.svg
    :target: https://github.com/hydroffice/hyo2_bag/actions/workflows/bag_on_linux.yml
    :alt: Linux

.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
    :target: https://www.hydroffice.org/manuals/bag/index.html
    :alt: Latest Documentation

.. image:: https://app.codacy.com/project/badge/Grade/b39ce4141d3e412fa789c7d5ee4971f3
    :target: https://app.codacy.com/gh/hydroffice/hyo2_bag/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
    :alt: codacy

.. image:: https://coveralls.io/repos/github/hydroffice/hyo2_bag/badge.svg?branch=master
    :target: https://coveralls.io/github/hydroffice/hyo2_bag?branch=master
    :alt: coverall

|

* GitHub: `https://github.com/hydroffice/hyo2_bag <https://github.com/hydroffice/hyo2_bag>`_
* Project page: `url <https://www.hydroffice.org/bag>`_
* License: LGPLv3 or IA license (See `Dual license <https://www.hydroffice.org/license/>`_)

|

General Info
------------

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.

The BAG Tools hydro-package collects tools for working with BAG files. BAG is a data format by the `ONS-WG <http://www.opennavsurf.org/>`_ (Open Navigation Surface Working Group).


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

For the BAG library, you will need:

* ``python`` *[>=3.5]*
* ``numpy``
* ``h5py``
* ``lxml``
* ``gdal``
* ``PyInstaller`` *[for freezing the tools]*

For running some of the example scripts, you might also need:

* ``matplotlib``


"""""""

History
-------

1.0
~~~

2018-12-02

- Move to hyo2 namespace


0.5
~~~

2018-06-21

- Bug fix to follow GDAL-convention for geotransform

2018-04-08

- Switch to git

2017-04-21

- Switch to Python 3


0.2
~~~

2016-05-27

- Added option to read a slice of rows for elevation and uncertainty layers

2016-03-21

- Added option to reproject layers into user-defined EPSG


2015-10-24

- Split BAG Explorer as stand-alone hydro-package


2015-10-09

- Added BAG Explorer
- Started Schematron schema for BAG Metadata profile


0.1
~~~

2015-03-31

- Initial commit.


"""""""

Credits
-------

Authors
~~~~~~~

HydrOffice BAG is written and maintained by:

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

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

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

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

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

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://github.com/hydroffice/hyo2_bag/blob/master/AUTHORS.rst
.. _changelog: https://github.com/hydroffice/hyo2_bag/blob/master/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
