Documentation update (spring cleaning 2026)#323
Open
Conversation
- Deleted the unit test workflow since it has not been used ever as a GitHub action. - Deleted gitattributes since we do not use Git LFS - Deleted very old example simulation output. - Removed execute permissions from a pixel response file. Remove and rename several ipynb files in examples - Removed several very old python notebook examples from the repository. These have been saved on Perlmutter in the DUNE CFS space so they can still be accessed. - Renamed a couple notebooks to remove the spaces in their filenames.
Updated all the docstrings in pixels_from_track.py to better include all the types, add cross-reference links, and in general provide more information about the function. Fix a few docstring errors in other functions/files so that Sphinx stops complaining when building docs. Fix a couple typos in comments.
Overhauled the Sphinx documentation to have better coverage, improved organization, and new automation.
The default value for V_DRIFT in consts/detector.py is not the same as the value calculated using the default E_FIELD and TEMPERATURE. Change V_DRIFT to match to hopefully reduce confusion when looking at the values in the file. Add another calculation of DRIFT_MAX_TIME after V_DRIFT is calculated using the E_FIELD and TEMPERATURE so it is consistent.
Added a custom warnings format so that the `warnings.warn()` line of code is no longer printed in addition to the message itself. Colored warnings yellow using ANSI escape sequences. Added another custom hook when showing warnings to use tqdm.write() so that the messages will print on their own line during tqdm wrapped loops.
Edited and updated the README to correct some outdated information, add new information (e.g. pixel pedestal configuration), and improve the readability. Rewrote the Sphinx `getting_started.rst` page to match the new README.
Fixed various spelling errors / typos in code comments, output messages, and doc-strings. No code/variables/etc. were modified.
Quite a few incorrect references in docstrings that were fixed. Nearly all of them were using an `array` type as the object annotation. Needs to be :obj:`numpy.ndarray` (or list) for the reference to be picked up correctly. Fixed a couple other docstring issues with the Sphinx referencing.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A collection of commits aimed at improving the documentation and organization of the repository.
Highlights include:
consts/detector.pyto reduce future confusionThe only code change for larnd-sim itself is in
consts/detector.pyto update the default drift velocity and fix a bug when calculatingDRIFT_MAX_TIME.