erddapy


Nameerddapy JSON
Version 2.2.0 PyPI version JSON
download
home_page
SummaryPython interface for ERDDAP
upload_time2023-08-09 14:28:26
maintainer
docs_urlNone
author
requires_python>=3.8
licenseCopyright 2017 Filipe Fernandes Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. 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. 3. 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
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            <h1 align="center" style="margin:1em;">
  <a href="https://ioos.github.io/erddapy/">erddapy</a>
</h1>

<h4 align="center">
erddapy: ERDDAP + Python.
</h4>

<p align="center">
<a href="https://anaconda.org/conda-forge/erddapy">
<img src="https://img.shields.io/conda/dn/conda-forge/erddapy.svg"
 alt="conda-forge downloads" /></a>
<a href="https://github.com/ioos/erddapy/releases">
<img src="https://img.shields.io/github/tag/ioos/erddapy.svg"
 alt="Latest version" /></a>
<a href="https://github.com/ioos/erddapy/commits/main">
<img src="https://img.shields.io/github/commits-since/ioos/erddapy/latest.svg"
 alt="Commits since last release" /></a>
<a href="https://github.com/ioos/erddapy/graphs/contributors">
<img src="https://img.shields.io/github/contributors/ioos/erddapy.svg"
 alt="# contributors" /></a>
<a href="https://zenodo.org/badge/latestdoi/104919828">
<img src="https://zenodo.org/badge/104919828.svg"
 alt="zenodo" /></a>
<a href="https://pypi.org/project/erddapy">
<img src="https://img.shields.io/pypi/pyversions/erddapy.svg"
 alt="zenodo" /></a>
<a href="https://results.pre-commit.ci/latest/github/ioos/erddapy/main">
<img src="https://results.pre-commit.ci/badge/github/ioos/erddapy/main.svg"
 alt="pre-commit.ci status" /></a>

 <a href="https://github.com/ioos/erddapy/actions">
<img src="https://github.com/ioos/erddapy/actions/workflows/tests.yml/badge.svg"
 alt="GHA-tests" /></a>


</p>

<br>



# Table of contents

<!-- toc -->

- [Overview](#overview)
  - [Example](#example)
- [Get in touch](#get-in-touch)
- [License and copyright](#license-and-copyright)

<!-- tocstop -->


## Overview

Easier access to scientific data.

erddapy takes advantage of ERDDAP's RESTful web services and creates the ERDDAP URL for any request,
like searching for datasets, acquiring metadata, downloading the data, etc.

What is ERDDAP?
ERDDAP unifies the different types of data servers and offers a consistent way to get the data in multiple the formats.
For more information on ERDDAP servers please see [https://coastwatch.pfeg.noaa.gov/erddap/index.html](https://coastwatch.pfeg.noaa.gov/erddap/index.html).

### Documentation and code

The documentation is hosted at <https://ioos.github.io/erddapy>.

The code is hosted at <https://github.com/ioos/erddapy>.

### Installation

For `conda` users you can

```shell
conda install --channel conda-forge erddapy
```

or, if you are a `pip` users

```shell
python -m pip install erddapy
```

Note that, if you are installing the `requirements-dev.txt`, the `iris` package
is named `scitools-iris` on PyPI so `pip` users must rename that before installing.

### Example

```python
from erddapy import ERDDAP


e = ERDDAP(
  server="https://gliders.ioos.us/erddap",
  protocol="tabledap",
)

e.response = "csv"
e.dataset_id = "whoi_406-20160902T1700"
e.constraints = {
    "time>=": "2016-07-10T00:00:00Z",
    "time<=": "2017-02-10T00:00:00Z",
    "latitude>=": 38.0,
    "latitude<=": 41.0,
    "longitude>=": -72.0,
    "longitude<=": -69.0,
}
e.variables = [
    "depth",
    "latitude",
    "longitude",
    "salinity",
    "temperature",
    "time",
]

df = e.to_pandas()
```


## Get in touch

Report bugs, suggest features or view the source code on [GitHub](https://github.com/ioos/erddapy/issues).

## Projects using erddapy

- [argopy](https://github.com/euroargodev/argopy)
- [gliderpy](https://github.com/ioos/gliderpy)
- [gdutils](https://github.com/kerfoot/gdutils)
- [colocate](https://github.com/ioos/colocate)
- [intake-erddap](https://github.com/jmunroe/intake-erddap)
- [ioos_qc](https://github.com/ioos/ioos_qc)

## Similar projects

- [rerddap](https://cran.r-project.org/web/packages/rerddap) implements a nice client for R that performs searches on a curated set of servers instead of a query per server like erddapy.

- [erddap-python](https://github.com/hmedrano/erddap-python) 99% of the same functionality as erddapy but with a JavaScript-like API.

## License and copyright

Erddapy is licensed under BSD 3-Clause "New" or "Revised" License (BSD-3-Clause).

Development occurs on GitHub at <https://github.com/ioos/erddapy>.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "erddapy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "Filipe Fernandes <ocefpaf+erddapy@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/8d/20/da2207bab0cc6e56f875b9eb77dd9e7d0601cd23acc5147073ee5dca9a37/erddapy-2.2.0.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\" style=\"margin:1em;\">\n  <a href=\"https://ioos.github.io/erddapy/\">erddapy</a>\n</h1>\n\n<h4 align=\"center\">\nerddapy: ERDDAP + Python.\n</h4>\n\n<p align=\"center\">\n<a href=\"https://anaconda.org/conda-forge/erddapy\">\n<img src=\"https://img.shields.io/conda/dn/conda-forge/erddapy.svg\"\n alt=\"conda-forge downloads\" /></a>\n<a href=\"https://github.com/ioos/erddapy/releases\">\n<img src=\"https://img.shields.io/github/tag/ioos/erddapy.svg\"\n alt=\"Latest version\" /></a>\n<a href=\"https://github.com/ioos/erddapy/commits/main\">\n<img src=\"https://img.shields.io/github/commits-since/ioos/erddapy/latest.svg\"\n alt=\"Commits since last release\" /></a>\n<a href=\"https://github.com/ioos/erddapy/graphs/contributors\">\n<img src=\"https://img.shields.io/github/contributors/ioos/erddapy.svg\"\n alt=\"# contributors\" /></a>\n<a href=\"https://zenodo.org/badge/latestdoi/104919828\">\n<img src=\"https://zenodo.org/badge/104919828.svg\"\n alt=\"zenodo\" /></a>\n<a href=\"https://pypi.org/project/erddapy\">\n<img src=\"https://img.shields.io/pypi/pyversions/erddapy.svg\"\n alt=\"zenodo\" /></a>\n<a href=\"https://results.pre-commit.ci/latest/github/ioos/erddapy/main\">\n<img src=\"https://results.pre-commit.ci/badge/github/ioos/erddapy/main.svg\"\n alt=\"pre-commit.ci status\" /></a>\n\n <a href=\"https://github.com/ioos/erddapy/actions\">\n<img src=\"https://github.com/ioos/erddapy/actions/workflows/tests.yml/badge.svg\"\n alt=\"GHA-tests\" /></a>\n\n\n</p>\n\n<br>\n\n\n\n# Table of contents\n\n<!-- toc -->\n\n- [Overview](#overview)\n  - [Example](#example)\n- [Get in touch](#get-in-touch)\n- [License and copyright](#license-and-copyright)\n\n<!-- tocstop -->\n\n\n## Overview\n\nEasier access to scientific data.\n\nerddapy takes advantage of ERDDAP's RESTful web services and creates the ERDDAP URL for any request,\nlike searching for datasets, acquiring metadata, downloading the data, etc.\n\nWhat is ERDDAP?\nERDDAP unifies the different types of data servers and offers a consistent way to get the data in multiple the formats.\nFor more information on ERDDAP servers please see [https://coastwatch.pfeg.noaa.gov/erddap/index.html](https://coastwatch.pfeg.noaa.gov/erddap/index.html).\n\n### Documentation and code\n\nThe documentation is hosted at <https://ioos.github.io/erddapy>.\n\nThe code is hosted at <https://github.com/ioos/erddapy>.\n\n### Installation\n\nFor `conda` users you can\n\n```shell\nconda install --channel conda-forge erddapy\n```\n\nor, if you are a `pip` users\n\n```shell\npython -m pip install erddapy\n```\n\nNote that, if you are installing the `requirements-dev.txt`, the `iris` package\nis named `scitools-iris` on PyPI so `pip` users must rename that before installing.\n\n### Example\n\n```python\nfrom erddapy import ERDDAP\n\n\ne = ERDDAP(\n  server=\"https://gliders.ioos.us/erddap\",\n  protocol=\"tabledap\",\n)\n\ne.response = \"csv\"\ne.dataset_id = \"whoi_406-20160902T1700\"\ne.constraints = {\n    \"time>=\": \"2016-07-10T00:00:00Z\",\n    \"time<=\": \"2017-02-10T00:00:00Z\",\n    \"latitude>=\": 38.0,\n    \"latitude<=\": 41.0,\n    \"longitude>=\": -72.0,\n    \"longitude<=\": -69.0,\n}\ne.variables = [\n    \"depth\",\n    \"latitude\",\n    \"longitude\",\n    \"salinity\",\n    \"temperature\",\n    \"time\",\n]\n\ndf = e.to_pandas()\n```\n\n\n## Get in touch\n\nReport bugs, suggest features or view the source code on [GitHub](https://github.com/ioos/erddapy/issues).\n\n## Projects using erddapy\n\n- [argopy](https://github.com/euroargodev/argopy)\n- [gliderpy](https://github.com/ioos/gliderpy)\n- [gdutils](https://github.com/kerfoot/gdutils)\n- [colocate](https://github.com/ioos/colocate)\n- [intake-erddap](https://github.com/jmunroe/intake-erddap)\n- [ioos_qc](https://github.com/ioos/ioos_qc)\n\n## Similar projects\n\n- [rerddap](https://cran.r-project.org/web/packages/rerddap) implements a nice client for R that performs searches on a curated set of servers instead of a query per server like erddapy.\n\n- [erddap-python](https://github.com/hmedrano/erddap-python) 99% of the same functionality as erddapy but with a JavaScript-like API.\n\n## License and copyright\n\nErddapy is licensed under BSD 3-Clause \"New\" or \"Revised\" License (BSD-3-Clause).\n\nDevelopment occurs on GitHub at <https://github.com/ioos/erddapy>.\n",
    "bugtrack_url": null,
    "license": "Copyright 2017 Filipe Fernandes   Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. 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.  3. 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": "Python interface for ERDDAP",
    "version": "2.2.0",
    "project_urls": {
        "documentation": "https://ioos.github.io/erddapy",
        "homepage": "https://github.com/ioos/erddapy",
        "repository": "https://github.com/ioos/erddapy"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2be310359f9f7a392a66c075ef3986d2b551a942e47bd0b4c8bd2f3cf6fe0e9e",
                "md5": "b3f51f7d0c8fe6185e43f3f23a06568f",
                "sha256": "5b5d22ce945c26ef1c2f33049986d8e916b6e2e475eb2724f7093628c8203a81"
            },
            "downloads": -1,
            "filename": "erddapy-2.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b3f51f7d0c8fe6185e43f3f23a06568f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 22911,
            "upload_time": "2023-08-09T14:28:25",
            "upload_time_iso_8601": "2023-08-09T14:28:25.210504Z",
            "url": "https://files.pythonhosted.org/packages/2b/e3/10359f9f7a392a66c075ef3986d2b551a942e47bd0b4c8bd2f3cf6fe0e9e/erddapy-2.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8d20da2207bab0cc6e56f875b9eb77dd9e7d0601cd23acc5147073ee5dca9a37",
                "md5": "d11a0b255329616b107ad3f3278c963f",
                "sha256": "c76b115fb27a248e1a463db7358ec886b1252bde8857669679b4c507b1a1570d"
            },
            "downloads": -1,
            "filename": "erddapy-2.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d11a0b255329616b107ad3f3278c963f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 20208,
            "upload_time": "2023-08-09T14:28:26",
            "upload_time_iso_8601": "2023-08-09T14:28:26.419605Z",
            "url": "https://files.pythonhosted.org/packages/8d/20/da2207bab0cc6e56f875b9eb77dd9e7d0601cd23acc5147073ee5dca9a37/erddapy-2.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-09 14:28:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ioos",
    "github_project": "erddapy",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "lcname": "erddapy"
}
        
Elapsed time: 0.20381s