docs: PiWind end-to-end + step-by-step notebooks + intersphinx - #42
Draft
sstruzik wants to merge 4 commits into
Draft
docs: PiWind end-to-end + step-by-step notebooks + intersphinx#42sstruzik wants to merge 4 commits into
sstruzik wants to merge 4 commits into
Conversation
Stand up an executable docs project in OasisModels (Furo + myst-nb) and add the high-level worked example tutorials/run-piwind-analysis.md: shows the single 'oasislmf model run -C config' command (full pytools pipeline modelpy->gulmc->fmpy-> summarypy->eltpy/pltpy/lecpy/aalpy) and analyses the ORD outputs it produces (SELT, OEP/AEP EP curves for GUL & IL, losses at return periods) from a committed sample of a real PiWind run. Engine shown as a command, not executed at build; analysis cells execute (verified). ORD EPType/EPCalc semantics per ODS_OpenResultsData. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add tutorials/pipeline-step-by-step.md decomposing the generated run_kernel.sh pipeline stage by stage: evepy -> gulmc -> fmpy -> summarypy -> eltpy/pltpy/lecpy/ aalpy. Each stage shows the real command (extracted from the script) and the intermediary stream data (events, GUL item-level losses with the sidx statistics, FM insured losses), produced by running each pytools tool once on a single event and converted with bintocsv. Engine shown as commands, not executed at build; sample-loading cells execute (verified by render). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add the orchestrator-driven intersphinx block so the models docs can cross-reference the other Oasis component sites in the aggregated build. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add the Oasis logo (light/dark, always visible in the Furo sidebar), the maroon/red Raleway palette matching oasislmf.github.io, and a persistent 'Oasis documentation home' link (rewritten to page-relative by the aggregator) so you can return to the top of the aggregated site from anywhere. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Executable PiWind notebooks (high-level end-to-end analysis + step-by-step kernel pipeline) and the cross-component intersphinx block.
Part of the cross-repo Oasis documentation restructure (Option B).
Add OasisModels docs: executable PiWind end-to-end and step-by-step pipeline notebooks.