Metadata-Version: 2.4
Name: pydap
Version: 3.5.9
Summary: A pure python implementation of the Data Access Protocol.
Author-email: Roberto De Almeida <roberto@dealmeida.net>
Maintainer-email: Miguel Jimenez-Urias <mjimenez@opendap.org>
License: The MIT License
        
        Copyright (c) 2003-2010 Roberto De Almeida
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: requests
Requires-Dist: requests-cache
Requires-Dist: scipy
Requires-Dist: Webob
Requires-Dist: beautifulsoup4
Requires-Dist: lxml
Requires-Dist: Jinja2
Provides-Extra: docs
Requires-Dist: Sphinx; extra == "docs"
Requires-Dist: Pygments; extra == "docs"
Requires-Dist: pandoc; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Provides-Extra: netcdf
Requires-Dist: netCDF4; extra == "netcdf"
Provides-Extra: server
Requires-Dist: werkzeug>=2.2.2; extra == "server"
Requires-Dist: gunicorn; extra == "server"
Requires-Dist: PasteDeploy; extra == "server"
Requires-Dist: docopt-ng; extra == "server"
Requires-Dist: cryptography; extra == "server"
Requires-Dist: gsw; extra == "server"
Requires-Dist: coards; extra == "server"
Dynamic: license-file

pydap
=====
[![Ubuntu CI](https://github.com/pydap/pydap/actions/workflows/run_tests_ubuntu.yml/badge.svg
)](https://github.com/pydap/pydap/actions/workflows/run_tests_ubuntu.yml)
[![MacOS CI](https://github.com/pydap/pydap/actions/workflows/run_tests_macos.yml/badge.svg
)](https://github.com/pydap/pydap/actions/workflows/run_tests_macos.yml)
[![Python](https://img.shields.io/pypi/pyversions/pydap.svg)](https://pypi.python.org/pypi/pydap/)
[![PyPI](https://img.shields.io/pypi/v/pydap.svg?maxAge=2592000?style=plastic)](https://pypi.python.org/pypi/pydap/)
[![conda forge](https://anaconda.org/conda-forge/pydap/badges/version.svg)](https://anaconda.org/conda-forge/pydap)
[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/pydap/pydap)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pydap/pydap/main.svg)](https://results.pre-commit.ci/latest/github/pydap/pydap/main)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14010567.svg)](https://doi.org/10.5281/zenodo.14010567)


What is pydap?
----------
[pydap](https://pydap.github.io/pydap/) is an open-source implementation of the OPeNDAP protocol, written from scratch in pure Python. You can use `pydap` to access scientific data available on the many OPeNDAP servers publicly-available through the internet. Because pydap supports remote and lazy evaluation, you can access the data without having to download it; Instead, you work with special array and iterable objects that download data on-the-fly as necessary, saving bandwidth and time. The module also comes with a robust-but-lightweight OPeNDAP server, implemented as a WSGI application.

Why pydap?
----------
Originally developed in the 2000s, `pydap` is one of the oldest open-source Python projects available and is routinely developed and maintained by the OPeNDAP community at large. In addition, `pydap` is a long-recognized backend engine (and dependency) for [xarray](https://github.com/pydata/xarray) and chances are you have used `pydap` in the past without knowing it.

Quickstart
----------
`pydap` is a lightweight python package that you can use in either of the two modalities: a client and as a server. You can install the latest version using [pip](http://pypi.python.org/pypi/pip). After [installing pip](http://www.pip-installer.org/en/latest/installing.html) you can install `pydap` with this command:

```bash
    $ pip install pydap
```
This will install pydap together with all the required dependencies.

`pydap` is also available through [Anaconda](https://www.anaconda.com/). Below we install `pydap` and its required dependencies, along with common additional packages in a fresh conda environment named `"pydap"`:

```bash
    $ conda create -n pydap -c conda-forge python=3.11 pydap numpy jupyterlab ipython netCDF4 scipy matplotlib
```
Now you simply activate the pydap environment:
```bash
    $ conda activate pydap
```

> [!NOTE]
> If you have `mamba` installed, you can replace `conda` in the commands with `mamba`.

You can now use pydap as a client and open any remotely served dataset, and `pydap` will download the accessed data on-the-fly as needed. For example consider [this](http://test.opendap.org:8080/opendap/catalog/ghrsst/20210102090000-JPL-L4_GHRSST-SSTfnd-MUR-GLOB-v02.0-fv04.1.nc.dmr.html) dataset currently hosted on OPeNDAP's Hyrax data server

```python
    from pydap.client import open_url
    pyds = open_url('http://test.opendap.org:8080/opendap/catalog/ghrsst/20210102090000-JPL-L4_GHRSST-SSTfnd-MUR-GLOB-v02.0-fv04.1.nc', protocol='dap4')
    pyds.tree()
```
```python
    .20210102090000-JPL-L4_GHRSST-SSTfnd-MUR-GLOB-v02.0-fv04.1.nc
    ├──time
    ├──lat
    ├──lon
    ├──analysed_sst
    ├──analysis_error
    ├──mask
    ├──sea_ice_fraction
    ├──dt_1km_data
    └──sst_anomaly
```
```python
    pyds['sst_anomaly'].shape
```
```python
    (1, 17999, 36000)
```

> [!NOTE]
> In the example above, no data was downloaded, it was all lazily evaluated using OPeNDAP's DMR (DAP4) metadata representation. For more information, please check the documentation on [using pydap as a client](https://pydap.github.io/pydap/client.html).

`pydap` also comes with a simple server, implemented as a [WSGI]( http://wsgi.org/) application. To use it, you first need to install the server and optionally a data handler:

## Running pydap as a Server

```bash
    $ pip install "pydap[server,netcdf]"
```

This will install the necessary dependencies for running pydap as a server, along with extra dependencies for handling [netCDF4](https://www.unidata.ucar.edu/software/netcdf/) dataset. Now create a directory for your server data.

To run the server just issue the command:

```bash
    $ pydap --data ./myserver/data/ --port 8001 --workers 4 --threads 4
```

This will start a standalone server running on the default http://localhost:8001/, serving netCDF files from ``./myserver/data/`` Since the server uses the [WSGI](http://wsgi.org/) standard, pydap uses by default one (1) worker and one (1)  thread, but these can be defined by the user like in the case above (four (4) workers and four (4) threads). `pydap` can also easily be run behind Apache.

The [server documentation](https://pydap.github.io/pydap/server.html) has more information on how to better deploy `pydap`.

## Documentation

For more information, see [the pydap documentation](https://pydap.github.io/pydap/).

## Help and Community

If you need any help with `pydap`, open an issue in this repository. You can also email the [mailing list](http://groups.google.com/group/pydap/). Finally, if you have a broader OPeNDAP access question, you can reach the OPeNDAP team on the [OPeNDAP Discourse](https://opendap.discourse.group/)!
