Skip to content

Commit 41ae77b

Browse files
authored
Add installation instructions
1 parent 6cebf65 commit 41ae77b

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,27 @@ The DEA Intertidal product suite maps the changing elevation, exposure and tidal
2525

2626
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.
2727

28+
## Installation
29+
30+
You can install `dea-intertidal` from PyPI with `pip` (https://pypi.org/project/dea-intertidal/).
31+
By default `dea-intertidal` will be installed with minimal dependencies which excludes `datacube`:
32+
33+
```console
34+
pip install dea-intertidal
35+
```
36+
37+
To install with additional `datacube` dependencies:
38+
39+
```console
40+
pip install dea-intertidal[datacube]
41+
```
42+
43+
Functions can then be imported in Python:
44+
45+
```python
46+
from intertidal.elevation import elevation
47+
```
48+
2849
## Repository structure
2950

3051
The DEA Intertidal Github repository contains the following important sections:
@@ -36,4 +57,4 @@ The DEA Intertidal Github repository contains the following important sections:
3657
* `notebooks/Intertidal_elevation_stac.ipynb`: For running DEA Intertidal Elevation on global satellite data loaded from Microsoft Planetary Computer using STAC metadata
3758
* `data`: Contains required `raw` input data files and output `interim` and `processed` outputs
3859
* `metadata`: Open Data Cube (ODC) metadata required for indexing DEA Intertidal into an ODC datacube
39-
* `tests`: Unit and integration tests, including automatically generated validation test results
60+
* `tests`: Unit and integration tests, including automatically generated validation test results

0 commit comments

Comments
 (0)