Skip to content
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

Add missing likelihood documentation #137

Merged
merged 15 commits into from
Jul 28, 2023
Merged

Conversation

mgerbino
Copy link
Collaborator

@mgerbino mgerbino commented Jun 27, 2023

This PR adds basic pieces of documentation to existing likelihoods:

  • Lensing
  • Clusters
  • xcorr

@codecov-commenter
Copy link

codecov-commenter commented Jun 27, 2023

Codecov Report

Merging #137 (eac902b) into master (5950d32) will decrease coverage by 0.02%.
The diff coverage is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #137      +/-   ##
==========================================
- Coverage   77.79%   77.78%   -0.02%     
==========================================
  Files          30       31       +1     
  Lines        1932     1931       -1     
==========================================
- Hits         1503     1502       -1     
  Misses        429      429              
Files Changed Coverage Δ
soliket/clusters/clusters.py 86.23% <ø> (ø)
soliket/clusters/massfunc.py 95.12% <ø> (ø)
soliket/clusters/survey.py 53.22% <ø> (ø)
soliket/clusters/sz_utils.py 86.50% <ø> (ø)
soliket/clusters/tinker.py 61.72% <ø> (ø)
soliket/lensing/lensing.py 95.74% <ø> (ø)
soliket/xcorr/limber.py 10.52% <ø> (ø)
soliket/xcorr/xcorr.py 16.30% <ø> (ø)
soliket/__init__.py 100.00% <100.00%> (ø)
soliket/cross_correlation/__init__.py 100.00% <100.00%> (ø)
... and 1 more

@mgerbino mgerbino marked this pull request as ready for review June 27, 2023 14:52
@mgerbino mgerbino requested a review from HTJense June 27, 2023 14:52
@itrharrison itrharrison self-requested a review July 28, 2023 14:02
Copy link
Collaborator

@itrharrison itrharrison left a comment

Choose a reason for hiding this comment

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

lgtm(!)

@itrharrison itrharrison merged commit 0fd50a0 into master Jul 28, 2023
7 checks passed
@itrharrison itrharrison deleted the dev-improve-documentation branch July 28, 2023 14:03
mgerbino added a commit that referenced this pull request Oct 4, 2023
* added documentation for lensing lkl

* added documentation for cluster lkl

* added xcorr to documentation

* expanded docs for lensing likelihoods

* tidied cluster likelihood docs

* tidying of xcorr docs

* added crosscorrelation likelihood docs

* added crosscorrelation as module

* remove .DS

* promoted crosscxorrelation to full module

* added missing init

* added missing rst

* added descriptive toc parentheses

---------

Co-authored-by: Martina Gerbino <[email protected]>
Co-authored-by: Ian Harrison <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants