Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Python functions and algorithms developed to assist in analysing Digital Earth Australia (DEA) data (e.g. loading data, plotting, spatial analysis, machine learning). This includes the following modules:

Loading data

  • dea_tools.datahandling: Loading and handling DEA data (e.g. combining multiple products, handling CRSs, pansharpening)

Plotting and transforming data

  • dea_tools.plotting: Plotting DEA data (e.g. RGB plots, animations, interactive maps)

  • dea_tools.bandindices.py: Calculating remote sensing band indices (e.g. NDVI, NDWI)

Spatial and temporal analysis

  • dea_tools.spatial: Spatial analysis tools (e.g. rasterising, vectorising, contour extraction, image processing)

  • dea_tools.temporal: Temporal analysis tools (e.g. phenology, temporal statistics, multi-dimensional regression)

Classification and segmentation

  • dea_tools.classification.py: Machine learning classification (e.g. training and applying machine learning models on satellite data)

  • dea_tools.segmentation.py: Image segmentation tools (e.g. applying image segmentation with RSGISLIB)

Parallel processing

  • dea_tools.dask: Parallel processing with Dask (e.g. creating Dask clusters for scalable analysis)

Domain-specific analysis

  • dea_tools.land_cover: Functions for plotting Digital Earth Australia Land Cover data.

  • dea_tools.coastal: Coastal and intertidal analysis tools (e.g. tidal tagging, coastal change timeseries)

  • dea_tools.bom: Loading Bureau of Meteorology water data service data (e.g. gauge data, discharge data)

  • dea_tools.climate: Retrieving and manipulating gridded climate data (e.g. ERA5)

  • dea_tools.waterbodies: Loading and processing DEA Waterbodies data (e.g. finding and loading waterbody timeseries data)

Installation

With conda

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

Install dea-tools

Install the package from the source on any system with pip:

pip install dea-tools

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 the dea-notebooks repository:

import sys
sys.path.insert(1, '../Tools/')
import dea_tools.datahandling  # or some other submodule

You can also pip install the module directly from the local Tools directory. To do this on the DEA Sandbox, run pip from the terminal:

pip install -e Tools/

Importing functions in Python

To use functions from dea-tools, import them using:

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

Building and Releasing

This section is only relevant to you if you are a developer of this package.

Building and releasing dea-tools requires that the package is built in-place. Either build with an editable pip installation or with pip>=21.2 and --use-feature=in-tree-build. Building will generate a file, dea_tools/__version__.py, that is dynamic on release. It should not be committed. setup.py will detect if __version__.py exists and change its behaviour accordingly.

Build instructions:

cd Tools
rm dea_tools/__version__.py  # if necessary
pip install . --use-feature=in-tree-build
python -m build

Release files for dea-tools 0.2.8.dev100

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dea-tools 0.2.8.dev100
File Size Uploaded
dea-tools-0.2.8.dev100.tar.gz 133.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for dea-tools 0.2.8.dev100
File Interpreter ABI Platform
dea_tools-0.2.8.dev100-py3-none-any.whl Python 3 none any Details

Total release size: 277.6 kB

Release files / dea-tools-0.2.8.dev100.tar.gz

Download URL dea-tools-0.2.8.dev100.tar.gz
Size 133.9 kB
Tags Source
SHA-256 checksum
How to use checksums
72e582a92ce98c12d8689709a08782286a53c082eef1994d6cb5697e5506b2d9
BLAKE2b-256 checksum
How to use checksums
e0bd05f9256ef03478481720448f9f11faef49e3cdd8eb272a967363682d7043
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

Release files / dea_tools-0.2.8.dev100-py3-none-any.whl

Download URL dea_tools-0.2.8.dev100-py3-none-any.whl
Size 143.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
38191679b2b6dbd533921d83617746948f505a9f0da59b03933c255070042903
BLAKE2b-256 checksum
How to use checksums
a12f02740f5c9757d2ff65a937f5a2d4b4413e230e3cc39dbb5d3e5489a82b6e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

Release history Release notifications | RSS feed

0.4.10

2 release files

0.4.9

2 release files

0.4.8

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.8

2 release files

This release

0.2.8.dev100 This release

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page