Create _streamflow_flow_indices.py #1832
Conversation
streamflow_flow_indice is a submodule in the xclim indices module to calculate streamflow signatures, representing individual watershed characteristics of large river/lake basins.
github-actions
bot
added
docs
|
Welcome, new contributor! It appears that this is your first Pull Request. To give credit where it's due, we ask that you add your information to the
Please make sure you've read our contributing guide. We look forward to reviewing your Pull Request shortly ✨ |
for more information, see https://pre-commit.ci
|
There was a problem hiding this comment.
If the flow_index is not in the literature, I suggest to remove it from this PR and keep it in your project scripts.
Once this PR is merged in, I think it would be interesting to look at additional indices that requires other variables like precipitation, as I think it would provide better physical understanding of processes.
The next step will be to write a test for each index to make sure it behaves as expected. You'll see plenty of examples in the test directory.
.DS_Store
Outdated
There was a problem hiding this comment.
Remove this file and add .DS_Store to the .gitignore. I'm surprised it wasn't already there!
There was a problem hiding this comment.
This file still needs to be removed, then I would add this file to the bottom of the gitignore:
# Apple
.DS_Store
for more information, see https://pre-commit.ci
Co-authored-by: David Huard <huard.david@ouranos.ca>
Co-authored-by: David Huard <huard.david@ouranos.ca>
faimahsho
force-pushed
the
Watershed-indices
branch
from
1a48fe2
to
70e0174
Compare
faimahsho
force-pushed
the
Watershed-indices
branch
2 times, most recently
from
948fa30
to
0507d4c
Compare
faimahsho
force-pushed
the
Watershed-indices
branch
from
8641c3b
to
bb69dd4
Compare
for more information, see https://pre-commit.ci
| @@ -2152,3 +2152,35 @@ @article{droogers2002 | |||
| url = {https://www.scopus.com/inward/record.uri?eid=2-s2.0-0036464359&doi=10.1023%2fA%3a1015508322413&partnerID=40&md5=7322aaa4c6874878f5b1dab3c73c1718}, | |||
| type = {Article} | |||
| } | |||
|
|
|||
| @article{addor2018, | |||
There was a problem hiding this comment.
Good ! Now please use cite commands in the docstrings to refer to those. You'll see an example of how it's done in indices/_synoptic.py.
For example,
:cite:p:`addor2018`
to add a reference in parenthesis in the text (use :cite:t: for textual citations without parentheses), and
:cite:cts:`addor2018`
to add the citation in the References section.
There was a problem hiding this comment.
Looks good. Please review the changes I just pushed, and add tests for the "indicators" I created.
Note that I added an indexer argument, which lets you pick a season or specific months. Let me know if you believe this is useful or not.
I think the next step would be to have Louise review the finalized PR.
faimahsho
force-pushed
the
Watershed-indices
branch
3 times, most recently
from
d8ae74d
to
7beffe9
Compare
…ean over whole period. This part of the analysis can be done on the user-side. Added support for **indexer, allowing more freedom when selecting the period
faimahsho
force-pushed
the
Watershed-indices
branch
from
7beffe9
to
4e086d6
Compare
Co-authored-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
for more information, see https://pre-commit.ci
streamflow_flow_indice is a submodule in the xclim indices module to calculate streamflow signatures, representing individual watershed characteristics of large river/lake basins.
Pull Request Checklist:
number) and pull request (:pull:number) has been addedWhat kind of change does this PR introduce?
Does this PR introduce a breaking change?
This can develop unique watershed attributes.
Other information: