Skip to content

Commit 5f0d3f9

Browse files
authored
Update README for v1.2
1 parent 3c7f74b commit 5f0d3f9

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Gilford, D. M. 2020: pyPI: Potential Intensity Calculations in Python, v1.0, Zen
2828

2929
## Full pyPI Description
3030

31-
Please read [pyPI_Documentation.pdf](pyPI_Documentation.pdf) for a full overview and details on pyPI.
32-
The description includes the pyPI background, a PI computation derivation, validation against the commonly-used MATLAB algorithm (pcmin), and a set of sample analyses. *As of 5/5/2020, the provided documentation is only a draft. It is not a fully-reviewed release.*
31+
Please read [pyPI_Documentation_v1.2.pdf](pyPI_Documentation_v1.2.pdf) for a full overview and details on pyPI.
32+
The description includes the pyPI background, a PI computation derivation, validation against the commonly-used MATLAB algorithm (pcmin), and a set of sample analyses.
3333

3434
## Getting Started
3535

@@ -80,6 +80,7 @@ and examine the outputs locally produced in [full_sample_output.nc](./data/full_
8080
* **[utilities.py](utilities.py)** - Set of functions used in the pyPI codebase
8181
* **[reference_calculations.m](./matlab_scripts/reference_calculations.m)** - Script used to generate sample BE02 MATLAB outout data from original MERRA2 files monthly mean; included for posterity and transperancy
8282
* **[pc_min.m](pc_min.m)** - Original BE02 algorithm from MATLAB, adapted and used to produce analyses of Gilford et al. ([2017](https://journals.ametsoc.org/doi/abs/10.1175/JCLI-D-16-0827.1); [2019](https://journals.ametsoc.org/doi/10.1175/MWR-D-19-0021.1))
83+
* **[clock_pypi.ipynb](./notebooks/clock_pypi.ipynb)** - Notebook estimating the time it takes to run pyPI on a laptop
8384

8485
## Author
8586

@@ -94,5 +95,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
9495

9596
## Acknowledgments
9697

97-
* Prof. Kerry Emanuel (MIT) - Development of potential intensity theory; encouragement and permission to pursue Python implementation
98-
* Prof. Susan Solomon (MIT), Prof. Paul O'Gorman (MIT), Prof. Allison Wing (FSU) - Helpful conversations, advice, and suggestions on TC PI research
98+
* Kerry Emanuel (MIT) - Development of potential intensity theory; encouragement and permission to pursue Python implementation
99+
* Susan Solomon (MIT), Paul O'Gorman (MIT), Allison Wing (FSU) - Helpful conversations, advice, and suggestions on TC PI research
100+
* Dan Chavas (Purdue), Jonathan Lin (MIT), Raphael Rousseau-Rizzi (MIT) - Feedback on pyPI code and documentation

0 commit comments

Comments
 (0)