Metadata-Version: 2.4
Name: linearwavetheory
Version: 0.0.23
Summary: Python package that implements linear wave theory for ocean surface gravity waves
Home-page: https://github.com/sofarocean/linearwavetheory.git
Author: Pieter Bart Smit
Author-email: sofaroceangithubbot@gmail.com
License: Apache 2 License
Project-URL: Sofar Ocean Site, https://www.sofarocean.com
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: numba_progress
Requires-Dist: numba
Requires-Dist: pdoc
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: summary

# 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.
