OceanColor


NameOceanColor JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryDeal with NASA Ocean Color data (search and download)
upload_time2023-10-08 02:01:48
maintainer
docs_urlNone
authorGuilherme Castelao
requires_python>=3.8
licenseBSD License Copyright (c) 2020-2021, Guilherme Castelão All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * 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. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 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.
keywords nasa ocean color chlorophyll oceanography matchup
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ===========
Ocean Color
===========

.. image:: https://zenodo.org/badge/318619654.svg
   :target: https://zenodo.org/badge/latestdoi/318619654

.. image:: https://readthedocs.org/projects/oceancolor/badge/?version=latest
        :target: https://oceancolor.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/OceanColor.svg
        :target: https://pypi.python.org/pypi/OceanColor

.. image:: https://github.com/castelao/OceanColor/actions/workflows/ci.yml/badge.svg
        :target: https://github.com/castelao/OceanColor/actions

.. image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/castelao/OceanColor/main?filepath=docs%2Fnotebooks

Search and subset NASA Ocean Color data

* Free software: BSD license
* Documentation: https://oceancolor.readthedocs.io.

NASA provides great resources to search and access its data. This package is
intended to fill a gap in obtaining chlorophyll data to be compared with in
situ observations by searching pixels within a given time and distance tolerance.
For instance, it is used to calibrate chlorophyll fluorescence measurements
from Spray underwater gliders.

The OceanColor package was developed at the `Instrument Development Group
<https://idg.ucsd.edu>`_ of `Scripps Institution of Oceanography
<https://scripps.ucsd.edu>`_ in support for the `California Underwater Glider
Network <https://spraydata.ucsd.edu/projects/CUGN/>`_ operations, which is
funded by:

* Global Ocean Monitoring and Observing (GOMO) Program - NOAA
* Southern California Coastal Ocean Observing System (SCCOOS)

---------------------
Quickstart - terminal
---------------------

Let's install it

.. code-block:: console

    $ pip install OceanColor

or

.. code-block:: console

    $ conda install OceanColor

Let's get the L2 chlorophyll measurements from MODIS-Aqua nearby Scripps' Pier.
On the terminal, let's run:

.. code-block:: console

    $ OceanColor InRange \
      --username=<earthdata-username> \
      --password=<earthdata-password> \
      --data-type=L2 \
      --time-tolerance=12 \
      --distance-tolerance=15e3 \
      2019-05-21T12:00:00,32.867066,-117.257408

Using it inside Python is more flexible than in the terminal. Check the manual
on how to use it.

------------
Alternatives
------------

* `pyModis <https://github.com/lucadelu/pyModis>`_ is a well established and
  mature package. If you are not satisfied with OceanColor, consider using
  pyModis. If you are interested in working with full frames (granules),
  instead of the subset of pixels nearby some reference, pyModis might be
  a better solution for you.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "OceanColor",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "NASA,Ocean Color,chlorophyll,oceanography,matchup",
    "author": "Guilherme Castelao",
    "author_email": "guilherme@castelao.net",
    "download_url": "https://files.pythonhosted.org/packages/14/ae/c09935f85c66c30974334a27c2315df7748e8610899b1508b9c5bc16edd5/OceanColor-0.1.0.tar.gz",
    "platform": null,
    "description": "===========\nOcean Color\n===========\n\n.. image:: https://zenodo.org/badge/318619654.svg\n   :target: https://zenodo.org/badge/latestdoi/318619654\n\n.. image:: https://readthedocs.org/projects/oceancolor/badge/?version=latest\n        :target: https://oceancolor.readthedocs.io/en/latest/?badge=latest\n        :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/v/OceanColor.svg\n        :target: https://pypi.python.org/pypi/OceanColor\n\n.. image:: https://github.com/castelao/OceanColor/actions/workflows/ci.yml/badge.svg\n        :target: https://github.com/castelao/OceanColor/actions\n\n.. image:: https://mybinder.org/badge_logo.svg\n   :target: https://mybinder.org/v2/gh/castelao/OceanColor/main?filepath=docs%2Fnotebooks\n\nSearch and subset NASA Ocean Color data\n\n* Free software: BSD license\n* Documentation: https://oceancolor.readthedocs.io.\n\nNASA provides great resources to search and access its data. This package is\nintended to fill a gap in obtaining chlorophyll data to be compared with in\nsitu observations by searching pixels within a given time and distance tolerance.\nFor instance, it is used to calibrate chlorophyll fluorescence measurements\nfrom Spray underwater gliders.\n\nThe OceanColor package was developed at the `Instrument Development Group\n<https://idg.ucsd.edu>`_ of `Scripps Institution of Oceanography\n<https://scripps.ucsd.edu>`_ in support for the `California Underwater Glider\nNetwork <https://spraydata.ucsd.edu/projects/CUGN/>`_ operations, which is\nfunded by:\n\n* Global Ocean Monitoring and Observing (GOMO) Program - NOAA\n* Southern California Coastal Ocean Observing System (SCCOOS)\n\n---------------------\nQuickstart - terminal\n---------------------\n\nLet's install it\n\n.. code-block:: console\n\n    $ pip install OceanColor\n\nor\n\n.. code-block:: console\n\n    $ conda install OceanColor\n\nLet's get the L2 chlorophyll measurements from MODIS-Aqua nearby Scripps' Pier.\nOn the terminal, let's run:\n\n.. code-block:: console\n\n    $ OceanColor InRange \\\n      --username=<earthdata-username> \\\n      --password=<earthdata-password> \\\n      --data-type=L2 \\\n      --time-tolerance=12 \\\n      --distance-tolerance=15e3 \\\n      2019-05-21T12:00:00,32.867066,-117.257408\n\nUsing it inside Python is more flexible than in the terminal. Check the manual\non how to use it.\n\n------------\nAlternatives\n------------\n\n* `pyModis <https://github.com/lucadelu/pyModis>`_ is a well established and\n  mature package. If you are not satisfied with OceanColor, consider using\n  pyModis. If you are interested in working with full frames (granules),\n  instead of the subset of pixels nearby some reference, pyModis might be\n  a better solution for you.\n",
    "bugtrack_url": null,
    "license": "BSD License  Copyright (c) 2020-2021, Guilherme Castel\u00e3o All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  * 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.  * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  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. ",
    "summary": "Deal with NASA Ocean Color data (search and download)",
    "version": "0.1.0",
    "project_urls": {
        "documentation": "https://oceancolor.readthedocs.io",
        "homepage": "https://github.com/castelao/OceanColor",
        "repository": "https://github.com/castelao/OceanColor"
    },
    "split_keywords": [
        "nasa",
        "ocean color",
        "chlorophyll",
        "oceanography",
        "matchup"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6e67c968158a0a67d1be7c2a947883b98d6112a1416dcec0a33388ec08084e22",
                "md5": "de3f41f62f7275b503bbdcf2b7877e69",
                "sha256": "8d952315c1d2fb63bd67e0d45d4393d321fa468364bd315dbfe65d6da9baf4de"
            },
            "downloads": -1,
            "filename": "OceanColor-0.1.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "de3f41f62f7275b503bbdcf2b7877e69",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.8",
            "size": 28124,
            "upload_time": "2023-10-08T02:01:46",
            "upload_time_iso_8601": "2023-10-08T02:01:46.744311Z",
            "url": "https://files.pythonhosted.org/packages/6e/67/c968158a0a67d1be7c2a947883b98d6112a1416dcec0a33388ec08084e22/OceanColor-0.1.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "14aec09935f85c66c30974334a27c2315df7748e8610899b1508b9c5bc16edd5",
                "md5": "68d5494959c605eef840a6a422aec381",
                "sha256": "c88d7b81ed3e5aef3c754a5fe064c55f37c475e6d55dd405f1d79cb830fa2849"
            },
            "downloads": -1,
            "filename": "OceanColor-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "68d5494959c605eef840a6a422aec381",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 195564,
            "upload_time": "2023-10-08T02:01:48",
            "upload_time_iso_8601": "2023-10-08T02:01:48.671663Z",
            "url": "https://files.pythonhosted.org/packages/14/ae/c09935f85c66c30974334a27c2315df7748e8610899b1508b9c5bc16edd5/OceanColor-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-08 02:01:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "castelao",
    "github_project": "OceanColor",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "oceancolor"
}
        
Elapsed time: 0.12785s