eo-tides 0.6.3.dev3__tar.gz → 0.6.3.dev4__tar.gz

{eo_tides-0.6.3.dev3 → eo_tides-0.6.3.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eo-tides
-Version: 0.6.3.dev3
+Version: 0.6.3.dev4
 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.3.dev3 → eo_tides-0.6.3.dev4}/docs/setup.md

@@ -27,9 +27,17 @@ As a first step, we need to create a directory that will contain our tide model
 This directory will be accessed by all `eo-tides` functions.
 For example, we might want to store our tide model data in a directory called `tide_models/`:
 
-```
-tide_models/
-```
+=== "Relative path"
+
+    <pre><code>tide_models/</code></pre>
+
+=== "Full path (Windows)"
+
+    <pre><code><span style="color: #bbb;">D:/projects/</span>tide_models/</code></pre>
+
+=== "Full path (Linux)"
+
+    <pre><code><span style="color: #bbb;">/home/user/projects/</span>tide_models/</code></pre>
 
 !!! tip
 
@@ -270,29 +278,71 @@ Follow the guides below for some of the most commonly used global ocean tide mod
 
 ### 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.
+All tide modelling functions from `eo-tides` provide a `directory` parameter that can be used to specify **either the relative or full/absolute path** to your tide model directory.
+
 For example, using the [`eo_tides.model.model_tides`](api.md#eo_tides.model.model_tides) function:
 
-```py hl_lines="8"
-import pandas as pd
-from eo_tides.model import model_tides
+=== "Relative path"
 
-model_tides(
-        x=155,
-        y=-35,
-        time=pd.date_range("2022-01-01", "2022-01-04", freq="1D"),
-        directory="tide_models/"
-)
-```
+    ```py hl_lines="8"
+    import pandas as pd
+    from eo_tides.model import model_tides
+
+    model_tides(
+            x=155,
+            y=-35,
+            time=pd.date_range("2022-01-01", "2022-01-04", freq="1D"),
+            directory="tide_models/"  # relative path to `tide_models` directory
+    )
+    ```
+
+=== "Full path (Windows)"
+
+    ```py hl_lines="8"
+    import pandas as pd
+    from eo_tides.model import model_tides
+
+    model_tides(
+            x=155,
+            y=-35,
+            time=pd.date_range("2022-01-01", "2022-01-04", freq="1D"),
+            directory="D:/projects/tide_models/"  # full path to `tide_models`
+    )
+    ```
+
+=== "Full path (Linux)"
+
+    ```py hl_lines="8"
+    import pandas as pd
+    from eo_tides.model import model_tides
+
+    model_tides(
+            x=155,
+            y=-35,
+            time=pd.date_range("2022-01-01", "2022-01-04", freq="1D"),
+            directory="/home/user/projects/tide_models/"  # full path to `tide_models`
+    )
+    ```
 
 ### 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:
+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.
 
-```py hl_lines="2"
-import os
-os.environ["EO_TIDES_TIDE_MODELS"] = "tide_models/"
-```
+This should be set to **a full/absolute path** to ensure it can be accessed from anywhere you run `eo-tides` code:
+
+=== "Full path (Windows)"
+
+    ```py hl_lines="2"
+    import os
+    os.environ["EO_TIDES_TIDE_MODELS"] = "D:/projects/tide_models/"
+    ```
+
+=== "Full path (Linux)"
+
+    ```py hl_lines="2"
+    import os
+    os.environ["EO_TIDES_TIDE_MODELS"] = "/home/user/projects/tide_models/"
+    ```
 
 All tide modelling functions from `eo-tides` will check for the presence of the `EO_TIDES_TIDE_MODELS` environment variable, and use it as the default `directory` path if available (the `EO_TIDES_TIDE_MODELS` environment variable will be overuled by the `directory` parameter if provided).
 
@@ -369,7 +419,10 @@ Outputs exported to tide_models_clipped/
 
 You can now pass this new clipped tide model directory to all future `eo_tides` function calls for improved tide modelling performance, e.g.:
 
-```py hl_lines="5"
+```py hl_lines="8"
+import pandas as pd
+from eo_tides.model import model_tides
+
 model_tides(
         x=155,
         y=-35,

{eo_tides-0.6.3.dev3 → eo_tides-0.6.3.dev4}/eo_tides/model.py

@@ -124,7 +124,11 @@ def _model_tides(
         if crop == "auto":
             warnings.warn(
                 "On-the-fly cropping is not compatible with the provided "
-                "clipped model files; running with `crop=False`."
+                "model files; running with `crop=False`. This will not "
+                "affect your results but may lead to a minor slowdown. "
+                "This can occur when analysing clipped model files restricted "
+                "to the western hemisphere. To suppress this warning, manually "
+                "set `crop=False`."
             )
 
             # Read tidal constants and interpolate to grid points

{eo_tides-0.6.3.dev3 → eo_tides-0.6.3.dev4}/mkdocs.yml

@@ -117,6 +117,8 @@ markdown_extensions:
       generic: true
   - admonition
   - pymdownx.details
+  - pymdownx.tabbed:
+      alternate_style: true
   - pymdownx.superfences
   - pymdownx.highlight:
       anchor_linenums: true

{eo_tides-0.6.3.dev3 → eo_tides-0.6.3.dev4}/pyproject.toml

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