dea-tools


Namedea-tools JSON
Version 0.4.0 PyPI version JSON
download
home_pageNone
SummaryOpen-source tools for geospatial analysis with Digital Earth Australia, Open Data Cube, and Xarray
upload_time2025-07-16 04:47:58
maintainerNone
docs_urlNone
authorNone
requires_python<4.0,>=3.10
licenseNone
keywords datacube digital earth australia earth observation geospatial analysis remote sensing satellite data
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <img src="https://raw.githubusercontent.com/GeoscienceAustralia/dea-notebooks/stable/Supplementary_data/dea_logo_wide.jpg" width="900" alt="Digital Earth Australia logo" />

# DEA Tools Python package

[![DOI](https://img.shields.io/badge/DOI-10.26186/145234-0e7fbf.svg)](https://doi.org/10.26186/145234) [![Apache license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Discord](https://img.shields.io/discord/1212501566326571070?label=Discord&logo=discord&logoColor=white&color=7289DA)](https://discord.com/invite/4hhBQVas5U)

`dea-tools` is an open-source Python package for geospatial analysis of satellite data using Digital Earth Australia, Open Data Cube, and Xarray.
It provides a broad set of utilities for loading, visualising, transforming, and analysing Earth Observation (EO) data across space and time.

The package includes tools for:

* πŸ“¦ **Data handling**: Load and combine DEA data products, manage projections and resolutions.
* πŸ—ΊοΈ **Visualisation**: Create static and interactive maps, RGB plots, and animations.
* πŸ›°οΈ **Remote sensing indices**: Calculate band indices such as NDVI, NDWI, and more.
* 🌐 **Spatial and temporal analysis**: Apply raster/vector operations, extract contours, compute temporal stats, and model change over time.
* πŸ€– **Machine learning and segmentation**: Train and apply classifiers, or run image segmentation workflows.
* βš™οΈ **Parallel processing**: Set up Dask clusters for scalable processing of large datasets.
* 🌏 **Domain-specific tools**: Analyse coastal change, intertidal zones, land cover, wetland and waterbody dynamics, and climate datasets.

## API documentation

Full API documentation describing the modules and functions available in `dea-tools` is available on the [DEA Knowledge Hub](https://knowledge.dea.ga.gov.au/notebooks/Tools/).

## Installation

You can install `dea-tools` from PyPI with `pip` (https://pypi.org/project/dea-tools/).

By default `dea-tools` will be installed with [minimal dependencies](https://github.com/GeoscienceAustralia/dea-notebooks/blob/develop/pyproject.toml), which excludes `datacube` and other difficult to install packages:

```console
pip install dea-tools
```

To install with `datacube` dependencies (note that this requires access to a datacube database):
```console
pip install dea-tools[datacube]
```

To install with additonal Jupyter-related dependencies:
```console
pip install dea-tools[jupyter]
```

To install with other packages used in DEA Notebooks examples:
```console
pip install dea-tools[jupyter,dask_gateway,hdstats,notebooks]
```

You can also install `dea-tools` with *all* optional dependencies. **Note:** some of these dependencies are difficult to install. If you encounter issues, you may need to try the [Conda](#with-conda) instructions below.
```console
pip install dea-tools[all]
```

### With conda

If you encounter issues with the installation, try installing the package in a `conda` Python environment where [GDAL](https://pypi.org/project/GDAL/) and [pyproj](https://pypi.org/project/pyproj/) are already installed:

```console
wget -O conda-environment.yml https://raw.githubusercontent.com/opendatacube/datacube-core/develop/conda-environment.yml

mamba env create -f conda-environment.yml
conda activate cubeenv

pip install dea-tools
```

### Working on DEA Sandbox or NCI

To work with this module on the DEA Sandbox or National Computational Infrastructure environments without installing it, you can add the `Tools` directory to the system path from within your `dea-notebooks` directory:

```python
import sys
sys.path.insert(1, "../Tools/")
from dea_tools.datahandling import load_ard  # or some other function
```

Alternatively, you can also do a local installation of `dea-tools`. To do this on the DEA Sandbox, run `pip` from the terminal from within your `dea-notebooks` directory:

```bash
pip install -e .
```

## Importing functions in Python

One `dea-tools` is installed, you can import functions using:

```python
from dea_tools.datahandling import load_ard
from dea_tools.plotting import rgb
```

## Citing DEA Tools

If you use any of the notebooks, code or tools in this repository in your work, please reference them using the following citation:

> Krause, C., Dunn, B., Bishop-Taylor, R., Adams, C., Burton, C., Alger, M., Chua, S., Phillips, C., Newey, V., Kouzoubov, K., Leith, A., Ayers, D., Hicks, A., DEA Notebooks contributors 2021. Digital Earth Australia notebooks and tools repository. Geoscience Australia, Canberra. https://doi.org/10.26186/145234

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "dea-tools",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "datacube, digital earth australia, earth observation, geospatial analysis, remote sensing, satellite data",
    "author": null,
    "author_email": "Geoscience Australia <earth.observation@ga.gov.au>",
    "download_url": "https://files.pythonhosted.org/packages/cb/1e/9ffd6445aa015b0027236aa4d374d152009171f6d7688f207da2479bfd81/dea_tools-0.4.0.tar.gz",
    "platform": null,
    "description": "<img src=\"https://raw.githubusercontent.com/GeoscienceAustralia/dea-notebooks/stable/Supplementary_data/dea_logo_wide.jpg\" width=\"900\" alt=\"Digital Earth Australia logo\" />\n\n# DEA Tools Python package\n\n[![DOI](https://img.shields.io/badge/DOI-10.26186/145234-0e7fbf.svg)](https://doi.org/10.26186/145234) [![Apache license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Discord](https://img.shields.io/discord/1212501566326571070?label=Discord&logo=discord&logoColor=white&color=7289DA)](https://discord.com/invite/4hhBQVas5U)\n\n`dea-tools` is an open-source Python package for geospatial analysis of satellite data using Digital Earth Australia, Open Data Cube, and Xarray.\nIt provides a broad set of utilities for loading, visualising, transforming, and analysing Earth Observation (EO) data across space and time.\n\nThe package includes tools for:\n\n* \ud83d\udce6 **Data handling**: Load and combine DEA data products, manage projections and resolutions.\n* \ud83d\uddfa\ufe0f **Visualisation**: Create static and interactive maps, RGB plots, and animations.\n* \ud83d\udef0\ufe0f **Remote sensing indices**: Calculate band indices such as NDVI, NDWI, and more.\n* \ud83c\udf10 **Spatial and temporal analysis**: Apply raster/vector operations, extract contours, compute temporal stats, and model change over time.\n* \ud83e\udd16 **Machine learning and segmentation**: Train and apply classifiers, or run image segmentation workflows.\n* \u2699\ufe0f **Parallel processing**: Set up Dask clusters for scalable processing of large datasets.\n* \ud83c\udf0f **Domain-specific tools**: Analyse coastal change, intertidal zones, land cover, wetland and waterbody dynamics, and climate datasets.\n\n## API documentation\n\nFull API documentation describing the modules and functions available in `dea-tools` is available on the [DEA Knowledge Hub](https://knowledge.dea.ga.gov.au/notebooks/Tools/).\n\n## Installation\n\nYou can install `dea-tools` from PyPI with `pip` (https://pypi.org/project/dea-tools/).\n\nBy default `dea-tools` will be installed with [minimal dependencies](https://github.com/GeoscienceAustralia/dea-notebooks/blob/develop/pyproject.toml), which excludes `datacube` and other difficult to install packages:\n\n```console\npip install dea-tools\n```\n\nTo install with `datacube` dependencies (note that this requires access to a datacube database):\n```console\npip install dea-tools[datacube]\n```\n\nTo install with additonal Jupyter-related dependencies:\n```console\npip install dea-tools[jupyter]\n```\n\nTo install with other packages used in DEA Notebooks examples:\n```console\npip install dea-tools[jupyter,dask_gateway,hdstats,notebooks]\n```\n\nYou can also install `dea-tools` with *all* optional dependencies. **Note:** some of these dependencies are difficult to install. If you encounter issues, you may need to try the [Conda](#with-conda) instructions below.\n```console\npip install dea-tools[all]\n```\n\n### With conda\n\nIf you encounter issues with the installation, try installing the package in a `conda` Python environment where [GDAL](https://pypi.org/project/GDAL/) and [pyproj](https://pypi.org/project/pyproj/) are already installed:\n\n```console\nwget -O conda-environment.yml https://raw.githubusercontent.com/opendatacube/datacube-core/develop/conda-environment.yml\n\nmamba env create -f conda-environment.yml\nconda activate cubeenv\n\npip install dea-tools\n```\n\n### Working on DEA Sandbox or NCI\n\nTo work with this module on the DEA Sandbox or National Computational Infrastructure environments without installing it, you can add the `Tools` directory to the system path from within your `dea-notebooks` directory:\n\n```python\nimport sys\nsys.path.insert(1, \"../Tools/\")\nfrom dea_tools.datahandling import load_ard  # or some other function\n```\n\nAlternatively, you can also do a local installation of `dea-tools`. To do this on the DEA Sandbox, run `pip` from the terminal from within your `dea-notebooks` directory:\n\n```bash\npip install -e .\n```\n\n## Importing functions in Python\n\nOne `dea-tools` is installed, you can import functions using:\n\n```python\nfrom dea_tools.datahandling import load_ard\nfrom dea_tools.plotting import rgb\n```\n\n## Citing DEA Tools\n\nIf you use any of the notebooks, code or tools in this repository in your work, please reference them using the following citation:\n\n> Krause, C., Dunn, B., Bishop-Taylor, R., Adams, C., Burton, C., Alger, M., Chua, S., Phillips, C., Newey, V., Kouzoubov, K., Leith, A., Ayers, D., Hicks, A., DEA Notebooks contributors 2021. Digital Earth Australia notebooks and tools repository. Geoscience Australia, Canberra. https://doi.org/10.26186/145234\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Open-source tools for geospatial analysis with Digital Earth Australia, Open Data Cube, and Xarray",
    "version": "0.4.0",
    "project_urls": {
        "Homepage": "https://github.com/GeoscienceAustralia/dea-notebooks",
        "Repository": "https://github.com/GeoscienceAustralia/dea-notebooks"
    },
    "split_keywords": [
        "datacube",
        " digital earth australia",
        " earth observation",
        " geospatial analysis",
        " remote sensing",
        " satellite data"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1c0ee9c61c86f4f67434446cd59ee6f0990942b43c6ab056392586b4ecc8a7dc",
                "md5": "992318bebe5f373112e52e6b37254207",
                "sha256": "50fb2b89bc7fc8aea8370b89acd94a8b7ea37444333505f17d4eb14d80db4d20"
            },
            "downloads": -1,
            "filename": "dea_tools-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "992318bebe5f373112e52e6b37254207",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 157676,
            "upload_time": "2025-07-16T04:47:56",
            "upload_time_iso_8601": "2025-07-16T04:47:56.767337Z",
            "url": "https://files.pythonhosted.org/packages/1c/0e/e9c61c86f4f67434446cd59ee6f0990942b43c6ab056392586b4ecc8a7dc/dea_tools-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "cb1e9ffd6445aa015b0027236aa4d374d152009171f6d7688f207da2479bfd81",
                "md5": "c436670be2b4af6244342af49366e6d0",
                "sha256": "1d3ebd6d9aa18c313f5de74512657810ec46aadc13d62ab2620b2f73869df518"
            },
            "downloads": -1,
            "filename": "dea_tools-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c436670be2b4af6244342af49366e6d0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 140788,
            "upload_time": "2025-07-16T04:47:58",
            "upload_time_iso_8601": "2025-07-16T04:47:58.844812Z",
            "url": "https://files.pythonhosted.org/packages/cb/1e/9ffd6445aa015b0027236aa4d374d152009171f6d7688f207da2479bfd81/dea_tools-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-16 04:47:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "GeoscienceAustralia",
    "github_project": "dea-notebooks",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "dea-tools"
}
        
Elapsed time: 0.68411s