Skip to content

Commit

Permalink
Update README.md with testing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jahn authored May 18, 2024
1 parent bd191ed commit 6d92996
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions utils/python/MITgcmutils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,15 @@ This package is developed as a part of MITgcm on

It is documented in the MITgcm
[manual](http://mitgcm.rtfd.io/en/latest/utilities/utilities.html#mitgcmutils).

To test any changes to MITgcmutils, do the following in a clone of the MITgcm repository:
1. Check out the submodule with reference data:
```
git submodule init
git submodule update
```
3. Install the needed python versions (python3.7 through python3.12).
4. Install tox: https://tox.wiki/en/4.15.0/installation.html
On a mac, it may be necessary to install pipx via macports/brew
or use the "pip" method.
5. Run "tox" in the top MITgcmutils directory.

0 comments on commit 6d92996

Please sign in to comment.