Bayesian Excess Variance (Bexvar) in Stingray - GSoC'22 project

[mihirtripathi97]

This is the base code for implementing Bayesian Excess Variance (bexvar) in Stingray (#582).

This project is part of Google Summer of Code 2022, a brief summary of the project can be found here.

[pep8speaks]

Hello @mihirtripathi97! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file stingray/bexvar.py:

Line 55:20: E261 at least two spaces before inline comment
Line 57:10: E261 at least two spaces before inline comment
Line 75:90: E502 the backslash is redundant between brackets
Line 76:9: E128 continuation line under-indented for visual indent
Line 112:48: E203 whitespace before ','
Line 112:66: E502 the backslash is redundant between brackets
Line 113:13: E128 continuation line under-indented for visual indent
Line 118:1: E302 expected 2 blank lines, found 1
Line 148:17: E221 multiple spaces before operator
Line 159:71: E502 the backslash is redundant between brackets
Line 160:9: E128 continuation line under-indented for visual indent
Line 168:49: E251 unexpected spaces around keyword / parameter equals
Line 168:51: E251 unexpected spaces around keyword / parameter equals
Line 168:66: E251 unexpected spaces around keyword / parameter equals
Line 168:68: E251 unexpected spaces around keyword / parameter equals
Line 168:83: E251 unexpected spaces around keyword / parameter equals
Line 168:85: E251 unexpected spaces around keyword / parameter equals
Line 184:101: E501 line too long (102 > 100 characters)
Line 187:1: W293 blank line contains whitespace
Line 200:79: W291 trailing whitespace
Line 214:44: E203 whitespace before ','
Line 251:91: W291 trailing whitespace
Line 265:56: E231 missing whitespace after ','
Line 268:48: E231 missing whitespace after ','
Line 269:44: E231 missing whitespace after ','
Line 271:43: E231 missing whitespace after ','

• In the file stingray/tests/test_bexvar.py:

Line 13:1: E302 expected 2 blank lines, found 1

Comment last updated at 2022-07-22 12:25:47 UTC

[codecov]

Codecov Report

Merging #664 (cad13a3) into main (1bd574a) will decrease coverage by 7.34%.
The diff coverage is 45.55%.

❗ Current head cad13a3 differs from pull request most recent head 9f48fbb. Consider uploading reports for the commit 9f48fbb to get more accurate results

@@            Coverage Diff             @@
##             main     #664      +/-   ##
==========================================
- Coverage   97.12%   89.78%   -7.35%     
==========================================
  Files          41       42       +1     
  Lines        7554     7644      +90     
==========================================
- Hits         7337     6863     -474     
- Misses        217      781     +564     

Impacted Files	Coverage Δ
stingray/bexvar.py	45.55% <45.55%> (ø)
stingray/largememory.py	10.99% <0.00%> (-84.05%)	⬇️
stingray/pulse/overlapandsave/test_ols.py	68.62% <0.00%> (-31.38%)	⬇️
stingray/pulse/__init__.py	76.92% <0.00%> (-23.08%)	⬇️
stingray/base.py	77.15% <0.00%> (-19.83%)	⬇️
stingray/modeling/parameterestimation.py	67.29% <0.00%> (-18.75%)	⬇️
stingray/pulse/pulsar.py	89.43% <0.00%> (-9.16%)	⬇️
stingray/gti.py	94.91% <0.00%> (-4.33%)	⬇️
stingray/utils.py	95.19% <0.00%> (-3.81%)	⬇️
stingray/powerspectrum.py	95.65% <0.00%> (-3.77%)	⬇️
... and 6 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[matteobachetti]

Good job! Some small requests, they should be quick to implement.

[matteobachetti]

A few additions, looking at the lines that are not covered by tests

[matteobachetti]

Great job @mihirtripathi97!
It's approved, but I have very minor request: please run a last check of the consistency of docstrings. I just notice that, e.g. Iterable is sometimes capitalized, sometimes not.