Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation updates #30

Merged
merged 11 commits into from
Nov 19, 2024
10 changes: 5 additions & 5 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ To install the latest unstable development version of `eo-tides` directly from G
python3 -m pip install git+https://github.com/GeoscienceAustralia/eo-tides.git
```

!!! important

Unstable development versions of `eo-tides` may contain bugs and untested new features. Unless you need access to a specific unpublished feature, we recommend installing the latest stable version instead.

### Cloning locally

To clone the `eo-tides` repository locally:
Expand All @@ -36,14 +40,10 @@ git clone https://github.com/GeoscienceAustralia/eo-tides.git
Navigate to the project directory and install in editable mode from your local copy of the repository:

```console
cd eo_tides
cd eo-tides
python3 -m pip install -e .
```

!!! important

Unstable development versions of `eo-tides` may contain bugs and untested new features. Unless you need access to a specific unpublished feature, we recommend installing the latest stable version instead.

## Next steps

Once you have installed `eo-tides`, you will need to [download and set up at least one tide model](setup.md) before you can model tides.
2 changes: 1 addition & 1 deletion docs/notebooks/Model_tides.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"metadata": {},
"source": [
"## Getting started\n",
"As a first step, we need to tell `eo-tides` the location of our tide model directory (if you haven't set this up, [refer to the setup instructions here](../../setup)).\n",
"As a first step, we need to tell `eo-tides` the location of our tide model or clipped tide model directory (if you haven't set this up, [refer to the setup instructions here](../../setup)).\n",
"\n",
"We will pass this path to `eo-tides` functions using the `directory` parameter.\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/notebooks/Satellite_data.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"metadata": {},
"source": [
"## Getting started\n",
"As in the previous example, our first step is to tell `eo-tides` the location of our tide model directory (if you haven't set this up, [refer to the setup instructions here](../../setup)):"
"As in the previous example, our first step is to tell `eo-tides` the location of our tide model or clipped tide model directory (if you haven't set this up, [refer to the setup instructions here](../../setup)):"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/notebooks/Tide_statistics.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"\n",
"**This guide demonstrates how to use the [`tide_stats`](../../api/#eo_tides.stats.tide_stats) and [`pixel_stats`](../../api/#eo_tides.stats.pixel_stats) functions from [`eo_tides.stats`](../../api/#eo_tides.stats) to calculate local tide statistics and identify biases caused by interactions between tidal processes and satellite orbits.**\n",
"\n",
"Complex interactions between temporal tide dynamics and the regular mid-morning overpass timing of sun-synchronous sensors like Landsat or Sentinel-2 mean that satellites often does not observe the entire tidal cycle. \n",
"Complex interactions between temporal tide dynamics and the regular mid-morning overpass timing of sun-synchronous sensors like Landsat or Sentinel-2 mean that satellites often do not observe the entire tidal cycle. \n",
"Biases in satellite coverage of the tidal cycle can mean that tidal extremes (e.g. the lowest or highest tides at a location) may either never be captured by satellites, or be over-represented in the satellite EO record. \n",
"Local tide dynamics can cause these biases to vary greatly both through time and spatially (Figure 1), making it challenging to consistently analyse and compare coastal processes consistently - particularly for large-scale (e.g. regional or global) analyses.\n",
"\n",
Expand All @@ -33,7 +33,7 @@
"metadata": {},
"source": [
"## Getting started\n",
"As in the previous examples, our first step is to tell `eo-tides` the location of our tide model directory (if you haven't set this up, [refer to the setup instructions here](../../setup)):"
"As in the previous examples, our first step is to tell `eo-tides` the location of our tide model or clipped tide model directory (if you haven't set this up, [refer to the setup instructions here](../../setup)):"
]
},
{
Expand Down
10 changes: 7 additions & 3 deletions docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ Follow the guides below for some of the most commonly used global ocean tide mod

`eo-tides` can be pointed to the location of your [tide model directory](#setting-up-a-tide-model-directory) and your downloaded tide model data in two ways:

### Using the `directory` function parameter
### 1. Using the `directory` function parameter

All tide modelling functions from `eo-tides` provide a `directory` parameter that can be used to specify the location of your tide model directory.
For example, using the [`eo_tides.model.model_tides`](api.md#eo_tides.model.model_tides) function:
Expand All @@ -243,7 +243,7 @@ model_tides(
)
```

### Advanced: setting the `EO_TIDES_TIDE_MODELS` environmental variable
### 2. (Advanced) Setting the `EO_TIDES_TIDE_MODELS` environmental variable

For more advanced usage, you can set the path to your [tide model directory](#setting-up-a-tide-model-directory) by setting the `EO_TIDES_TIDE_MODELS` environment variable:

Expand Down Expand Up @@ -285,6 +285,10 @@ Summary:
Available models: 2/50
```

!!! tip

> If the models that you uploaded are not marked as available in this summary, check that your models were uploaded to the expected path as identified in the summary table.

## Clipping model files to improve performance

!!! important "Highly recommended"
Expand All @@ -307,7 +311,7 @@ clip_models(
)
```

When you run `clip_models`, the function will automatically identify suitable NetCDF-format models in your input directory, and clip each of them to the extent of your bounding box (specified as `(left, bottom, right, top)`).
When you run `clip_models`, the function will automatically identify suitable NetCDF-format models in your input directory, and clip each of them to the extent of your bounding box (specified as `(left, bottom, right, top)` in EPSG:4326 degree coordinates).
After each model is clipped, the result is exported to your selected output directory and verified to ensure the clipped data is suitable for tide modelling:

```text
Expand Down