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 spectrum visualization notebook #2964

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

KasukabeDefenceForce
Copy link
Contributor

📝 Description

Type: 🪲 bugfix | 🚀 feature | ☣️ breaking change | 🚦 testing | 📝 documentation | 🎢 infrastructure
This PR aims at adding a spectrum visualization notebook which has some examples regarding how can someone plot the spectrum data.

Also, link issues affected by this pull request by using the keywords: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved.

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@tardis-bot
Copy link
Contributor

tardis-bot commented Feb 3, 2025

*beep* *bop*
Hi human,
I ran ruff on the latest commit (73333c1).
Here are the outputs produced.
Results can also be downloaded as artifacts here.
Summarised output:

34	W291  	[*] Trailing whitespace
7	I001  	[*] Import block is un-sorted or un-formatted
6	E999  	[ ] SyntaxError: Expected a statement
6	W293  	[*] Blank line contains whitespace
3	INP001	[ ] File `tardis/analysis/opacities.py` is part of an implicit namespace package. Add an `__init__.py`.
2	PIE808	[*] Unnecessary `start` argument in `range`
2	E712  	[*] Avoid equality comparisons to `False`; use `if not ...:` for false checks
2	F401  	[*] `tardis.tests.test_util.monkeysession` imported but unused
2	F811  	[ ] Redefinition of unused `monkeysession` from line 6
1	E703  	[*] Statement ends with an unnecessary semicolon

Complete output(might be large):

docs/analysing_tardis_outputs/index.rst:1:1: E999 SyntaxError: Expected an expression
docs/analysing_tardis_outputs/index.rst:12:1: W293 [*] Blank line contains whitespace
docs/analysing_tardis_outputs/visualization/demo_observed_spectrum.dat:1:26: E999 SyntaxError: Simple statements must be separated by newlines or semicolons
docs/analysing_tardis_outputs/visualization/how_to_generating_widgets.ipynb:cell 5:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/analysing_tardis_outputs/visualization/how_to_generating_widgets.ipynb:cell 5:3:5: F401 [*] `tardis.visualization.shell_info_from_hdf` imported but unused
docs/analysing_tardis_outputs/visualization/how_to_sdec_plot.ipynb:cell 2:2:1: I001 [*] Import block is un-sorted or un-formatted
docs/analysing_tardis_outputs/visualization/how_to_sdec_plot.ipynb:cell 29:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/analysing_tardis_outputs/visualization/index.rst:1:1: E999 SyntaxError: Expected a statement
docs/analysing_tardis_outputs/visualization/index.rst:25:1: W293 [*] Blank line contains whitespace
docs/analysing_tardis_outputs/visualization/tardis_example.yml:2:26: E999 SyntaxError: Simple statements must be separated by newlines or semicolons
docs/analysing_tardis_outputs/visualization/tutorial_convergence_plot.ipynb:cell 9:4:28: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/tutorial_convergence_plot.ipynb:cell 12:29:1: W293 [*] Blank line contains whitespace
docs/analysing_tardis_outputs/visualization/tutorial_convergence_plot.ipynb:cell 13:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/analysing_tardis_outputs/visualization/tutorial_montecarlo_packet_visualization.ipynb:cell 5:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/analysing_tardis_outputs/visualization/using_widgets.rst:1:1: E999 SyntaxError: Expected an expression
docs/analysing_tardis_outputs/visualization/using_widgets.rst:7:83: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:15:69: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:23:76: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:24:41: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:26:77: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:29:79: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:39:75: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:40:80: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:41:78: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:42:75: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:43:75: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:51:77: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:52:79: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:53:73: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:54:71: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:62:74: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:63:76: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:71:80: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:72:79: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:80:78: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:81:77: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:82:77: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:109:48: W291 [*] Trailing whitespace
docs/analysing_tardis_outputs/visualization/using_widgets.rst:161:77: W291 [*] Trailing whitespace
docs/index.rst:1:1: E999 SyntaxError: Expected a statement
docs/index.rst:21:51: W291 [*] Trailing whitespace
docs/index.rst:43:76: W291 [*] Trailing whitespace
docs/index.rst:44:64: W291 [*] Trailing whitespace
docs/index.rst:45:71: W291 [*] Trailing whitespace
docs/index.rst:46:69: W291 [*] Trailing whitespace
docs/index.rst:47:68: W291 [*] Trailing whitespace
docs/index.rst:66:1: W293 [*] Blank line contains whitespace
docs/index.rst:88:1: W293 [*] Blank line contains whitespace
docs/index.rst:112:1: W293 [*] Blank line contains whitespace
docs/io/grid/how_to_TardisGridTutorial.ipynb:cell 2:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/io/grid/how_to_TardisGridTutorial.ipynb:cell 7:2:74: W291 [*] Trailing whitespace
docs/io/grid/how_to_TardisGridTutorial.ipynb:cell 14:1:47: W291 [*] Trailing whitespace
docs/io/grid/how_to_TardisGridTutorial.ipynb:cell 14:4:46: E703 [*] Statement ends with an unnecessary semicolon
docs/io/grid/how_to_TardisGridTutorial.ipynb:cell 15:2:55: W291 [*] Trailing whitespace
tardis/analysis/opacities.py:1:1: INP001 File `tardis/analysis/opacities.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/grid/tests/test_grid.py:1:1: INP001 File `tardis/grid/tests/test_grid.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/io/model/readers/tests/test_arepo_parser.py:1:1: INP001 File `tardis/io/model/readers/tests/test_arepo_parser.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/transport/montecarlo/tests/conftest.py:14:5: F811 Redefinition of unused `opacity_state_initialize` from line 7
tardis/visualization/tools/tests/test_convergence_plot.py:3:1: I001 [*] Import block is un-sorted or un-formatted
tardis/visualization/tools/tests/test_convergence_plot.py:6:36: F401 [*] `tardis.tests.test_util.monkeysession` imported but unused
tardis/visualization/tools/tests/test_convergence_plot.py:87:24: PIE808 [*] Unnecessary `start` argument in `range`
tardis/visualization/tools/tests/test_convergence_plot.py:111:22: PIE808 [*] Unnecessary `start` argument in `range`
tardis/visualization/tools/tests/test_convergence_plot.py:198:9: E712 Avoid equality comparisons to `False`; use `if not ...:` for false checks
tardis/visualization/tools/tests/test_convergence_plot.py:215:9: E712 Avoid equality comparisons to `False`; use `if not ...:` for false checks
tardis/visualization/tools/tests/test_convergence_plot.py:220:40: F811 Redefinition of unused `monkeysession` from line 6
Found 65 errors.
[*] 52 fixable with the `--fix` option (2 hidden fixes can be enabled with the `--unsafe-fixes` option).

@KasukabeDefenceForce KasukabeDefenceForce marked this pull request as ready for review February 4, 2025 14:09
@tardis-bot
Copy link
Contributor

tardis-bot commented Feb 4, 2025

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

Copy link

codecov bot commented Feb 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.17%. Comparing base (304154a) to head (73333c1).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2964      +/-   ##
==========================================
- Coverage   69.54%   69.17%   -0.37%     
==========================================
  Files         228      228              
  Lines       16429    16429              
==========================================
- Hits        11425    11365      -60     
- Misses       5004     5064      +60     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@KasukabeDefenceForce KasukabeDefenceForce marked this pull request as ready for review February 11, 2025 05:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants