Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CES Lorenz example for JOSS paper #250

Merged
merged 1 commit into from
Dec 12, 2023
Merged

CES Lorenz example for JOSS paper #250

merged 1 commit into from
Dec 12, 2023

Conversation

mhowlan3
Copy link
Contributor

@mhowlan3 mhowlan3 commented Nov 6, 2023

Purpose

Closes #255

Content

Docs can be found here.


  • I have read and checked the items on the review checklist.

@mhowlan3 mhowlan3 requested a review from odunbar November 6, 2023 00:02
Copy link

codecov bot commented Nov 17, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a621a04) 88.09% compared to head (b15aaec) 88.16%.
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #250      +/-   ##
==========================================
+ Coverage   88.09%   88.16%   +0.07%     
==========================================
  Files           7        7              
  Lines        1134     1124      -10     
==========================================
- Hits          999      991       -8     
+ Misses        135      133       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@odunbar odunbar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the work! Looking good so far, I had a few small comments and this main point:

  • I feel the walkthrouh is unfinished, could you add the points detailed below, such as adding snippets for building of machine learning tools / emulators, and building and running of MCMC? Including the "get_posterior" call to obtain the results from the chain object.

examples/Lorenz/emulate_sample.jl Show resolved Hide resolved
docs/src/examples/lorenz_example.md Show resolved Hide resolved
docs/src/examples/lorenz_example.md Show resolved Hide resolved
docs/src/examples/lorenz_example.md Outdated Show resolved Hide resolved
docs/src/examples/lorenz_example.md Outdated Show resolved Hide resolved
docs/src/examples/lorenz_example.md Outdated Show resolved Hide resolved
docs/src/examples/lorenz_example.md Show resolved Hide resolved
Copy link
Collaborator

@odunbar odunbar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update! This looks much better! The main points of this review:

  • There is still a gap where we jump from defining the prior, to defining the emulator, perhaps it would be good to discuss (briefly) EKI in between and move up the calibration results to come before the discussion of emulators
  • You can be a bit more judicious with the snippets, some have unnecessary lines (e.g. savefig or println statements, while other snippets mention items that aren't explained (e.g. optimizer_options = overrides in RF-scalar)

docs/src/examples/lorenz_example.md Outdated Show resolved Hide resolved
docs/src/examples/lorenz_example.md Outdated Show resolved Hide resolved
docs/src/examples/lorenz_example.md Outdated Show resolved Hide resolved
docs/src/examples/lorenz_example.md Outdated Show resolved Hide resolved
docs/src/examples/lorenz_example.md Outdated Show resolved Hide resolved
docs/src/examples/lorenz_example.md Outdated Show resolved Hide resolved
docs/src/examples/lorenz_example.md Show resolved Hide resolved
Copy link
Collaborator

@odunbar odunbar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Thanks for all the work.

LGTM

@odunbar odunbar changed the title [WIP] CES Lorenz example for JOSS paper CES Lorenz example for JOSS paper Dec 11, 2023
docs build

docs build

docs build

docs build

some updates to Lorenz example documentation

commit before rebase

removed manifest.toml files

added results figures to docs

added results figures to docs

remove manifest

finished description of emulate_sample.jl in docs

quick format fix

quick typo fix

reorganized to more clearly explain the calibrate and emulate_sample stages

small typo on file title
@odunbar
Copy link
Collaborator

odunbar commented Dec 11, 2023

NB I have rebased and force-pushed to enable merge into main. No other changes have been made

@odunbar odunbar merged commit 7768fc3 into main Dec 12, 2023
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write consistent docs page for Lorenz
2 participants