Metadata-Version: 2.4
Name: dea-intertidal
Version: 2.3.1.dev1
Summary: Generating intertidal elevation, extents and exposure from satellite Earth Observation data
Project-URL: Homepage, https://github.com/GeoscienceAustralia/eo-tides
Project-URL: Repository, https://github.com/GeoscienceAustralia/eo-tides
Author: Robbi Bishop-Taylor, Claire Phillips, Vanessa Newey, Stephen Sagar
Author-email: Robbi.BishopTaylor@ga.gov.au
License-File: LICENSE
Keywords: coastal,coastal analysis,earth observation,exposure,intertidal,oceanography,remote sensing,satellite data,tide modelling
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
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: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Image Processing
Classifier: Topic :: Scientific/Engineering :: Oceanography
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: <4.0,>=3.10
Requires-Dist: bottleneck>=1.4.2
Requires-Dist: click>=8.1.7
Requires-Dist: dea-tools==0.4.6.dev3
Requires-Dist: eo-tides>=0.8.3
Requires-Dist: folium>=0.16.0
Requires-Dist: geopandas>=0.14.4
Requires-Dist: matplotlib>=3.9.2
Requires-Dist: numpy>=1.26.4
Requires-Dist: odc-algo>=1.1.1
Requires-Dist: odc-geo>=0.4.8
Requires-Dist: pandas>=2.2.3
Requires-Dist: pyogrio>=0.10.0
Requires-Dist: pytz>=2024.1
Requires-Dist: rasterio>=1.4.1
Requires-Dist: s3fs>=2024.9.0
Requires-Dist: scikit-image>=0.24.0
Requires-Dist: scipy>=1.14.1
Requires-Dist: seaborn>=0.13.2
Requires-Dist: sunriset>=1.0
Requires-Dist: tqdm>=4.66.5
Requires-Dist: xarray-spatial>=0.4.0
Requires-Dist: xarray>=2024.9.0
Provides-Extra: datacube
Requires-Dist: datacube[performance,postgres,s3]>=1.8.19; extra == 'datacube'
Requires-Dist: eodatasets3>=0.30.9; extra == 'datacube'
Requires-Dist: odc-ui>=0.2.1; extra == 'datacube'
Description-Content-Type: text/markdown

![Digital Earth Australia Intertidal](https://raw.githubusercontent.com/GeoscienceAustralia/dea-notebooks/refs/heads/develop/Supplementary_data/dea_logo_wide.jpg)

# Digital Earth Australia Intertidal

[![PyPI](https://img.shields.io/pypi/v/dea-intertidal)](https://pypi.org/project/dea-intertidal/)
[![DOI](https://img.shields.io/badge/DOI-10.1016/j.ecss.2019.03.006-0e7fbf.svg)](https://doi.org/10.1016/j.ecss.2019.03.006)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![codecov](https://codecov.io/gh/GeoscienceAustralia/dea-intertidal/branch/main/graph/badge.svg?token=7HXSIPGT5I)](https://codecov.io/gh/GeoscienceAustralia/dea-intertidal)
[![example workflow](https://github.com/GeoscienceAustralia/dea-intertidal/actions/workflows/dea-intertidal-image.yml/badge.svg)](https://github.com/GeoscienceAustralia/dea-intertidal/actions/workflows/dea-intertidal-image.yml)

**License:** The code in this repository is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). Digital Earth Australia data is licensed under the [Creative Commons by Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/).

**Contact:** For assistance with any of the Python code or Jupyter Notebooks in this repository, please post a [Github issue](https://github.com/GeoscienceAustralia/dea-intertidal/issues). For questions or more information about DEA Intertidal, email earth.observation@ga.gov.au.

**To cite:** 
> Bishop-Taylor, R., Sagar, S., Lymburner, L., Beaman, R.L., 2019. Between the tides: modelling the elevation of Australia's exposed intertidal zone at continental scale. Estuarine, Coastal and Shelf Science. https://doi.org/10.1016/j.ecss.2019.03.006

> Sagar, S., Phillips, C., Bala, B., Roberts, D., Lymburner, L., 2018. Generating continental scale pixel-based surface reflectance composites in coastal regions with the use of a multi-resolution tidal model. Remote Sensing. 10, 480. https://doi.org/10.3390/rs10030480

> Sagar, S., Roberts, D., Bala, B., Lymburner, L., 2017. Extracting the intertidal extent and topography of the Australian coastline from a 28 year time series of Landsat observations. Remote Sensing of Environment 195, 153-169. https://doi.org/10.1016/j.rse.2017.04.009

---

The DEA Intertidal product suite maps the changing elevation, exposure and tidal characteristics of Australia's exposed intertidal zone, the complex zone that defines the interface between land and sea. It is the next generation of DEA's intertidal products that have been used across government and industry to help better characterise and understand this complex zone that defines the interface between land and sea.

Incorporating both Sentinel-2 and Landsat data, the product suite provides an annual 10 m resolution elevation product for the intertidal zone, enabling users to better monitor and understand some of the most dynamic regions of Australia's coastlines. Utilising an improved tidal modelling capability, the product suite includes a continental scale mapping of intertidal exposure over time, enabling scientists and managers to integrate the data into ecological and migratory species applications and modelling.

## Installation

You can install `dea-intertidal` from PyPI with `pip` (https://pypi.org/project/dea-intertidal/). 
By default `dea-intertidal` will be installed with minimal dependencies which excludes `datacube`:

```console
pip install dea-intertidal
```

To install with additional `datacube` dependencies:

```console
pip install dea-intertidal[datacube]
```

Functions can then be imported in Python:

```python
from intertidal.elevation import elevation
```

## Repository structure

The DEA Intertidal Github repository contains the following important sections:
* `intertidal`: The DEA Intertidal Python package, containing modules required for loading data, tide modelling, intertidal elevation, and exposure calculations
* `notebooks`: Jupyter Notebooks providing workflows for generating key DEA Intertidal outputs. Importantly:
  * `notebooks/Intertidal_CLI.ipynb`: For running the entire DEA Intertidal workflow via the Command Line Interface
  * `notebooks/Intertidal_workflow.ipynb`: For running the entire DEA Intertidal workflow via interactive notebook cells
  * `notebooks/Intertidal_elevation.ipynb`: For customising and running the DEA Intertidal Elevation portion of the workflow
  * `notebooks/Intertidal_elevation_stac.ipynb`: For running DEA Intertidal Elevation on global satellite data loaded from Microsoft Planetary Computer using STAC metadata
* `data`: Contains required `raw` input data files and output `interim` and `processed` outputs
* `metadata`: Open Data Cube (ODC) metadata required for indexing DEA Intertidal into an ODC datacube
* `tests`: Unit and integration tests, including automatically generated validation test results
