Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added citation
  • Loading branch information
hevgyrt authored Nov 29, 2023
1 parent 9516904 commit 148bcfa
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ A numerical solver of the wave ray equations for ocean waves.

![Demo](https://github.com/hevgyrt/ocean_wave_tracing/blob/main/notebooks/movie_rt_poc.gif)


## Table of contents
* [General info](#general-info)
* [Setup](#setup)
Expand All @@ -16,6 +15,7 @@ A numerical solver of the wave ray equations for ocean waves.
## General info
This project provides a numerical solver of the wave ray equations for ocean waves subject to ambient currents at arbitrary depths.

The solver has been documented and peer-reviewed in [Halsne et al. 2023](https://doi.org/10.5194/gmd-16-6515-2023), which should be cited when the tool is used.

## Setup
To run this project, install it locally using conda (or [mamba](https://anaconda.org/conda-forge/mamba) as used here):
Expand Down

0 comments on commit 148bcfa

Please sign in to comment.