Metadata-Version: 2.1
Name: hzg-sos-connect
Version: 0.4.5
Summary: Python wrapper for HZG SOS Service
Home-page: UNKNOWN
Author: Claas Faber
License: Copyright (c) 2019, Claas Faber, GEOMAR Data Management
Requires-Dist: requests
Requires-Dist: untangle
Requires-Dist: pandas

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are NOT PERMITTED
without prior permission by GEOMAR data management team. INTERNAL USE ONLY.

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description: # hzg_sos_connect
        
        HZG surveydata is a realtime data base implemented within the COSYNA Framework.
        This connector extracts positions of selected devices from surveydata.
        
        # Connected devices
        For each device you are interested in, a valid 
        *offering* (unique device name in surveydata) and 
        *observed_property* (measured parameter) needs to be provided.
        
        As of 2019-07-12, the following devices are configured:
        ```
        known_devices = {'OG_Amadeus': ('amadeus', 'salinity'),
                         'OG_Sebastian': ('sebastian', 'salinity'),
                         'OG_Comet': ('comet', 'salinity'),
                         # not yet 'OG_Dipsydoodle': ('dipsydoodle', 'salinity')
                         }
        ```
        
        **COSYNA data contact**:
        Gisbert Breitbach <gisbert.breitbach@hzg.de>
        
        # Installation
        ## Release version
        ```bash
        pip install --index-url https://pypi.fury.io/cfgmr/ hzg-sos-connect
        ```
        ## From source
        ```bash
        git clone git@git.geomar.de:moses/moses_tools/hzg_sos_connect.git
        cd hzg_sos_connect
        pip install -e .
        ```
        # Configuration
        Data publicly accessible. No config needed.
        
        # Usage
        ```python
        (venv) [datamanagement@dm-ingest-www bin]$ ipython
        Python 3.6.8 (default, Apr 25 2019, 21:02:35)
        Type 'copyright', 'credits' or 'license' for more information
        IPython 7.5.0 -- An enhanced Interactive Python. Type '?' for help.
        
        In [1]: import hzg_sos_connect
        
        In [2]: hzg_sos_connect.get_hzg_sos_data()
        Out[2]:
                      obs_timestamp        lat       lon platform_shortname
        0 2015-06-03 15:27:48+00:00  54.406073  6.236890         OG_Amadeus
        1 2018-05-29 10:35:48+00:00  43.415237 -1.996332       OG_Sebastian
        2 2018-06-14 07:57:49+00:00  43.404057 -1.994065           OG_Comet
        ```
        
Platform: UNKNOWN
Requires-Python: >= 3.6