eo-tides 0.6.4.dev4__tar.gz → 0.6.5__tar.gz

eo_tides-0.6.5/.github/dependabot.yml

@@ -0,0 +1,15 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "uv" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+    groups:
+      python-deps:
+        patterns:
+          - "*"

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5}/.gitignore

@@ -1,8 +1,14 @@
-# Ignore project-specific directories
+# Ignore project-specific directories and files
+
 tests/data/tide_models
 tests/data/tide_models_clipped
 tests/data/tide_models_synthetic
+tests/data/tide_models_synthetic_aus
+tests/data/tide_models_synthetic_hawaii
+tests/data/tide_models_synthetic_pacific
+tests/data/tide_models_synthetic_uk
 docs/source
+docs/notebooks/intertidal_map.tif
 
 # From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
 

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eo-tides
-Version: 0.6.4.dev4
+Version: 0.6.5
 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,7 +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]!=2025.3.0,>=2023.1.0
+Requires-Dist: dask[complete]<2025.3.0,>=2023.1.0
 Requires-Dist: geopandas>=0.10.0
 Requires-Dist: matplotlib>=3.8.0
 Requires-Dist: numpy>=1.26.0
@@ -32,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.5,>=2.2.2
 Requires-Dist: scikit-learn>=1.4.0
 Requires-Dist: scipy>=1.14.1
 Requires-Dist: shapely>=2.0.6
@@ -116,6 +116,11 @@ In addition, please consider also citing the underlying [`pyTMD` Python package]
 Sutterley, T. C., Alley, K., Brunt, K., Howard, S., Padman, L., Siegfried, M. (2017) pyTMD: Python-based tidal prediction software. 10.5281/zenodo.5555395
 ```
 
+## Contributing
+
+We welcome contributions to `eo-tides`, both through posting issues (e.g. bug reports or feature suggestions), or directly via pull requests (e.g. bug fixes and new features).
+Read the [Contributing guide](https://github.com/GeoscienceAustralia/eo-tides/blob/main/CONTRIBUTING.md) for details about how you can get involved.
+
 ## Acknowledgements
 
 For a full list of acknowledgements, refer to [Citations and Credits](https://geoscienceaustralia.github.io/eo-tides/credits/).

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5}/README.md

@@ -67,6 +67,11 @@ In addition, please consider also citing the underlying [`pyTMD` Python package]
 Sutterley, T. C., Alley, K., Brunt, K., Howard, S., Padman, L., Siegfried, M. (2017) pyTMD: Python-based tidal prediction software. 10.5281/zenodo.5555395
 ```
 
+## Contributing
+
+We welcome contributions to `eo-tides`, both through posting issues (e.g. bug reports or feature suggestions), or directly via pull requests (e.g. bug fixes and new features).
+Read the [Contributing guide](https://github.com/GeoscienceAustralia/eo-tides/blob/main/CONTRIBUTING.md) for details about how you can get involved.
+
 ## Acknowledgements
 
 For a full list of acknowledgements, refer to [Citations and Credits](https://geoscienceaustralia.github.io/eo-tides/credits/).

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5}/docs/changelog.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v0.6.5
+
+### New features
+
+- Support for `pyTMD` versions 2.2.3 and 2.2.4
+
+## v0.6.4
+
+### New features
+
+- Updated installation documentation to improve reproducibility
+
+### Bug fixes
+
+- Temporarily pinned Dask to avoid `odc-geo` and `odc-stac` errors
+
 ## v0.6.3
 
 ### New features

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5}/docs/index.md

@@ -53,6 +53,11 @@ In addition, please consider also citing the underlying [`pyTMD` Python package]
 Sutterley, T. C., Alley, K., Brunt, K., Howard, S., Padman, L., Siegfried, M. (2017) pyTMD: Python-based tidal prediction software. 10.5281/zenodo.5555395
 ```
 
+## Contributing
+
+We welcome contributions to `eo-tides`, both through posting issues (e.g. bug reports or feature suggestions), or directly via pull requests (e.g. bug fixes and new features).
+Read the [Contributing guide](https://github.com/GeoscienceAustralia/eo-tides/blob/main/CONTRIBUTING.md) for details about how you can get involved.
+
 ## Next steps
 
 To get started, first follow the [guide to installing `eo-tides`](install.md), and then [set up one or multiple global ocean tide models](setup.md).

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5}/docs/install.md

@@ -18,40 +18,54 @@ It is compatible with the following Python versions:
 
 === "Installing with `pip`"
 
-    Install `eo-tides` with essential package dependencies only:
+    Install `eo-tides`:
     ```console
-    python3 -m pip install eo-tides
+    python3 -m pip install eo-tides[notebooks]
     ```
 
-    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:
+    The code above will also install [additional package dependencies](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml#L62-L69) required for running [Jupyter Notebook code examples](notebooks/Model_tides.ipynb) (including `odc-stac` and `pystac-client` for loading satellite data).
+
+    To install `eo-tides` with only essential package dependencies:
 
     ```console
-    python3 -m pip install eo-tides[notebooks]
+    python3 -m pip install eo-tides
     ```
 
 === "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:
+    Create a new virtual environment with your chosen version of Python:
     ```console
-    uv venv
+    uv venv --python 3.13
     ```
 
     Activate your virtual environment:
+    === "Linux and macOS"
+        ```console
+        source .venv/bin/activate
+        ```
+    === "Windows"
+        ```console
+        .venv\Scripts\activate
+        ```
+
+    Install `eo-tides` into your virtual environment:
+
     ```console
-    source .venv/bin/activate
+    uv pip install eo-tides[notebooks]
     ```
 
-    Install `eo-tides` into your virtual environment, with essential package dependencies only:
+    The code above will also install [additional package dependencies](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml#L62-L69) required for running [Jupyter Notebook code examples](notebooks/Model_tides.ipynb) (including `odc-stac` and `pystac-client` for loading satellite data).
+
+    To install `eo-tides` with only essential package dependencies:
     ```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:
-
+    You are now ready to run code using `eo-tides`! For example, you could launch your virtual environment with JupyterLab to run the [example Jupyter Notebooks](notebooks/Model_tides.ipynb):
     ```console
-    uv pip install eo-tides[notebooks]
+    uv run --with jupyter jupyter lab
     ```
 
 ## Unstable development pre-releases
@@ -62,33 +76,38 @@ Unstable development pre-releases of `eo-tides` are also available:
 
 === "Installing with `pip`"
 
-    Install an example `eo-tides` pre-release (see [full list here](https://pypi.org/project/eo-tides/#history)):
+    Install an example `eo-tides` pre-release (see [full list here](https://pypi.org/project/eo-tides/#history)), including additional `notebooks` dependencies:
     ```console
-    python3 -m pip install eo-tides==0.6.3.dev5
+    python3 -m pip install eo-tides[notebooks]==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:
+    Create a new virtual environment with your chosen version of Python:
     ```console
-    uv venv
+    uv venv --python 3.13
     ```
 
     Activate your virtual environment:
+    === "Linux and macOS"
+        ```console
+        source .venv/bin/activate
+        ```
+    === "Windows"
+        ```console
+        .venv\Scripts\activate
+        ```
+
+    Install an example `eo-tides` pre-release (see [full list here](https://pypi.org/project/eo-tides/#history)), including additional `notebooks` dependencies:
     ```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
+    uv pip install eo-tides[notebooks]==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.
+    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](#stable-version) instead.
 
 ### Advanced: Developing locally