Metadata-Version: 2.4
Name: oceantracker
Version: 0.5.2.0
Summary: Fast offline Lagrangian particle tracking in the Ocean for structured and unstructured grids
Author-email: Ross Vennell <ross.vennell@otago.ac.nz>, Laurin Steidle <laurin.steidle@cawthron.org.nz>
Maintainer-email: Laurin Steidle <laurin.steidle@cawthron.org.nz>
License-Expression: MIT
Project-URL: Homepage, https://oceantracker.github.io/oceantracker/
Project-URL: Documentation, https://oceantracker.github.io/oceantracker/
Project-URL: Repository, https://github.com/oceantracker/oceantracker
Project-URL: Issues, https://github.com/oceantracker/oceantracker/issues
Keywords: oceanography,particle tracking,lagrangian,ocean modeling
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: netcdf4
Requires-Dist: xarray
Requires-Dist: scipy
Requires-Dist: pyproj
Requires-Dist: psutil
Requires-Dist: matplotlib
Requires-Dist: pyyaml
Requires-Dist: ffmpeg
Requires-Dist: ipykernel
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# OceanTracker

## Fast particle tracking in structure and unstructured grids

OceanTracker is a fast extendable code for offline particle tracking in structured and  unstructured grids [1].
OceanTracker currently  supports structured grid ROMs and GLORYS (NEMO/COPERNICUS) 
for fixed z level vertical grids and unstructured grids of SCHISM 
(both original netcdf format and new format with variables split between files) and DELFT3D-FM.
Other formats added on request. 

Fast computational approaches to numerical interpolation makes OceanTracker extremely fast even on a single computer core [2]. 
In addition, intense computations are split to run in parallel across available physical computer cores.

OceanTracker’s speed enables millions of particles to be simulated. This significantly increases 
the range of particle behaviours that can be modeled and the quality of statistics derived from the particles. 
To eliminate the need to store and wade through the analysis of vast volumes of recorded particle tracks, the code has 
the ability to calculate statistics on the fly, such as heat maps and connectivity between regions.

OceanTracker code is highly flexible and extendable by the user, whether run by a new user with a text file of 
parameters, or by an expert adding their specialised code for novel particle behaviours or statistics, to the computational pipe line


[More about Ocean tracker and gallery](https://oceantracker.github.io/oceantracker/)

[Installing Oceantracker](https://oceantracker.github.io/oceantracker/_build/html/info/installing.html)

[Oceantracker User Guide](https://oceantracker.github.io/oceantracker/_build/html/info/users_guide.html)
  
[Running Oceantracker ](https://oceantracker.github.io/oceantracker/_build/html/info/running_ocean_tracker.html)

[Howto tutorials](https://oceantracker.github.io/oceantracker/_build/html/info/how_to.html)

[1] Vennell, R.,Steidle. L.,  Scheel, M.,Chaput. R., Knight, B. and Smeaton, M, OceanTracker 0.5: Fast Adaptable Lagrangian Particle Tracking in
Structured and Unstructured Grid, preprint, https://eartharxiv.org/repository/view/8387/ 

[2] Vennell, R., Scheel, M., Weppe, S., Knight, B. and Smeaton, M., 2021. Fast lagrangian particle tracking in unstructured ocean model grids , Ocean Dynamics, 71(4), pp.423-437.
