Metadata-Version: 2.1
Name: gmr-underway-connect
Version: 0.4.0
Summary: Connector to GEOMAR mailbox for underway data from ships
Home-page: UNKNOWN
Author: Claas Faber
License: Copyright (c) 2019, Claas Faber, GEOMAR Data Management
Requires-Dist: pandas
Requires-Dist: chardet

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: # gmr_underway_mail_connect
        
        Connects to the GEOMAR underway mailbox to obtain underway ship data.
        
        # Connected devices
        Currently (As of 2019-07-12) only mails from Meteor are evaluated.
        
        **Data contact**:
        Claas Faber <cfaber@geomar.de>  
        Carsten Schirnick <cschirnick@geomar.de>
        
        # Installation
        ## Release version
        ```bash
        pip install --index-url https://pypi.fury.io/cfgmr/ gmr-underway-connect
        ```
        ## From source
        ```bash
        git clone git@git.geomar.de:moses/moses_tools/gmr_underway_mail_connect.git
        cd gmr_underway_mail_connect
        pip install -e .
        ```
        
        # Configuration
        Needs mail password. Set by exporting as environment variable:
        ```bash
        export MAIL_PASSWD=*********
        ```
        
        # Usage
        ```python
        (venv) [datamanagement@dm-ingest-www bin]$ export MAIL_PASSWD=********
        (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 [2]: import gmr_underway_connect
        In [5]: gmr_underway_connect.get_underway_nmea_data(['meteor','poseidon'])
        Out[5]:
                            AbsoluteWindDirection AbsoluteWindSpeed AirPressure AirTemperature Course     ExpeditionName  ...       obs_timestamp platform_shortname        lat        lon speed_over_ground heading
        timestamp                                                                                                         ...
        2019-07-10 23:36:05                  35.0             10.30      1017.5           22.4  132.9               M156  ... 2019-07-10 23:36:05                  M  21.166748 -20.916760               0.1    33.7
        2019-07-10 23:46:05                  33.0             10.40      1017.5           22.4  334.2               M156  ... 2019-07-10 23:46:05                  M  21.166758 -20.916750               0.3    35.4
        [...]
        2019-07-12 10:21:32                 265.7              3.30      1008.4           16.1  309.0  Bredo Bremerhaven  ... 2019-07-12 10:21:32                POS  53.554032   8.564880               0.0   331.9
        2019-07-12 10:31:32                 263.8              3.30      1008.4           16.5  309.0  Bredo Bremerhaven  ... 2019-07-12 10:31:32                POS  53.554085   8.564878               0.0   331.8
        ```
        
        
Platform: UNKNOWN
Requires-Python: >= 3.6