eo-tides 0.0.23__py3-none-any.whl → 0.1.0__py3-none-any.whl

eo_tides/model.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 
 import os
 import pathlib
+import textwrap
 import warnings
 from concurrent.futures import ProcessPoolExecutor
 from concurrent.futures.process import BrokenProcessPool
@@ -148,16 +149,19 @@ def list_models(
 
     # Raise error or warning if no models are available
     if not available_models:
-        warning_text = (
-            f"No valid tide models are available in `{directory}`. "
-            "Are you sure you have provided the correct `directory` path, "
-            "or set the `EO_TIDES_TIDE_MODELS` environment variable "
-            "to point to the location of your tide model directory?"
-        )
+        warning_msg = textwrap.dedent(
+            f"""
+            No valid tide models are available in `{directory}`.
+            Are you sure you have provided the correct `directory` path, or set the
+            `EO_TIDES_TIDE_MODELS` environment variable to point to the location of your
+            tide model directory?
+            """
+        ).strip()
+
         if raise_error:
-            raise Exception(warning_text)
+            raise Exception(warning_msg)
         else:
-            warnings.warn(warning_text, UserWarning)
+            warnings.warn(warning_msg, UserWarning)
 
     # Return list of available and supported models
     return available_models, supported_models
@@ -286,12 +290,14 @@ def _model_tides(
 
     # Raise error if constituent files no not cover analysis extent
     except IndexError:
-        error_msg = (
-            f"The {model} tide model constituent files do not cover the requested analysis extent. "
-            "This can occur if you are using clipped model files to improve run times. "
-            "Consider using model files that cover your analysis area, or set `crop=False` "
-            "to reduce the extent of tide model constituent files that is loaded."
-        )
+        error_msg = textwrap.dedent(
+            f"""
+            The {model} tide model constituent files do not cover the requested analysis extent.
+            This can occur if you are using clipped model files to improve run times.
+            Consider using model files that cover your entire analysis area, or set `crop=False`
+            to reduce the extent of tide model constituent files that is loaded.
+            """
+        ).strip()
         raise Exception(error_msg)
 
     # Calculate complex phase in radians for Euler's
@@ -562,8 +568,8 @@ def model_tides(
     <https://pytmd.readthedocs.io/en/latest/getting_started/Getting-Started.html#directories>
 
     This function is a modification of the `pyTMD` package's
-    `compute_tidal_elevations` function. For more info:
-    <https://pytmd.readthedocs.io/en/latest/api_reference/compute_tidal_elevations.html>
+    `pyTMD.compute.tide_elevations` function. For more info:
+    <https://pytmd.readthedocs.io/en/latest/api_reference/compute.html#pyTMD.compute.tide_elevations>
 
     Parameters
     ----------

{eo_tides-0.0.23.dist-info → eo_tides-0.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eo-tides
-Version: 0.0.23
+Version: 0.1.0
 Summary: Tide modelling tools for large-scale satellite earth observation analysis
 Author-email: Robbi Bishop-Taylor <Robbi.BishopTaylor@ga.gov.au>
 Project-URL: Homepage, https://GeoscienceAustralia.github.io/eo-tides/
@@ -91,6 +91,10 @@ For instructions on how to set up these models for use in `eo-tides`, refer to [
 
 To get started with `eo-tides`, follow the [Installation](https://geoscienceaustralia.github.io/eo-tides/install/) and [Setting up tide models](https://geoscienceaustralia.github.io/eo-tides/setup/) guides.
 
+## Jupyter Notebooks code examples
+
+Interactive Jupyter Notebook usage examples and more complex coastal EO case studies can be found in the [`docs/notebooks/`](https://github.com/GeoscienceAustralia/eo-tides/tree/main/docs/notebooks) directory, or [rendered in the documentation here](https://geoscienceaustralia.github.io/eo-tides/notebooks/Model_tides/).
+
 ## Citing `eo-tides`
 
 To cite `eo-tides` in your work, please use the following citation:

eo_tides-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+eo_tides/__init__.py,sha256=TWmQNplePCcNAlua5WI_H7SShkWNk-Gd3X70EDEknSo,1557
+eo_tides/eo.py,sha256=OTFjchQWpSfgi2Q62mFBj6ckmy_1B_ExCAmex4UT4js,21616
+eo_tides/model.py,sha256=Bwc2VVhDDBJB0wuKUAdSKYfBPZG4XDfldb_BO5Wcy6Y,34517
+eo_tides/stats.py,sha256=9nfa7_obkS4tiHrQ1WTutuy2jlHtFg-cmOqP3l_Q7b8,20644
+eo_tides/utils.py,sha256=l9VXJawQzaRBYaFMsP8VBeaN5VA3rFDdzcvF7Rk04Vc,5620
+eo_tides/validation.py,sha256=JjTUqDfbR189m_6W1bpaSolQIHNTLicTHN7z9O_nr3s,11828
+eo_tides-0.1.0.dist-info/LICENSE,sha256=owxWsXViCL2J6Ks3XYhot7t4Y93nstmXAT95Zf030Cc,11350
+eo_tides-0.1.0.dist-info/METADATA,sha256=S8nHZcj3TWi2w_RpYilZFeBM_Hjw38hXE16eFJhNPQc,7260
+eo_tides-0.1.0.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+eo_tides-0.1.0.dist-info/top_level.txt,sha256=lXZDUUM1DlLdKWHRn8zdmtW8Rx-eQOIWVvt0b8VGiyQ,9
+eo_tides-0.1.0.dist-info/RECORD,,

eo_tides-0.0.23.dist-info/RECORD

@@ -1,11 +0,0 @@
-eo_tides/__init__.py,sha256=TWmQNplePCcNAlua5WI_H7SShkWNk-Gd3X70EDEknSo,1557
-eo_tides/eo.py,sha256=OTFjchQWpSfgi2Q62mFBj6ckmy_1B_ExCAmex4UT4js,21616
-eo_tides/model.py,sha256=XoJoIa6SmcAR8v1IDisqV8nW44XfY4YU4HWCoTgokx0,34390
-eo_tides/stats.py,sha256=9nfa7_obkS4tiHrQ1WTutuy2jlHtFg-cmOqP3l_Q7b8,20644
-eo_tides/utils.py,sha256=l9VXJawQzaRBYaFMsP8VBeaN5VA3rFDdzcvF7Rk04Vc,5620
-eo_tides/validation.py,sha256=JjTUqDfbR189m_6W1bpaSolQIHNTLicTHN7z9O_nr3s,11828
-eo_tides-0.0.23.dist-info/LICENSE,sha256=owxWsXViCL2J6Ks3XYhot7t4Y93nstmXAT95Zf030Cc,11350
-eo_tides-0.0.23.dist-info/METADATA,sha256=P01mYqtSyfTHIVAduGhTPyRbQe-ZNuCJXhYqKa4sq_s,6902
-eo_tides-0.0.23.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-eo_tides-0.0.23.dist-info/top_level.txt,sha256=lXZDUUM1DlLdKWHRn8zdmtW8Rx-eQOIWVvt0b8VGiyQ,9
-eo_tides-0.0.23.dist-info/RECORD,,