eo-tides 0.6.4.dev4__tar.gz → 0.6.4.dev5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eo-tides
-Version: 0.6.4.dev4
+Version: 0.6.4.dev5
 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

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

@@ -1,5 +1,15 @@
 # Changelog
 
+## 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.4.dev5}/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
 

{eo_tides-0.6.4.dev4 → eo_tides-0.6.4.dev5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "eo-tides"
-version = "0.6.4.dev4"
+version = "0.6.4.dev5"
 description = "Tide modelling tools for large-scale satellite earth observation analysis"
 authors = [
     { name = "Robbi Bishop-Taylor" },

{eo_tides-0.6.4.dev4 → eo_tides-0.6.4.dev5}/uv.lock

@@ -701,7 +701,7 @@ wheels = [
 
 [[package]]
 name = "eo-tides"
-version = "0.6.3"
+version = "0.6.4"
 source = { editable = "." }
 dependencies = [
     { name = "colorama" },
@@ -1001,7 +1001,7 @@ name = "importlib-metadata"
 version = "8.6.1"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
-    { name = "zipp" },
+    { name = "zipp", marker = "python_full_version < '3.12'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/33/08/c1395a292bb23fd03bdf572a1357c5a733d3eecbab877641ceacab23db6e/importlib_metadata-8.6.1.tar.gz", hash = "sha256:310b41d755445d74569f993ccfc22838295d9fe005425094fad953d7f15c8580", size = 55767 }
 wheels = [