Skip to content

Update docs for unbinding timing changes + misc - #124

Merged
VictorForouhar merged 18 commits into
masterfrom
document_timing_changes
Sep 26, 2025
Merged

Update docs for unbinding timing changes + misc#124
VictorForouhar merged 18 commits into
masterfrom
document_timing_changes

Conversation

@VictorForouhar

@VictorForouhar VictorForouhar commented Sep 24, 2025

Copy link
Copy Markdown
Collaborator

This PR adds docs for the changes in #121, and some example plots of how unbinding time scales with number of particles (neat!).

I have also restructured the docs a bit. I thought it was weird to talk about the timing.log file in the diagnostics instead of the Output section of the code. Hence, I moved it there.

I also noticed a few additional things that should be addressed:

  • Add docs for ReassignParticles parameter.
  • Timers for read_snap and read_halo are currently meaningless. For example, read_snap is stored immediately after snap_hash.
  • Some timers are swift specific (e.g. halo_comms and halo_io).

@VictorForouhar VictorForouhar changed the title Update docs for unbinding timing changes + mics Update docs for unbinding timing changes + misc Sep 24, 2025
@VictorForouhar

Copy link
Copy Markdown
Collaborator Author

The timers are now placed on similar places across I/O formats, and I have removed those which would always measure 0 seconds. gadget binary format does not require communication of halo particles, unlike apostle and swift formats. Hence, there is not halo_comms timer for gadget.

I also removed the GSL parts of the code, which we have never used and were there to compute the eigenvalues of the inertia tensor. I think there are handier ways to do so, especially if we already provide the inertia tensors.

@VictorForouhar
VictorForouhar marked this pull request as ready for review September 26, 2025 09:45
@VictorForouhar
VictorForouhar merged commit cfed255 into master Sep 26, 2025
4 checks passed
@VictorForouhar
VictorForouhar deleted the document_timing_changes branch September 26, 2025 16:03
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