Repository navigation
Add PySeismoSoil main features to README, etc. - #123
Merged
Merged
Conversation
The version string now comes from the installed package metadata, and a pre-commit hook copies README.md to the Sphinx entry page. Co-authored-by: jsh9 <jsh9@users.noreply.github.com>
The notebook pre-commit check requires every notebook to have been run after the branch point on main. Co-authored-by: jsh9 <jsh9@users.noreply.github.com>
Sections 1.1-1.3 now match chapters 2-4 of the thesis. Section 1.4 lists five analysis utilities, the dead license link is replaced, and the supported-Python-versions section is removed. Co-authored-by: jsh9 <jsh9@users.noreply.github.com>
The example notebooks conflicted only in saved outputs. The cell sources match main, and these outputs were produced after that main commit. Co-authored-by: jsh9 <jsh9@users.noreply.github.com>
jsh9
marked this pull request as ready for review
October 11, 2026 19:44
Also drop the changelog note about re-running the example notebooks. Co-authored-by: jsh9 <jsh9@users.noreply.github.com>
This was referenced Oct 11, 2026
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.
Summary
The README now opens with what PySeismoSoil does, and the published docs homepage stays a copy of that README.
PySeismoSoil.__version__is read from the installed package metadata (importlib.metadata) instead of a hard-coded string.copy_readme, copiesREADME.mdtodocs/source/index.md. Sphinx reads that file with MyST, and the hook appends a hidden table of contents so the class and module pages stay in the sidebar.authors.library.caltech.eduwhere a CaltechAUTHORS record exists. The 2019 dissertation is onthesis.caltech.edu, which is where that record lives.main. The supported-Python-versions section is removed.Corrections against the thesis:
Test
pre-commit run -apasses, includingcheck-notebooks-were-run.make htmlindocs/succeeds on the previous homepage setup. This commit only changes the README text that the same hook copies intodocs/source/index.md.