Skip to content

README.md

Latest commit

 

History

History
15 lines (13 loc) · 532 Bytes

README.md

File metadata and controls

15 lines (13 loc) · 532 Bytes

Linear wave theory

A package that implements results from the linear wave theory of surface ocean gravity waves.

Requirements

  • Python3
  • numpy
  • numba
  • wheel (If developing/Contributing)
  • Pytest (If developing/Contributing)
  • Setuptools (If developing/Contributing)

Installation

  1. Make sure that you have the requirements listed above
  2. pip install linearwavetheory to your desired python environment
  3. Test with python3 -c 'import linearwavetheory'. If this runs successfully, chances are everything worked.