eo-tides 0.6.2.dev10__tar.gz → 0.6.3__tar.gz

{eo_tides-0.6.2.dev10 → eo_tides-0.6.3}/.gitignore

@@ -1,6 +1,7 @@
 # Ignore project-specific directories
 tests/data/tide_models
 tests/data/tide_models_clipped
+tests/data/tide_models_synthetic
 docs/source
 
 # From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore

{eo_tides-0.6.2.dev10 → eo_tides-0.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eo-tides
-Version: 0.6.2.dev10
+Version: 0.6.3
 Summary: Tide modelling tools for large-scale satellite earth observation analysis
 Project-URL: Homepage, https://GeoscienceAustralia.github.io/eo-tides/
 Project-URL: Repository, https://github.com/GeoscienceAustralia/eo-tides
@@ -23,6 +23,7 @@ Classifier: Topic :: Scientific/Engineering :: Oceanography
 Classifier: Topic :: Scientific/Engineering :: Visualization
 Requires-Python: <4.0,>=3.10
 Requires-Dist: colorama>=0.4.3
+Requires-Dist: dask[complete]>=2023.1.0
 Requires-Dist: geopandas>=0.10.0
 Requires-Dist: matplotlib>=3.8.0
 Requires-Dist: numpy>=1.26.0
@@ -31,7 +32,7 @@ Requires-Dist: pandas>=2.2.0
 Requires-Dist: psutil>=5.8.0
 Requires-Dist: pyogrio>=0.10.0
 Requires-Dist: pyproj>=3.7.0
-Requires-Dist: pytmd>=2.2.2
+Requires-Dist: pytmd==2.2.2
 Requires-Dist: scikit-learn>=1.4.0
 Requires-Dist: scipy>=1.14.1
 Requires-Dist: shapely>=2.0.6

{eo_tides-0.6.2.dev10 → eo_tides-0.6.3}/docs/changelog.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v0.6.3
+
+### New features
+
+- Major updates to installation and setup documentation, to provide additional context about tide modelling data and installing `eo-tides` using both `pip` and `uv`
+
+### Bug fixes
+
+- Fixed bug where ensemble tide modelling used excessive memory, by ensuring dtype of ensemble modelled tides matches dtype of input modelled tides ([#70](https://github.com/GeoscienceAustralia/eo-tides/pull/70))
+- Added missing `dask` dependency to requirements ([#68](https://github.com/GeoscienceAustralia/eo-tides/pull/68))
+
 ## v0.6.2
 
 ### New features

eo_tides-0.6.3/docs/install.md

@@ -0,0 +1,136 @@
+# Installing `eo-tides`
+
+## Stable version
+
+The latest stable release of `eo-tides` is:
+
+[![PyPI](https://img.shields.io/pypi/v/eo-tides)](https://pypi.org/project/eo-tides/)
+
+It is compatible with the following Python versions:
+
+[![Python Version from PEP 621 TOML](https://img.shields.io/pypi/pyversions/eo-tides)](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml)
+
+`eo-tides` can be installed into your Python environment using either `pip` (the standard Python package manager), or `uv` ([a fast Python package manager](https://docs.astral.sh/uv/) written in Rust).
+
+!!! tip
+
+    We recommend installing with `uv` as this makes it easy to set up an isolated environment containing compatible Python packages.
+
+=== "Installing with `pip`"
+
+    Install `eo-tides` with essential package dependencies only:
+    ```console
+    python3 -m pip install eo-tides
+    ```
+
+    To install [additional package dependencies](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml#L62-L69) required for running the included Jupyter Notebook examples (including `odc-stac` and `pystac-client` for loading freely available satellite data), run:
+
+    ```console
+    python3 -m pip install eo-tides[notebooks]
+    ```
+
+=== "Installing with `uv`"
+
+    First, [install `uv` using the method of your choice](https://docs.astral.sh/uv/getting-started/installation/). Then:
+
+    Create a new virtual environment:
+    ```console
+    uv venv
+    ```
+
+    Activate your virtual environment:
+    ```console
+    source .venv/bin/activate
+    ```
+
+    Install `eo-tides` into your virtual environment, with essential package dependencies only:
+    ```console
+    uv pip install eo-tides
+    ```
+
+    To install [additional package dependencies](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml#L62-L69) required for running the included Jupyter Notebook examples (including `odc-stac` and `pystac-client` for loading freely available satellite data), run:
+
+    ```console
+    uv pip install eo-tides[notebooks]
+    ```
+
+## Unstable development pre-releases
+
+Unstable development pre-releases of `eo-tides` are also available:
+
+[![PyPI](https://img.shields.io/badge/pypi-releases-f48041)](https://pypi.org/project/eo-tides/#history)
+
+=== "Installing with `pip`"
+
+    Install an example `eo-tides` pre-release (see [full list here](https://pypi.org/project/eo-tides/#history)):
+    ```console
+    python3 -m pip install eo-tides==0.6.3.dev5
+    ```
+
+=== "Installing with `uv`"
+
+    First, [install `uv` using the method of your choice](https://docs.astral.sh/uv/getting-started/installation/). Then:
+
+    Create a new virtual environment:
+    ```console
+    uv venv
+    ```
+
+    Activate your virtual environment:
+    ```console
+    source .venv/bin/activate
+    ```
+
+    Install an example `eo-tides` pre-release (see [full list here](https://pypi.org/project/eo-tides/#history)):
+    ```console
+    uv pip install eo-tides==0.6.3.dev5
+    ```
+
+!!! important
+
+    Unstable development pre-releases may contain bugs and untested new features. Unless you need access to a specific unpublished feature, we recommend installing the latest stable version instead.
+
+### Advanced: Developing locally
+
+To work on `eo-tides` locally, we recommend using `uv`.
+
+First, [install `uv` using the method of your choice](https://docs.astral.sh/uv/getting-started/installation/).
+
+Clone the `eo-tides` repository:
+
+```console
+git clone https://github.com/GeoscienceAustralia/eo-tides
+cd eo-tides/
+```
+
+Use `uv sync` to populate an environment with package dependencies from the `eo-tides` [lockfile](https://github.com/GeoscienceAustralia/eo-tides/blob/main/uv.lock):
+
+```console
+uv sync --all-extras
+```
+
+Set up pre-commit hooks:
+
+```console
+uv run pre-commit install
+```
+
+We provide a [pre-prepared Makefile](https://github.com/GeoscienceAustralia/eo-tides/blob/main/Makefile) that you can use to easily run common tasks:
+
+```console
+# Run code quality checks
+make check
+
+# Run pytest tests
+make test
+
+# Run Jupyter notebook tests
+make test-notebooks
+
+# Build and preview documentation
+make docs
+```
+
+## 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.

{eo_tides-0.6.2.dev10 → eo_tides-0.6.3}/docs/migration.md

@@ -34,7 +34,7 @@ Renamed for consistency with `model_tides` and `pixel_tides`.
 
     Update references to `tidal_tag` to `tag_tides`.
 
-## `ds` param renamed to `data`, now accepts `GeoBox`
+### `ds` param renamed to `data`, now accepts `GeoBox`
 
 The `ds` param in all satellite data functions (`tag_tides`, `pixel_tides`, `tide_stats`, `pixel_tides`) has been updated to accept either `xarray.Dataset`, `xarray.DataArray` or a `odc.geo.geobox.GeoBox`. To account for this change, the `ds` param has been renamed to a more generic name `data`.
 
@@ -49,7 +49,7 @@ The `ds` param in all satellite data functions (`tag_tides`, `pixel_tides`, `tid
     tag_tides(data=your_data)
     ```
 
-## `times` param renamed to `time`, accepts any format supported by `pandas.to_datetime()`
+### `times` param renamed to `time`, accepts any format supported by `pandas.to_datetime()`
 
 The `times` parameter has been renamed to `time`, and updated to more flexibly accept any time format that can be converted by `pandas.to_datetime()`; e.g. `np.ndarray[datetime64]`, `pd.DatetimeIndex`, `pd.Timestamp`, `datetime.datetime` and strings (e.g. `"2020-01-01 23:00"`). For example: `time=pd.date_range(start="2000", end="2001", freq="5h")`.