Execute 2D model construction Literate tutorial with plots#41
Merged
Conversation
Enable Literate execution so the tutorial renders cell outputs and a saved figure asset, fix constructor argument order after #40, import extended NLL for method extension, and pin DistributionsHEP to a revision that exports ExtendedMixtureModel. Co-authored-by: Cursor <cursoragent@cursor.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation generation configuration to execute and document the 2D model construction tutorial. It updates the tutorial script to save and display the generated plot as an asset, reorders arguments in the ConstructorOfFit2DExtendedKKComponents call, and updates the Manifest.toml dependencies. Additionally, it imports extended_negative_log_likelihood instead of using it in the 2D distribution fit example. I have no feedback to provide as there are no review comments.
Replace the manual figure save/asset workaround with a plain Plots layout picked up by Literate, and relax Documenter's HTML size threshold so the generated tutorial page can embed the plot output. Co-authored-by: Cursor <cursoragent@cursor.com>
Use a side-by-side model heatmap and data histogram2d with themed 1D projection panels, without overlaying scatter on the density map. Co-authored-by: Cursor <cursoragent@cursor.com>
Explain how two_dimensional_model.jl defines the 1D shapes, extended 2D assembly, and NLL wrapper before the tutorial builds constructor instances. Co-authored-by: Cursor <cursoragent@cursor.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
1 participant
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.
Related issues
There is no related issue.
Checklist
I am following the contributing guidelines
Tests are passing
Lint workflow is passing
Docs were updated and workflow is passing
Summary
execute=true,documenter=true) so the 2D Model Construction tutorial renders cell outputs instead of empty code blocks.docs/src/assets/2d-model-construction-start.pngand reference it with a relative markdown image, avoiding Documenter's HTML size threshold for inline base64 plots.ConstructorOfFit2DExtendedKKComponentscall order to match@with_parametersdeclaration order (yields before nested constructors), which blocked execution after Preserve declaration order in @with_parameters constructor arguments #40.extended_negative_log_likelihoodwrapper import so the method extension is valid under Julia 1.11.docs/Manifest.tomlto aDistributionsHEPrevision that exportsExtendedMixtureModel.Test plan
julia --project=docs docs/generate_literate.jlcompletes and writes outputs + plot assetjulia --project=docs docs/make.jlbuilds documentation successfully