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

Changed expected to expected_fh #2949

Closed
wants to merge 3 commits into from
Closed

Conversation

kevinzb56
Copy link

📝 Description

Type: 📝 documentation

Write a complete description of your changes, including the necessary context or any piece of information required to understand your work.

Changed expected to expected_fh in tardis.visualization.widgets.shell_info module.

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

fixes #2864

📌 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

*beep* *bop*

Hi, human.

I'm the @tardis-bot and couldn't find your records in my database. I think we don't know each other, or you changed your credentials recently.

Please add your name and email to .mailmap in your current branch and push the changes to this pull request.

In case you need to map an existing alias, follow this example.

@tardis-bot
Copy link
Contributor

tardis-bot commented Jan 14, 2025

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

3	F401  	[*] `numpy` imported but unused
1	INP001	[ ] File `tardis/io/configuration/tests/test_config_reader.py` is part of an implicit namespace package. Add an `__init__.py`.
1	PIE808	[*] Unnecessary `start` argument in `range`
1	I001  	[*] Import block is un-sorted or un-formatted

Complete output(might be large):

tardis/io/configuration/tests/test_config_reader.py:1:1: INP001 File `tardis/io/configuration/tests/test_config_reader.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/visualization/widgets/shell_info.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/visualization/widgets/shell_info.py:1:25: F401 [*] `tardis.base.run_tardis` imported but unused
tardis/visualization/widgets/shell_info.py:2:51: F401 [*] `tardis.io.atom_data.atom_web_download.download_atom_data` imported but unused
tardis/visualization/widgets/shell_info.py:12:17: F401 [*] `numpy` imported but unused
tardis/visualization/widgets/shell_info.py:299:25: PIE808 [*] Unnecessary `start` argument in `range`
Found 6 errors.
[*] 5 fixable with the `--fix` option.

@kevinzb56
Copy link
Author

@andrewfullard @atharva-2001 @jvshields
Could you please review this PR and let me know if there are any further changes to be made, Thank You.

@tardis-bot
Copy link
Contributor

*beep* *bop*
Hi human,
I ran benchmarks as you asked comparing master (2a06fdf) and the latest commit (106cc91).
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 [2a06fdfb] <master>   | After [106cc91a]    | Ratio   | Benchmark (Parameter)                                                                                                               |
|----------|------------------------------|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
|          | 41.7±20μs                    | 47.7±10μs           | ~1.14   | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_emission                                         |
|          | 621±100ns                    | 702±200ns           | ~1.13   | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_photoabsorption_opacity_calculation                              |
|          | 23.8±7μs                     | 21.6±5μs            | ~0.91   | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_last_interaction_tracker_list |
|          | 64.3±20μs                    | 57.2±20μs           | ~0.89   | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_scatter                                          |
|          | 5.97±1μs                     | 6.24±0.9μs          | 1.05    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket                                           |
|          | 551±100ns                    | 571±200ns           | 1.04    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_compton_opacity_calculation                                      |
|          | 1.39±0.3μs                   | 1.44±0.4μs          | 1.04    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_line                    |
|          | 3.09±0.6μs                   | 3.22±0.4μs          | 1.04    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_bad_vpacket                                       |
|          | 592±100ns                    | 612±200ns           | 1.03    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_pair_creation_opacity_calculation                                |
|          | 1.19±0μs                     | 1.21±0μs            | 1.01    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_boundary                |
|          | 1.67±0.01ms                  | 1.69±0.01ms         | 1.01    | transport_montecarlo_main_loop.BenchmarkTransportMontecarloMontecarloMainLoop.time_montecarlo_main_loop                             |
|          | 1.04±0m                      | 1.04±0m             | 1.00    | run_tardis.BenchmarkRunTardis.time_run_tardis_rpacket_tracking                                                                      |
|          | 2.09±0m                      | 2.08±0m             | 1.00    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_FormalIntegrator_functions                                 |
|          | 3.67±0.01ms                  | 3.64±0.01ms         | 0.99    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('macroatom')                                   |
|          | 38.7±0.1s                    | 38.2±0s             | 0.99    | run_tardis.BenchmarkRunTardis.time_run_tardis                                                                                       |
|          | 206±0.08ns                   | 203±0.5ns           | 0.99    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_intensity_black_body                                       |
|          | 765±0.7ns                    | 759±0.4ns           | 0.99    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_thomson_scatter                                       |
|          | 63.9±0.3ms                   | 63.4±0.1ms          | 0.99    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_rpacket_trackers_to_dataframe                  |
|          | 2.69±0.4ms                   | 2.63±0.5ms          | 0.98    | transport_montecarlo_single_packet_loop.BenchmarkTransportMontecarloSinglePacketLoop.time_single_packet_loop                        |
|          | 3.65±0.7μs                   | 3.55±0.4μs          | 0.97    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_within_shell                              |
|          | 2.72±0.01ms                  | 2.61±0.01ms         | 0.96    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('scatter')                                     |
|          | 39.2±0.01μs                  | 37.4±0.03μs         | 0.95    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_tracker_list                  |
|          | 2.20±1μs                     | 2.07±0.9μs          | 0.94    | transport_montecarlo_estimators_radfield_estimator_calcs.BenchmarkMontecarloMontecarloNumbaPacket.time_update_line_estimators       |
|          | 8.00±2μs                     | 7.27±1μs            | 0.91    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_volley                                    |

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

@andrewfullard
Copy link
Contributor

Hello! Are you planning to apply to Google Summer of Code?

@kevinzb56
Copy link
Author

Hey @andrewfullard, yes I am planning to apply for GSoC 2025 this year!

@andrewfullard
Copy link
Contributor

This is not the correct change, and appears to just be a find/replace in docstrings. Please read the issue more carefully and ask clarifying questions.

@kevinzb56
Copy link
Author

Thank you for pointing that out. From what I understood, the required changes needed to be made to the shell_info module under visualization.widgets. However, I realize I may have misunderstood some aspects of the issue. Could you please guide me on the specific requirements or expected changes to resolve this?

@andrewfullard
Copy link
Contributor

Look for variables named expected that are file handlers.

@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

I'm the @tardis-bot and couldn't find your records in my database. I think we don't know each other, or you changed your credentials recently.

Please add your name and email to .mailmap in your current branch and push the changes to this pull request.

In case you need to map an existing alias, follow this example.

@kevinzb56
Copy link
Author

kevinzb56 commented Jan 22, 2025

@andrewfullard Could you please elaborate on what you mean by "file handlers"? Are you referring to objects that handle file operations, like reading from or writing to a file (e.g., instances created using open() in Python)? Just want to clarify so I can understand your context better. Also are the changes required to be made to test_HDFWriter.py and test_density.py?

Thank you!

@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

I'm the @tardis-bot and couldn't find your records in my database. I think we don't know each other, or you changed your credentials recently.

Please add your name and email to .mailmap in your current branch and push the changes to this pull request.

In case you need to map an existing alias, follow this example.

@wkerzendorf
Copy link
Member

This is just a simple find and replace. Please make more involved PRs when applying for GSoC

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.

Change expected to expected_fh if it is a file handler
4 participants