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 document #61

Merged
merged 22 commits into from
Oct 31, 2022
Merged

Add document #61

merged 22 commits into from
Oct 31, 2022

Conversation

zihaoxu98
Copy link
Collaborator

@zihaoxu98 zihaoxu98 commented Oct 27, 2022

In this PR, some docstrings are modified, and a folder containing scripts to generate documents is added.

Try to solve: #42

- bins_type: either meshgrid or equiprob
- bins_on: observables where we will perform inference on, usually [cs1, cs2]
- x_clip, y_clip: ROI of the fitting, should be list of upper and lower boundary
- data_file_name: the data used in fitting, usually calibration data

Choose a reason for hiding this comment

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

[pep8] reported by reviewdog 🐶
RST301 Unexpected indentation.

raise NotImplementedError

def implement_binning(self, mc, eff):
"""Apply binning to MC data."""
"""Apply binning to MC data.
:param mc: data from simulation.

Choose a reason for hiding this comment

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

[pep8] reported by reviewdog 🐶
WPS221 Found line with high Jones Complexity: 15 > 14

"""Apply binning to MC data."""
"""Apply binning to MC data.
:param mc: data from simulation.
:param eff: efficiency of each event, as the weight when making a histogram.

Choose a reason for hiding this comment

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

[pep8] reported by reviewdog 🐶
WPS221 Found line with high Jones Complexity: 15 > 14

"""Apply binning to MC data.
:param mc: data from simulation.
:param eff: efficiency of each event, as the weight when making a histogram.
"""

Choose a reason for hiding this comment

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

[pep8] reported by reviewdog 🐶
WPS518 Found implicit enumerate() call

"""Simulate."""
"""The main simulation function.

:param key: a jnp.array with length 2, used to generate random variables.

Choose a reason for hiding this comment

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

[pep8] reported by reviewdog 🐶
W291 trailing whitespace

appletree/plugin.py Show resolved Hide resolved
@coveralls
Copy link

coveralls commented Oct 27, 2022

Pull Request Test Coverage Report for Build 3362305951

  • 9 of 14 (64.29%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 80.012%

Changes Missing Coverage Covered Lines Changed/Added Lines %
appletree/component.py 9 14 64.29%
Totals Coverage Status
Change from base Build 3303770640: 0.0%
Covered Lines: 1285
Relevant Lines: 1606

💛 - Coveralls

@zihaoxu98 zihaoxu98 marked this pull request as ready for review October 27, 2022 22:03
.readthedocs.yml Outdated

formats:
- htmlzip
- epub
Copy link
Collaborator

Choose a reason for hiding this comment

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

@xzh19980906 It seems that some files lost their last line. : )

@dachengx dachengx merged commit ffccb66 into master Oct 31, 2022
@dachengx dachengx deleted the docs branch October 31, 2022 15:09
@dachengx dachengx mentioned this pull request Oct 31, 2022
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.

None yet

3 participants