Metadata-Version: 1.1
Name: oceansdb
Version: 0.7.0
Summary: Package to subsample ocean climatologies and reference data.
Home-page: https://github.com/castelao/oceansdb
Author: Guilherme Castelao
Author-email: guilherme@castelao.net
License: 3-clause BSD
Description: ========
        OceansDB
        ========
        
        .. image:: https://zenodo.org/badge/4645/castelao/oceansdb.svg
           :target: https://zenodo.org/badge/latestdoi/4645/castelao/oceansdb
        
        .. image:: https://readthedocs.org/projects/oceansdb/badge/?version=latest
            :target: http://oceansdb.readthedocs.org/en/latest/?badge=latest
                 :alt: Documentation Status
        
        .. image:: https://img.shields.io/travis/castelao/oceansdb.svg
                :target: https://travis-ci.org/castelao/oceansdb
        
        .. image:: https://img.shields.io/pypi/v/oceansdb.svg
                :target: https://pypi.python.org/pypi/oceansdb
        
        
        Package to subsample, or interpolate, climatologies like WOA to any coordinates.
        
        This package started with functions to obtain climatological values to compare with measured data, allowing a quality control check by comparison. It hence needed to work for any coordinates requested. I split these functionalities from `CoTeDe <http://cotede.castelao.net>`_ into this standalone package to allow more people to use it for other purposes.
        
        * Free software: 3-clause BSD style license - see LICENSE.rst  
        * Documentation: https://oceansdb.readthedocs.io.
        
        Features
        --------
        
        - If the database files are not localy available, automatically download it.
        
        - Extract, or interpolate if necessary, climatologic data on requested coordinates;
        
          - Can request a single point, a profile or a section;
        
          - Ready to handle -180 to 180 or 0 to 360 coordinate system;
        
        - Ready to use with:
        
          - World Ocean Atlas (WOA)
        
          - CSIRO Atlas Regional Seas (CARS)
        
          - ETOPO (topography)
        
        Quick howto use
        ---------------
        
        Inside python:
        
        .. code-block:: python
        
            >>> import oceansdb
            >>> db = oceansdb.WOA()
        
        To get temperature at one point:
        
        .. code-block:: python
        
            >>> t = db['TEMP'].extract(var='mn', doy=136.875, depth=0, lat=17.5, lon=-37.5)
        
        To get one profile of salinity:
        
        .. code-block:: python
        
            >>> t = db['PSAL'].extract(var='mn', doy=136.875, depth=[0, 10, 15, 18], lat=17.5, lon=-37.5)
        
        To get a full depth section of temperature:
        
        .. code-block:: python
        
            >>> t = db['TEMP'].extract(var='mn', doy=136.875, lat=17.5, lon=[-39, -37.5, -35])
        
        
        Or to get topography for one point:
        
        .. code-block:: python
        
            >>> db = oceansdb.ETOPO()
            >>> h = db.extract(lat=17.5, lon=0)
        
        
        
        
        History
        -------
        
        0.7.0 (2017-05-11)
        ------------------
        
        * New generic crop functionality.
        * Interpolate in steps, in order: time, lat x lon, and finally z. Gives better results for profiles.
        
        0.6.0 (2016-04-14)
        ------------------
        
        * Adding CSIRO Atlas of Regional Seas (CARS), another climatology for temperature and salinity.
        
        0.4.0 (2016-03-29)
        ------------------
        
        * Added etopo5, a world wide bathymetry. Some of this code has its origins on pyAVISO and CoTeDe.
        
        0.2.0 (2016-03)
        ------------------
        
        * Renamed package to OceansDB, planning to include other climatologies and references.
        
        0.1.0 (2016-02-09)
        ------------------
        
        * Generalized interpolator. Extract climatology for point, profile or section.
        
        0.0.1 (2015-12-13)
        ------------------
        
        * First release on PyPI. Extracted from CoTeDe to be a standalone package.
        
        pre-released (~2006)
        --------------------
        
        * The first version was developed in support to quality control thermosalinographs at NOAA. It was later injected inside CoTeDe.
        
Keywords: WOA World Ocean Atlas climatology oceanographic data oceanography ETOPO temperature salinity bathymetry
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Scientific/Engineering
