Minor doc updates

GeoscienceAustralia · Oct 30, 2024 · 5b0d1fd · 5b0d1fd
1 parent a358aef
commit 5b0d1fd
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 [![Release](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides)](https://pypi.org/project/eo-tides/)
 [![Build status](https://img.shields.io/github/actions/workflow/status/GeoscienceAustralia/eo-tides/main.yml?branch=main)](https://github.com/GeoscienceAustralia/eo-tides/actions/workflows/main.yml?query=branch%3Amain)
-![Python Version from PEP 621 TOML](https://img.shields.io/pypi/pyversions/eo-tides)
+[![Python Version from PEP 621 TOML](https://img.shields.io/pypi/pyversions/eo-tides)](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml)
 [![codecov](https://codecov.io/gh/GeoscienceAustralia/eo-tides/branch/main/graph/badge.svg)](https://codecov.io/gh/GeoscienceAustralia/eo-tides)
 [![License](https://img.shields.io/github/license/GeoscienceAustralia/eo-tides)](https://img.shields.io/github/license/GeoscienceAustralia/eo-tides)
 
@@ -25,7 +25,7 @@ These tools can be applied to petabytes of freely available satellite data (e.g.
 ## Highlights
 
 - 🌊 Model tide heights and phases (e.g. high, low, ebb, flow) from multiple global ocean tide models in parallel, and return a `pandas.DataFrame` for further analysis
-- 🛰️ "Tag" satellite data with tide height and stage based on the exact moment of image acquisition
+- 🛰️ "Tag" satellite data with tide heights based on the exact moment of image acquisition
 - 🌐 Model tides for every individual satellite pixel through time, producing three-dimensional "tide height" `xarray`-format datacubes that can be integrated with satellite data
 - 📈 Calculate statistics describing local tide dynamics, as well as biases caused by interactions between tidal processes and satellite orbits
 - 🛠️ Validate modelled tides using measured sea levels from coastal tide gauges (e.g. [GESLA Global Extreme Sea Level Analysis](https://gesla.org/))

diff --git a/docs/index.md b/docs/index.md
@@ -3,7 +3,7 @@
 
 # `eo-tides`: Tide modelling tools for large-scale satellite Earth observation analysis
 
-[![Release](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides)](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides)
+[![Release](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides)](https://pypi.org/project/eo-tides/)
 [![Build status](https://img.shields.io/github/actions/workflow/status/GeoscienceAustralia/eo-tides/main.yml?branch=main)](https://github.com/GeoscienceAustralia/eo-tides/actions/workflows/main.yml?query=branch%3Amain)
 [![Commit activity](https://img.shields.io/github/commit-activity/m/GeoscienceAustralia/eo-tides)](https://img.shields.io/github/commit-activity/m/GeoscienceAustralia/eo-tides)
 [![License](https://img.shields.io/github/license/GeoscienceAustralia/eo-tides)](https://img.shields.io/github/license/GeoscienceAustralia/eo-tides)

diff --git a/docs/install.md b/docs/install.md
@@ -1,25 +1,28 @@
 # Installing `eo-tides`
 
+[![Release](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides)](https://pypi.org/project/eo-tides/)
+[![Python Version from PEP 621 TOML](https://img.shields.io/pypi/pyversions/eo-tides)](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml)
+
 ## Stable version
 
 The [latest stable release](https://github.com/GeoscienceAustralia/eo-tides/releases) of `eo-tides` can be installed into your Python environment from [PyPI](https://pypi.org/project/eo-tides/) using `pip`:
 
 ```console
-pip install eo-tides
+python3 -m pip install eo-tides
 ```
 
 By default, only essential package dependencies are installed. To install all packages required for running the included Jupyter Notebook examples (including `odc-stac` and `pystac-client` for loading freely available satellite data), run:
 
 ```console
-pip install eo-tides[notebooks]
+python3 -m pip install eo-tides[notebooks]
 ```
 
 ## Unstable development version
 
 To install the latest unstable development version of `eo-tides` directly from Github, run:
 
 ```console
-pip install git+https://github.com/GeoscienceAustralia/eo-tides.git
+python3 -m pip install git+https://github.com/GeoscienceAustralia/eo-tides.git
 ```
 
 ### Cloning locally
@@ -34,7 +37,7 @@ Navigate to the project directory and install in editable mode from your local c
 
 ```console
 cd eo_tides
-pip install -e .
+python3 -m pip install -e .
 ```
 
 !!! important