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

Cut all the decay modes of the nuclides with an half life larger than 100 years #229

Merged
merged 1 commit into from
Nov 17, 2022

Conversation

EnricaBelfiore
Copy link
Contributor

@EnricaBelfiore EnricaBelfiore commented Nov 17, 2022

The option cut_hl to cut the decay modes of the nuclides with an half life larger than 100 years is inserted in the following methods:

  • sandy.DecayData.get_decay_chains()
  • sandy.DecayData.get_bmatrix()
  • sandy.DecayData.get_qmatrix()

Examples added and minor changes in docstrings

Copy link
Owner

@luca-fiorito-11 luca-fiorito-11 left a comment

Choose a reason for hiding this comment

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

Some comments, a few typos and inconsistencies that do not prevent from merging, but they should be tackled in the future.
Probably an associated issues should be opened.

skip_parent : `bool`, optional, default is `False`
skip_parents : `bool`, optional, default is `False`
flag to skip the parent information
cut_hl: `bool`, optional, default is `False`
Copy link
Owner

Choose a reason for hiding this comment

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

@EnricaBelfiore , i guess the default here should be True

"""
Extract decay chains into dataframe.

Parameters
----------
skip_parent : `bool`, optional, default is `False`
Copy link
Owner

Choose a reason for hiding this comment

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

For the future, from this description it is unclear what this option does

@@ -376,6 +380,22 @@ def get_decay_chains(self, skip_parents=False, **kwargs):
>>> rdd.get_decay_chains(skip_parents=True)
PARENT DAUGHTER YIELD LAMBDA
0 270600 280600 1.00000e+00 4.16705e-09

Cut the dacay modes of the nuclides with an half life larger
Copy link
Owner

Choose a reason for hiding this comment

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

Typo, a few times in the docstring

Optional argument to avoid numerical fluctuations or
kwargs : `dict`
keyword arguments for method `get_decay_chains`
thereshold: `int`, optional, default is `None`
Copy link
Owner

Choose a reason for hiding this comment

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

Typo

Thereshold: 'int'
Optional argument to avoid numerical fluctuations or
kwargs : `dict`
keyword arguments for method `get_decay_chains`
Copy link
Owner

Choose a reason for hiding this comment

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

Kwargs are for method get_bmatrix

@luca-fiorito-11 luca-fiorito-11 merged commit 21375ff into develop Nov 17, 2022
@luca-fiorito-11 luca-fiorito-11 deleted the cut_hl branch November 17, 2022 16:41
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.

2 participants