Skip to content

Commit 4fccf42

Browse files
committed
RTide 1.0 release
Major update to RTide -Added ability to handle currents (2-d inputs) -complete overhaul of input function generation to be much faster. -added functionality to also reference to a fixed location for faster computations and flexibility. -Added SIREN architecture option -Added ability to add trend -Cleaned up plotting -SHAP is now compatible with 2-d outputs and if a trend is used. -Modified example notebooks to reflect new functionality & added example for currents. -License has been changed.
1 parent 38271bd commit 4fccf42

22 files changed

Lines changed: 21553 additions & 14162 deletions

.DS_Store

0 Bytes
Binary file not shown.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# RTide
2-
A Python implementation of the framework for [Automating the tidal response method](https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2024JH000525). The method is an extension of the response method created by Munk and Cartwright in: 'Tidal Spectroscopy and Prediction'. RTide can be used for conventional tidal analysis and prediction, and is well suited to problems involving non-stationary contamination such as tidal rivers, and meteorological forcing.
2+
A Python implementation of the framework for [Automating the tidal response method](https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2024JH000525) and [Response-based prediction of tidal currents](https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2025JC022758). The method is an extension of the response method created by Munk and Cartwright in: 'Tidal Spectroscopy and Prediction'. RTide can be used for conventional tidal analysis and prediction, and is well suited to problems involving non-stationary contamination such as tidal rivers, and meteorological forcing.
33

44
# Installation
55
```
@@ -64,7 +64,7 @@ Bibtex:
6464
}
6565
```
6666
# Commercialization Details:
67-
Commercial use requires a paid license. See LICENSE for details. Questions can be emailed to thomas.monahan@eng.ox.ac.uk
67+
Note for RTide 1.0, commercial use requires a paid license. See LICENSE for details. Questions can be emailed to thomas.monahan@eng.ox.ac.uk. Personal and academic usage is permitted freely.
6868

6969
# Useful Response Method References
7070
[1] Munk, Walter Heinrich, and David Edgar Cartwright. "Tidal spectroscopy and prediction." Philosophical Transactions of the Royal Society of London. Series A, Mathematical and Physical Sciences 259.1105 (1966): 533-581.

examples/.DS_Store

0 Bytes
Binary file not shown.

examples/.ipynb_checkpoints/rtide_meteorological_example-checkpoint.ipynb

Lines changed: 2712 additions & 0 deletions
Large diffs are not rendered by default.

examples/.ipynb_checkpoints/rtide_rivers_example-checkpoint.ipynb

Lines changed: 2224 additions & 0 deletions
Large diffs are not rendered by default.

examples/.ipynb_checkpoints/rtide_synthetic_currents_example-checkpoint

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

examples/.ipynb_checkpoints/rtide_synthetic_currents_example-checkpoint.ipynb

Lines changed: 1520 additions & 0 deletions
Large diffs are not rendered by default.

examples/.ipynb_checkpoints/rtide_synthetic_example-checkpoint.ipynb

Lines changed: 3346 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)