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

Setting up documentation for mflike #121

Merged
merged 16 commits into from
May 23, 2023
Merged

Setting up documentation for mflike #121

merged 16 commits into from
May 23, 2023

Conversation

sgiardie
Copy link
Collaborator

@sgiardie sgiardie commented Mar 3, 2023

I am setting up documentation for mflike. I have also added the placeholders for bandpass.py and foreground.py

@codecov-commenter
Copy link

codecov-commenter commented Mar 3, 2023

Codecov Report

Merging #121 (6cb2a40) into master (18bfefd) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #121   +/-   ##
=======================================
  Coverage   73.12%   73.12%           
=======================================
  Files          30       30           
  Lines        1935     1935           
=======================================
  Hits         1415     1415           
  Misses        520      520           
Impacted Files Coverage Δ
soliket/bandpass.py 44.89% <ø> (ø)
soliket/foreground.py 95.55% <ø> (ø)
soliket/mflike/mflike.py 80.88% <ø> (ø)
soliket/mflike/theoryforge_MFLike.py 86.20% <ø> (ø)

@itrharrison itrharrison added documentation Improvements or additions to documentation mflike Related to mflike likelihood labels Mar 3, 2023
@itrharrison itrharrison added this to the v0.1 milestone Mar 3, 2023
@sgiardie sgiardie requested a review from itrharrison March 6, 2023 08:24
@itrharrison itrharrison requested a review from HTJense March 9, 2023 12:21
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.

The Bandpass documentation still needs work, I think. There are a number of functions which appear in the docs but have no comments associated with them.

Is it possible to remove the spellchecker underlining in mflike_scheme.png?

soliket/mflike/mflike.py Show resolved Hide resolved
soliket/bandpass.py Show resolved Hide resolved
@sgiardie
Copy link
Collaborator Author

sgiardie commented Mar 9, 2023

The Bandpass documentation still needs work, I think. There are a number of functions which appear in the docs but have no comments associated with them.

Indeed! I just added a line under the first function to try a math block and since it was working I left that there. If I remember well, @mgerbino was going to document both bandpass and foreground

Is it possible to remove the spellchecker underlining in mflike_scheme.png?

I got that picture as a screenshot from a document that @mgerbino passed to me. Maybe she has the original?

@sgiardie sgiardie requested a review from itrharrison May 22, 2023 13:25
@sgiardie
Copy link
Collaborator Author

I have added documentation for foreground.py and bandpass.py. In the case of bandpass.py I added some comments due to the fact that some functions may change/be canceled with the upgrade of the mflike version.

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 2068146 into master May 23, 2023
@itrharrison itrharrison deleted the doc_mflike branch May 23, 2023 14:51
mgerbino pushed a commit that referenced this pull request Oct 4, 2023
* first commit to set docs for mflike

* modifications

* adding figure

* reformatting

* docs for mflike and theoryforge

* small fixes

* adding documentation for bandpass

* adding foreground docs

* Update bandpass.py

Add link referring to bandpass shift bug.

* codestyle update bandpass.py

---------

Co-authored-by: Ian Harrison <itrharrison@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation mflike Related to mflike likelihood
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants