Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1.2 KB

README.md

File metadata and controls

25 lines (19 loc) · 1.2 KB

Finite difference based viscous Taylor-Goldstein equation solver.

This code is a python copy of Bill Smyth's matlab code and all credit for should go to Bill, his colleagues and collaborators. If you use this code as part of a publication, you should cite:

Smyth, W.D., J.N. Moum and J.D. Nash, 2011: “Narrowband, high-frequency oscillations at the equator. Part II: Properties of shear instabilities”, J. Phys. Oceanogr. 41, 412-428.

Download the repository and install by running the following command in the base directory of the repository:

pip install -e .

Collaborative development is encouraged and anyone is welcome to submit issues or pull requests.

For development, install the package in a new conda environment as follows:

conda env create -f environment.yml
conda activate pytg
pip install -e .

If developing with jupyter notebook/lab it may be convenient to install the kernel as follows:

conda activate pytg
python -m ipykernel install --user --name pytg --display-name pytg