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 zenodo badge in the release summary notes #2838

Merged
merged 5 commits into from
Oct 8, 2024

Conversation

KasukabeDefenceForce
Copy link
Contributor

@KasukabeDefenceForce KasukabeDefenceForce commented Oct 3, 2024

📝 Description

Type: 🪲 bugfix | 🚀 feature | ☣️ breaking change | 🚦 testing | 📝 documentation | 🎢 infrastructure

This PR aims at adding a zenodo badge in the release summary github notes alongwith the changelog.

Sample Run:
https://github.com/KasukabeDefenceForce/tardis/releases/tag/release-0024.10.07.1

📌 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.

@tardis-bot
Copy link
Contributor

tardis-bot commented Oct 3, 2024

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

17	W293  	[*] Blank line contains whitespace
9	W291  	[*] Trailing whitespace
5	F405  	[ ] `exclude_patterns` may be undefined, or defined from star imports
3	E999  	[ ] SyntaxError: Expected an expression
3	UP015 	[*] Unnecessary open mode parameters
2	E402  	[ ] Module level import not at top of file
2	W292  	[*] No newline at end of file
1	I001  	[*] Import block is un-sorted or un-formatted
1	E701  	[ ] Multiple statements on one line (colon)
1	E712  	[*] Avoid equality comparisons to `True`; use `if toml_config_tool_dict["tardis"]['edit_on_github']:` for truth checks
1	F401  	[*] `tardis` imported but unused
1	PGH004	[ ] Use specific rule codes when using `noqa`
1	UP009 	[*] UTF-8 encoding declaration is unnecessary
1	UP030 	[*] Use implicit references for positional format fields
1	UP032 	[*] Use f-string instead of `format` call

Complete output(might be large):

.github/workflows/benchmarks.yml:3:4: E999 SyntaxError: Expected an expression
.github/workflows/benchmarks.yml:20:5: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:81:49: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:111:81: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:112:54: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:199:1: W293 [*] Blank line contains whitespace
.github/workflows/benchmarks.yml:218:22: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:219:170: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:221:84: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:238:1: W293 [*] Blank line contains whitespace
.github/workflows/release.yml:7:4: E999 SyntaxError: Expected an expression
.github/workflows/release.yml:16:7: E701 Multiple statements on one line (colon)
.github/workflows/release.yml:48:1: W293 [*] Blank line contains whitespace
.github/workflows/release.yml:51:1: W293 [*] Blank line contains whitespace
.github/workflows/release.yml:58:1: W293 [*] Blank line contains whitespace
.github/workflows/release.yml:61:1: W293 [*] Blank line contains whitespace
.github/workflows/release.yml:64:1: W293 [*] Blank line contains whitespace
.github/workflows/release.yml:69:1: W293 [*] Blank line contains whitespace
.github/workflows/release.yml:73:1: W293 [*] Blank line contains whitespace
.github/workflows/release.yml:89:1: W293 [*] Blank line contains whitespace
.github/workflows/release.yml:97:23: W292 [*] No newline at end of file
.github/workflows/stardis-tests.yml:3:4: E999 SyntaxError: Expected an expression
.github/workflows/stardis-tests.yml:22:1: W293 [*] Blank line contains whitespace
.github/workflows/stardis-tests.yml:39:11: W291 [*] Trailing whitespace
.github/workflows/stardis-tests.yml:51:1: W293 [*] Blank line contains whitespace
.github/workflows/stardis-tests.yml:58:1: W293 [*] Blank line contains whitespace
.github/workflows/stardis-tests.yml:64:1: W293 [*] Blank line contains whitespace
.github/workflows/stardis-tests.yml:69:1: W293 [*] Blank line contains whitespace
.github/workflows/stardis-tests.yml:75:32: W291 [*] Trailing whitespace
.github/workflows/stardis-tests.yml:76:20: W292 [*] No newline at end of file
docs/conf.py:1:1: UP009 [*] UTF-8 encoding declaration is unnecessary
docs/conf.py:27:1: I001 [*] Import block is un-sorted or un-formatted
docs/conf.py:30:8: F401 [*] `tardis` imported but unused
docs/conf.py:36:43: PGH004 Use specific rule codes when using `noqa`
docs/conf.py:46:6: UP015 [*] Unnecessary open mode parameters
docs/conf.py:67:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:68:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:69:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:70:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:71:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:138:1: W293 Blank line contains whitespace
docs/conf.py:173:1: W293 Blank line contains whitespace
docs/conf.py:190:13: UP030 Use implicit references for positional format fields
docs/conf.py:190:13: UP032 [*] Use f-string instead of `format` call
docs/conf.py:217:1: E402 Module level import not at top of file
docs/conf.py:290:4: E712 Avoid equality comparisons to `True`; use `if toml_config_tool_dict["tardis"]['edit_on_github']:` for truth checks
docs/conf.py:351:1: E402 Module level import not at top of file
docs/conf.py:366:10: UP015 [*] Unnecessary open mode parameters, use ""w""
docs/conf.py:381:10: UP015 [*] Unnecessary open mode parameters, use ""w""
Found 49 errors.
[*] 33 fixable with the `--fix` option (4 hidden fixes can be enabled with the `--unsafe-fixes` option).

Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.51%. Comparing base (2aa6732) to head (df94404).
Report is 5 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2838      +/-   ##
==========================================
- Coverage   70.89%   70.51%   -0.39%     
==========================================
  Files         209      209              
  Lines       15589    15589              
==========================================
- Hits        11052    10992      -60     
- Misses       4537     4597      +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 October 3, 2024 13:15
@atharva-2001
Copy link
Member

I think the benchmarks workflow should pass once you rebase.

@KasukabeDefenceForce KasukabeDefenceForce marked this pull request as draft October 3, 2024 14:33
@KasukabeDefenceForce KasukabeDefenceForce marked this pull request as ready for review October 7, 2024 12:38
draft: false

- name: Wait for Zenodo to update the latest release
run: sleep 30
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe this should be longer just to be safer in allowing zenodo enough time for the DOI to generate.

Copy link
Contributor

Choose a reason for hiding this comment

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

Agreed. 1 minute or more would be safer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated it to 120 seconds.

jvshields
jvshields previously approved these changes Oct 7, 2024
@tardis-bot
Copy link
Contributor

tardis-bot commented Oct 7, 2024

*beep* *bop*
Hi human,
I ran benchmarks as you asked comparing master (2aa6732) and the latest commit (df94404).
Here are the logs produced by ASV.
Results can also be downloaded as artifacts here.

Significantly changed benchmarks:

All benchmarks:

Benchmarks that have stayed the same:

| Change   | Before [43413319] <master>   | After [df94404a]    | Ratio   | Benchmark (Parameter)                                                                                                               |
|----------|------------------------------|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
|          | 1.46±0.4μs                   | 1.27±0.4μs          | ~0.87   | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_line                    |
|          | 7.09±2μs                     | 7.59±2μs            | 1.07    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_volley                                    |
|          | 3.19±0.7μs                   | 3.42±0.8μs          | 1.07    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_within_shell                              |
|          | 1.18±0μs                     | 1.26±0μs            | 1.06    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_boundary                |
|          | 1.91±1μs                     | 2.02±0.9μs          | 1.05    | transport_montecarlo_estimators_radfield_estimator_calcs.BenchmarkMontecarloMontecarloNumbaPacket.time_update_line_estimators       |
|          | 3.11±0.4μs                   | 3.25±0.8μs          | 1.05    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_bad_vpacket                                       |
|          | 2.61±0.5ms                   | 2.68±0.5ms          | 1.03    | transport_montecarlo_single_packet_loop.BenchmarkTransportMontecarloSinglePacketLoop.time_single_packet_loop                        |
|          | 46.2±30μs                    | 46.7±30μs           | 1.01    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_scatter                                          |
|          | 37.4±0.1s                    | 37.4±0.06s          | 1.00    | run_tardis.BenchmarkRunTardis.time_run_tardis                                                                                       |
|          | 2.08±0m                      | 2.08±0m             | 1.00    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_FormalIntegrator_functions                                 |
|          | 3.69±0.02ms                  | 3.65±0ms            | 0.99    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('macroatom')                                   |
|          | 2.73±0.01ms                  | 2.70±0.01ms         | 0.99    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('scatter')                                     |
|          | 42.8±20μs                    | 42.3±30μs           | 0.99    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_emission                                         |
|          | 1.66±0.01ms                  | 1.65±0.01ms         | 0.99    | transport_montecarlo_main_loop.BenchmarkTransportMontecarloMontecarloMainLoop.time_montecarlo_main_loop                             |
|          | 1.04±0m                      | 1.02±0m             | 0.98    | run_tardis.BenchmarkRunTardis.time_run_tardis_rpacket_tracking                                                                      |
|          | 31.7±0.04μs                  | 31.1±0.04μs         | 0.98    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_tracker_list                  |
|          | 6.11±0.8μs                   | 5.96±1μs            | 0.98    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket                                           |
|          | 209±0.06ns                   | 204±0ns             | 0.97    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_intensity_black_body                                       |
|          | 740±10ns                     | 721±1ns             | 0.97    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_thomson_scatter                                       |
|          | 65.5±0.03ms                  | 63.3±0.01ms         | 0.97    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_rpacket_trackers_to_dataframe                  |
|          | 21.0±5μs                     | 19.9±5μs            | 0.95    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_last_interaction_tracker_list |
|          | 550±200ns                    | 511±100ns           | 0.93    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_compton_opacity_calculation                                      |
|          | 601±200ns                    | 561±100ns           | 0.93    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_pair_creation_opacity_calculation                                |
|          | 591±100ns                    | 551±200ns           | 0.93    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_photoabsorption_opacity_calculation                              |

If you want to see the graph of the results, you can check it here

@jvshields jvshields merged commit 16354d0 into tardis-sn:master Oct 8, 2024
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants