docs: add literature references throughout the code (closes #3)#5
Merged
Merged
Conversation
Add in-code citations to the underlying theory so the references are not confined to the README. - spectrum.py / tools.py: add a module-level References bibliography (Lalanne Mechanical Vibration and Shock Analysis, Vol. 1/3/4/5, 2009, + Thomson) with consistent [LalanneN]/[Thomson] keys. - Spectrum class docstring maps each signal type to its governing equation. - Per-method/inline references with exact equation numbers for the sine, sine-sweep, random-PSD and random-time ERS/FDS formulae, the segmented-PSD response RMS (eq [8.86]), the I0/I2/I4 closed forms (App. A6), and the damped SDOF impulse response. Also corrects several pre-existing inaccurate citations: - sine-sweep ERS comments cited Vol.1 "[1.21]/[1.22]/[1.23], p.31-32"; the correct source is Vol.5 eqs [1.31]/[1.32]/[1.33], p.16 (branch tags were also swapped). - random-PSD FDS cited "Vol. 0 ... (A1-93)"; replaced with Vol.4 eq [4.41] = Vol.5 eqs [4.7]-[4.8]. - response_relative_displacement cited Thomson eq (4.2-5), the undamped kernel; clarified that the code implements the damped impulse response. Documentation only; no behaviour change. Full test suite passes.
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
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.
Closes #3.
Currently the references live only in the README. This adds the literature citations into the code so the theory behind each formula is discoverable at the point of use.
What was added
spectrum.pyandtools.py— Lalanne, Mechanical Vibration and Shock Analysis, Vol. 1/3/4/5 (2009, ISTE/Wiley) and Thomson, with consistent[LalanneN]/[Thomson]reference keys.Spectrumclass docstring mapping each signal type (sine / sine-sweep / random-PSD / random-time) to its governing equation.I0/I2/I4closed forms → App. A6 ([A6.20]/[A6.22]/[A6.24]),n0→ eq [5.76], FDS → eq [4.41]/[4.7]–[4.8]Corrections to pre-existing citations
response_relative_displacementcited Thomson eq (4.2-5), which is the undamped kernel; clarified that the code implements the damped impulse response.Notes
fix/random-fds-factor-2, so the random-FDS reference comments describe the correctedn0/full-cycle formulas. Base this PR on that branch (or rebase ontomasteronce the fix lands).