This release is a pre-release and may not be stable for production use.
dea-tools
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 cubeenvInstall dea-tools
You can install dea-tools with pip in a Python environment where GDAL and pyproj are already installed.
pip install dea-toolsTo 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 submoduleYou 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 rgbCiting 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 build5 maintainers
Release files for dea-tools 0.2.8.dev126
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dea-tools-0.2.8.dev126.tar.gz | 140.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dea_tools-0.2.8.dev126-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 290.7 kB
Release files / dea-tools-0.2.8.dev126.tar.gz
| Download URL | dea-tools-0.2.8.dev126.tar.gz |
|---|---|
| Size | 140.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6ceb963a3c981614fbc4d6a8d4effe89193f04d8885c995c92c50476a604f6b3
|
|
BLAKE2b-256 checksum How to use checksums |
560cee0c229b45eaa5355986424c69aa6ad9c1396fc9acf47861e157bd2e8c58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Release files / dea_tools-0.2.8.dev126-py3-none-any.whl
| Download URL | dea_tools-0.2.8.dev126-py3-none-any.whl |
|---|---|
| Size | 150.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3249e685d13a94133cec9ac1578609aea3415f52c805a6624af7add68d36aca8
|
|
BLAKE2b-256 checksum How to use checksums |
d9bacb54b87c1d44cb74750a54de5909e68bd79a142d11cc64c36096c66e3b2c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
