Skip to content

Add rainfall intensity calculation function #11432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jun 11, 2024
Merged

Add rainfall intensity calculation function #11432

merged 3 commits into from
Jun 11, 2024

Conversation

yuriishizawa
Copy link
Contributor

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

tianyizheng02
tianyizheng02 requested changes Jun 5, 2024
View reviewed changes
physics/rainfall_intensity.py Outdated
Comment on lines 27 to 30
tr : float
Return period in years.
t : float
Rainfall event duration in minutes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you rename the last two variables to be more descriptive? That is, t -> duration, tr -> return_period, or something similar.

physics/rainfall_intensity.py Outdated
Comment on lines 14 to 15
The coefficients K, a, b, and c are obtained from the Sherman
intensity-duration-frequency curve for a specific location.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The coefficients K, a, b, and c are obtained from the Sherman
intensity-duration-frequency curve for a specific location.
The coefficients k, a, b, and c are obtained from the Sherman
intensity-duration-frequency curve for a specific location.

physics/rainfall_intensity.py Outdated
Comment on lines 19 to 26
k : float
Coefficient [adm].
a : float
Coefficient [adm].
b : float
Coefficient [adm].
c : float
Coefficient [adm].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does [adm] mean? And is it possible to give these four variables clearer names?

@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Jun 10, 2024
@yuriishizawa
Copy link
Contributor Author

Hello @tianyizheng02. Thank you for reviewing this PR. Your suggestions were excellent. Could you please check if the changes I made align with your recommendations?

@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed tests are failing Do not merge until tests pass labels Jun 10, 2024
@tianyizheng02 tianyizheng02 merged commit 41a1cdf into TheAlgorithms:master Jun 11, 2024
3 checks passed
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Jun 11, 2024
@tianyizheng02
Copy link
Contributor

Thanks for your contribution!

sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
@yuriishizawa @tianyizheng02 @sedatguzelsemme
Add rainfall intensity calculation function (TheAlgorithms#11432)
abc9d43 
* Add rainfall intensity calculation function

* chore: improve fuction and coefficient documentation

* Update physics/rainfall_intensity.py

---------

Co-authored-by: Tianyi Zheng <tianyizheng02@gmail.com>
cclauss pushed a commit to cclauss/Python that referenced this pull request Sep 30, 2024
@yuriishizawa @tianyizheng02 @cclauss
Add rainfall intensity calculation function (TheAlgorithms#11432)
d89b938 
* Add rainfall intensity calculation function

* chore: improve fuction and coefficient documentation

* Update physics/rainfall_intensity.py

---------

Co-authored-by: Tianyi Zheng <tianyizheng02@gmail.com>
cclauss pushed a commit to cclauss/Python that referenced this pull request Sep 30, 2024
@yuriishizawa @tianyizheng02 @cclauss
Add rainfall intensity calculation function (TheAlgorithms#11432)
5398329 
* Add rainfall intensity calculation function

* chore: improve fuction and coefficient documentation

* Update physics/rainfall_intensity.py

---------

Co-authored-by: Tianyi Zheng <tianyizheng02@gmail.com>
@isidroas isidroas mentioned this pull request Jan 25, 2025
Closed
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tianyizheng02 tianyizheng02 tianyizheng02 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@yuriishizawa @tianyizheng02