odc.stac
########
|Documentation Status| |Test Status| |Test Coverage| |Binder|
Load STAC items into ``xarray`` Datasets. Process locally or distribute data
loading and computation with Dask_.
Usage
#####
odc.stac.load
~~~~~~~~~~~~~
.. code-block:: python
catalog = pystac_client.Client.open(...)
query = catalog.search(...)
xx = odc.stac.load(
query.get_items(),
bands=["red", "green", "blue"],
)
xx.red.plot.imshow(col="time")
For more details see `Documentation`_ and `Sample Notebooks`_, or try it out on Binder_.
Installation
############
Using pip
~~~~~~~~~
.. code-block:: bash
pip install odc-stac
To install with ``botocore`` support (for working with AWS):
.. code-block:: bash
pip install 'odc-stac[botocore]'
Using Conda
~~~~~~~~~~~
This package is be available on ``conda-forge`` channel:
.. code-block:: bash
conda install -c conda-forge odc-stac
From unreleased source
~~~~~~~~~~~~~~~~~~~~~~
To use development version of ``odc-stac`` install dependencies from ``conda``, then
install ``odc-stac`` with ``pip``.
Sample ``environment.yml`` is provided below.
.. code-block:: yaml
channels:
- conda-forge
dependencies:
- odc-geo
- xarray
- numpy
- dask
- pandas
- affine
- rasterio
- toolz
- pystac
- pystac-client
- pip
- pip:
- "git+https://github.com/opendatacube/odc-stac/"
Developing
##########
To develop ``odc-stac`` locally using pip (assuming you have virtualenvwrapper_ installed):
.. code-block:: bash
git clone https://github.com/opendatacube/odc-stac
cd odc-stac
mkvirtualenv odc-stac
pip install -e .
pip install -r requirements-dev.txt
Run tests with pytest_:
.. code-block:: bash
pytest
Linting is provided by mypy_, pylint_, and black_:
.. code-block:: bash
black --check .
pylint -v odc
mypy odc
.. |Documentation Status| image:: https://readthedocs.org/projects/odc-stac/badge/?version=latest
:target: https://odc-stac.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |Test Status| image:: https://github.com/opendatacube/odc-stac/actions/workflows/main.yml/badge.svg
:target: https://github.com/opendatacube/odc-stac/actions/workflows/main.yml
:alt: Test Status
.. |Test Coverage| image:: https://codecov.io/gh/opendatacube/odc-stac/branch/develop/graph/badge.svg?token=HQ8nTuZHH5
:target: https://codecov.io/gh/opendatacube/odc-stac
:alt: Test Coverage
.. |Binder| image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/opendatacube/odc-stac/develop?urlpath=lab/workspaces/demo
:alt: Run Examples in Binder
.. _Binder: https://mybinder.org/v2/gh/opendatacube/odc-stac/develop?urlpath=lab/workspaces/demo
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io
.. _pytest: https://docs.pytest.org
.. _mypy: http://mypy-lang.org/
.. _pylint: https://pylint.org/
.. _black: https://github.com/psf/black
.. _`Documentation`: https://odc-stac.readthedocs.io/
.. _`Sample Notebooks`: https://odc-stac.readthedocs.io/en/latest/examples.html
.. _Dask: https://dask.org/
Raw data
{
"_id": null,
"home_page": "https://github.com/opendatacube/odc-stac/",
"name": "odc-stac",
"maintainer": "Open Data Cube",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Open Data Cube",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/10/48/c0bd4278c83f2f6ad953f80fc451a412b5b6d101c5fec09968b1c29b27b2/odc_stac-0.3.10.tar.gz",
"platform": "any",
"description": "odc.stac\n########\n\n|Documentation Status| |Test Status| |Test Coverage| |Binder|\n\nLoad STAC items into ``xarray`` Datasets. Process locally or distribute data\nloading and computation with Dask_.\n\nUsage\n#####\n\n\nodc.stac.load\n~~~~~~~~~~~~~\n\n.. code-block:: python\n\n catalog = pystac_client.Client.open(...)\n query = catalog.search(...)\n xx = odc.stac.load(\n query.get_items(),\n bands=[\"red\", \"green\", \"blue\"],\n )\n xx.red.plot.imshow(col=\"time\")\n\nFor more details see `Documentation`_ and `Sample Notebooks`_, or try it out on Binder_.\n\n\nInstallation\n############\n\nUsing pip\n~~~~~~~~~\n\n.. code-block:: bash\n\n pip install odc-stac\n\nTo install with ``botocore`` support (for working with AWS):\n\n.. code-block:: bash\n\n pip install 'odc-stac[botocore]'\n\n\nUsing Conda\n~~~~~~~~~~~\n\nThis package is be available on ``conda-forge`` channel:\n\n.. code-block:: bash\n\n conda install -c conda-forge odc-stac\n\n\nFrom unreleased source\n~~~~~~~~~~~~~~~~~~~~~~\n\nTo use development version of ``odc-stac`` install dependencies from ``conda``, then\ninstall ``odc-stac`` with ``pip``.\n\nSample ``environment.yml`` is provided below.\n\n.. code-block:: yaml\n\n channels:\n - conda-forge\n dependencies:\n - odc-geo\n - xarray\n - numpy\n - dask\n - pandas\n - affine\n - rasterio\n - toolz\n - pystac\n - pystac-client\n - pip\n - pip:\n - \"git+https://github.com/opendatacube/odc-stac/\"\n\nDeveloping\n##########\n\nTo develop ``odc-stac`` locally using pip (assuming you have virtualenvwrapper_ installed):\n\n.. code-block:: bash\n\n git clone https://github.com/opendatacube/odc-stac\n cd odc-stac\n mkvirtualenv odc-stac\n pip install -e .\n pip install -r requirements-dev.txt\n\nRun tests with pytest_:\n\n.. code-block:: bash\n\n pytest\n\nLinting is provided by mypy_, pylint_, and black_:\n\n.. code-block:: bash\n\n black --check .\n pylint -v odc\n mypy odc\n\n\n.. |Documentation Status| image:: https://readthedocs.org/projects/odc-stac/badge/?version=latest\n :target: https://odc-stac.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |Test Status| image:: https://github.com/opendatacube/odc-stac/actions/workflows/main.yml/badge.svg\n :target: https://github.com/opendatacube/odc-stac/actions/workflows/main.yml\n :alt: Test Status\n\n.. |Test Coverage| image:: https://codecov.io/gh/opendatacube/odc-stac/branch/develop/graph/badge.svg?token=HQ8nTuZHH5\n :target: https://codecov.io/gh/opendatacube/odc-stac\n :alt: Test Coverage\n\n.. |Binder| image:: https://mybinder.org/badge_logo.svg\n :target: https://mybinder.org/v2/gh/opendatacube/odc-stac/develop?urlpath=lab/workspaces/demo\n :alt: Run Examples in Binder\n\n.. _Binder: https://mybinder.org/v2/gh/opendatacube/odc-stac/develop?urlpath=lab/workspaces/demo\n\n.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io\n\n.. _pytest: https://docs.pytest.org\n\n.. _mypy: http://mypy-lang.org/\n\n.. _pylint: https://pylint.org/\n\n.. _black: https://github.com/psf/black\n\n.. _`Documentation`: https://odc-stac.readthedocs.io/\n\n.. _`Sample Notebooks`: https://odc-stac.readthedocs.io/en/latest/examples.html\n\n.. _Dask: https://dask.org/\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Tooling for converting STAC metadata to ODC data model",
"version": "0.3.10",
"project_urls": {
"Bug Reporting": "https://github.com/opendatacube/odc-stac/issues",
"Documentation": "https://odc-stac.readthedocs.io/en/latest/",
"Homepage": "https://github.com/opendatacube/odc-stac/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c7b05de30edfd7bc0bb8b7b7bd6a9913cbd262a5378056769638ba644f86222",
"md5": "d6eae785eeb5a1786ad76ecab978f9b4",
"sha256": "5d50899318e4a3b51e7bd721e7bc674a6aa493ab17a4adb266178184dc9f30a9"
},
"downloads": -1,
"filename": "odc_stac-0.3.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6eae785eeb5a1786ad76ecab978f9b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 89151,
"upload_time": "2024-07-01T02:08:29",
"upload_time_iso_8601": "2024-07-01T02:08:29.824060Z",
"url": "https://files.pythonhosted.org/packages/3c/7b/05de30edfd7bc0bb8b7b7bd6a9913cbd262a5378056769638ba644f86222/odc_stac-0.3.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1048c0bd4278c83f2f6ad953f80fc451a412b5b6d101c5fec09968b1c29b27b2",
"md5": "dfe6ee9cf2b2adc286f72bf919fb3a8b",
"sha256": "ba3c6357804e51bf7912b272236a8f8c85692f2a17f43dc74c9ed8feb69e04f6"
},
"downloads": -1,
"filename": "odc_stac-0.3.10.tar.gz",
"has_sig": false,
"md5_digest": "dfe6ee9cf2b2adc286f72bf919fb3a8b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 89217,
"upload_time": "2024-07-01T02:08:31",
"upload_time_iso_8601": "2024-07-01T02:08:31.570783Z",
"url": "https://files.pythonhosted.org/packages/10/48/c0bd4278c83f2f6ad953f80fc451a412b5b6d101c5fec09968b1c29b27b2/odc_stac-0.3.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-01 02:08:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "opendatacube",
"github_project": "odc-stac",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "odc-stac"
}
JSON
