Metadata-Version: 2.4
Name: eodag_cube
Version: 0.6.2
Summary: Data access for EODAG
Author-email: CS GROUP - France <eodag@csgroup.space>
License: Apache 2.0
Project-URL: Repository, https://github.com/CS-SI/eodag-cube
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
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: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: NOTICE
Requires-Dist: eodag>=3.9.0
Requires-Dist: numpy
Requires-Dist: rasterio
Requires-Dist: xarray
Requires-Dist: rioxarray
Requires-Dist: h5netcdf
Requires-Dist: netcdf4
Requires-Dist: cfgrib
Requires-Dist: fsspec
Requires-Dist: s3fs
Requires-Dist: aiohttp
Provides-Extra: dev
Requires-Dist: flake8; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: tox-uv; extra == "dev"
Requires-Dist: nose; extra == "dev"
Requires-Dist: faker; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: moto>=5; extra == "dev"
Requires-Dist: responses!=0.24.0; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: wheel; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Requires-Dist: types-shapely; extra == "dev"
Requires-Dist: boto3-stubs[essential]; extra == "dev"
Dynamic: license-file

.. image:: https://badge.fury.io/py/eodag-cube.svg
    :target: https://badge.fury.io/py/eodag-cube

.. image:: https://img.shields.io/pypi/l/eodag-cube.svg
    :target: https://pypi.org/project/eodag-cube/

.. image:: https://img.shields.io/pypi/pyversions/eodag-cube.svg
    :target: https://pypi.org/project/eodag-cube/

.. image:: https://mybinder.org/badge_logo.svg
    :target: https://mybinder.org/v2/git/https%3A%2F%2Fgithub.com%2FCS-SI%2Feodag-cube.git/package-data?filepath=docs%2Fnotebooks%2Fclip-reproject.ipynb

EODAG-cube
==========

This project is the data-access part of `EODAG <https://github.com/CS-SI/eodag>`_

.. image:: https://eodag.readthedocs.io/en/latest/_static/eodag_bycs.png
    :target: https://github.com/CS-SI/eodag

|


Installation
============

EODAG-cube is on `PyPI <https://pypi.org/project/eodag-cube/>`_::

    python -m pip install eodag-cube

Documentation
=============

Documentation is available through `EODAG API User Guide / Data access with eodag-cube <https://eodag.readthedocs.io/en/latest/notebooks/api_user_guide/9_post_process.html#Data-access-with-eodag-cube>`_.

See also:

* `Python API Reference / EOProduct - pixel access <https://eodag.readthedocs.io/en/latest/api_reference/eoproduct.html#pixel-access>`_
* `Python API Reference / Assets - pixel access <https://eodag.readthedocs.io/en/latest/api_reference/assets.html#pixel-access>`_
* `Python API Reference / utils - xarray <https://eodag.readthedocs.io/en/latest/api_reference/utils.html#xarray>`_

Usage - Python API
==================

Example usage for interacting with the api in your Python code:

.. code-block:: python

    from eodag import EODataAccessGateway
    from rasterio.crs import CRS

    dag = EODataAccessGateway()
    search_criteria = dict(
        provider='earth_search',
        productType='S2_MSI_L1C',
        geom=[1, 43.5, 2, 44],
        start='2020-06-04',
        end='2020-06-05',
    )
    search_results = dag.search(**search_criteria)
    product = search_results[0]
    product

.. image:: docs/_static/eoproduct.png?raw=true
   :alt: EOProduct

Whole product as ``XarrayDict``:

.. code-block:: python

    product.to_xarray()

.. image:: docs/_static/xarray_dict.png?raw=true
   :alt: XarrayDict

Single asset as ``xarray.Dataset``:

.. code-block:: python

    product.assets["blue"].to_xarray()

.. image:: docs/_static/dataset.png?raw=true
   :alt: Dataset

``fsspec.core.OpenFile`` file object:

.. code-block:: python

    product.assets["blue"].get_file_obj()

``<File-like object S3FileSystem, sentinel-s2-l1c/tiles/31/T/DJ/2020/6/4/0/B02.jp2>``

Contribute
==========

If you intend to contribute to eodag-cube source code::

    git clone https://github.com/CS-SI/eodag-cube.git
    cd eodag-cube
    python -m pip install -e .[dev]
    pre-commit install
    tox

LICENSE
=======

EODAG is licensed under Apache License v2.0.
See LICENSE file for details.


AUTHORS
=======

EODAG is developed by `CS GROUP - France <https://www.c-s.fr>`_.
