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

Adding Explanations to Spectrum Configuration #1827

Merged
merged 9 commits into from Jan 12, 2022

Conversation

bartnikm
Copy link
Contributor

@bartnikm bartnikm commented Nov 19, 2021

Description
Added Explanations to the Spectrum Configuration Section of the Documentation

Motivation and context
The original did not have a description of how to edit method parameters, so this would be nice for newer users

How has this been tested?

  • Testing pipeline.
  • Other.

Examples

https://bartnikm.github.io/tardis-bartnikm/branch/spectrum_configuration/io/configuration/components/spectrum.html

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@codecov
Copy link

codecov bot commented Nov 19, 2021

Codecov Report

Merging #1827 (8205ee0) into master (f52044a) will decrease coverage by 0.38%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1827      +/-   ##
==========================================
- Coverage   58.04%   57.65%   -0.39%     
==========================================
  Files          66       66              
  Lines        6747     6809      +62     
==========================================
+ Hits         3916     3926      +10     
- Misses       2831     2883      +52     
Impacted Files Coverage Δ
...dis/montecarlo/montecarlo_numba/numba_interface.py 35.46% <0.00%> (-10.69%) ⬇️
tardis/tardis/montecarlo/montecarlo_numba/base.py 25.00% <0.00%> (-1.22%) ⬇️
tardis/tardis/analysis.py 30.16% <0.00%> (ø)
...rdis/tardis/montecarlo/montecarlo_configuration.py 100.00% <0.00%> (ø)
tardis/tardis/montecarlo/base.py 88.94% <0.00%> (+0.17%) ⬆️
.../montecarlo/montecarlo_numba/single_packet_loop.py 29.78% <0.00%> (+2.66%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f52044a...8205ee0. Read the comment docs.

@bartnikm bartnikm marked this pull request as ready for review November 23, 2021 21:22
@isaacgsmith isaacgsmith self-requested a review November 23, 2021 21:22
@tardis-bot
Copy link
Contributor

Before a pull request is accepted, it must meet the following criteria:

  • Is the necessary information provided?
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

Copy link
Member

@isaacgsmith isaacgsmith left a comment

Choose a reason for hiding this comment

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

Lines 11-13 could use some better explanation and clean-up (I know you did not write them). Start should not be capitalized and I'd probably say "value with units" as opposed to "quantity with units" as they are not expressed as astropy quantities. Also, I don't entirely like how it uses "frequency space" as I think we can explain that with less technical vocabulary.

docs/io/configuration/components/spectrum.rst Show resolved Hide resolved
docs/io/configuration/components/spectrum.rst Outdated Show resolved Hide resolved
tardis/io/schemas/spectrum.yml Outdated Show resolved Hide resolved
tardis/io/schemas/spectrum.yml Outdated Show resolved Hide resolved
@isaacgsmith isaacgsmith self-requested a review January 9, 2022 00:06
Copy link
Member

@isaacgsmith isaacgsmith left a comment

Choose a reason for hiding this comment

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

Other than these quick fixes (you can just commit them directly from github) it looks good to go!

docs/io/configuration/components/spectrum.rst Outdated Show resolved Hide resolved
docs/io/configuration/components/spectrum.rst Outdated Show resolved Hide resolved
Copy link
Member

@isaacgsmith isaacgsmith left a comment

Choose a reason for hiding this comment

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

Great!

@andrewfullard andrewfullard added this to In progress in Documentation Jan 10, 2022
@andrewfullard andrewfullard merged commit 6649e68 into tardis-sn:master Jan 12, 2022
Documentation automation moved this from In progress to Done Jan 12, 2022
@bartnikm bartnikm deleted the spectrum_configuration branch February 17, 2022 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants