-
Notifications
You must be signed in to change notification settings - Fork 33
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.
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
Global coherence #573
Global coherence #573
Conversation
* pin all python versions to 3.11.0 (#567) * pin all python versions to 3.11.0 * Update .travis.yml * Update rtd_env.yml * Update environment.yml * Update environment.yml * Update testmaster.yml * pin to 3.11.0 * Update .readthedocs.yaml (#568) * Mcpca doc (#570) * ensemblegeoseries docstring fix * ensmultivardecomp doc string fix * mgs docstrings * ms docstrings * mvd docstrings * doc fixes * tick version (#571) * tick version * add requests to setup.py * verbose doc fix --------- Co-authored-by: Alexander James <akeenjames@gmail.com> --------- Co-authored-by: Jordan Landers <10099739+jordanplanders@users.noreply.github.com> Co-authored-by: Julien Emile-Geay <CommonClimate@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work! A few minor changes to take it to 11.
-
On the code side, since
Series.global_coherence()
is built on top of wavelet_coherence(), I recommend having an optional parameter calledcoh
, which wouldNone
by default, but would allow you to pass a coherence object from which the average would be taken. -
The gcoh.plot() command should have a label on the right-hand side that says "coherence" (or "global coherence") by default, which could be controlled by a parameter called
ylabel_rhs
(similarly, need aylabel_lhs = PSD
by default) -
On the docstring side, I recommend that the docstring for
Series.global_coherence()
does something withgcoh
(e.g. plot it). Otherwise, it's a very frustrating docstring to read because it ends in a blind corner.
The latest commits should address these:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to go
Adds global coherence functionality to pyleoclim. Includes a .plot and .signif_test method.
Built on top of wavelet_coherence.