Skip to content

doc: Add in data assimilation tutorial and refactor example gallery #200

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

Merged
merged 22 commits into from
Jun 6, 2025

Conversation

angela-ko
Copy link
Contributor

@angela-ko angela-ko commented Jun 4, 2025

Description of changes

  • Refactored example gallery into building blocks demo
  • Added description for example gallery
  • Added example for data assimilation
  • Changed some stuff in the ipynb for formatting / linter

Testing done

Manually regenerated site.. pending ci testing

image

Copy link

codecov bot commented Jun 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.21%. Comparing base (8997bd0) to head (6d265c5).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #200   +/-   ##
=======================================
  Coverage   76.21%   76.21%           
=======================================
  Files          28       28           
  Lines        3078     3078           
  Branches      480      480           
=======================================
  Hits         2346     2346           
  Misses        519      519           
  Partials      213      213           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@angela-ko angela-ko marked this pull request as ready for review June 5, 2025 04:14
@angela-ko
Copy link
Contributor Author

Commented in the main body of the PR but I kept the advanced examples on the same page as the building blocks for cohesiveness and also because there is not much content on that front and a singular page would look a bit strange?

Copy link
Contributor

@xalelax xalelax left a comment

Choose a reason for hiding this comment

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

Left some comments, but this is such a cool example! gj everyone, but especially @yongquan-qu and @angela-ko !

@angela-ko
Copy link
Contributor Author

Slightly changed the formatting and renamed blocks to Blocks

image image

dionhaefner and others added 4 commits June 5, 2025 17:54
Co-authored-by: Alessandro Angioi <alessandro.angioi@simulation.science>
Co-authored-by: Alessandro Angioi <alessandro.angioi@simulation.science>
@PasteurBot
Copy link
Contributor

PasteurBot commented Jun 5, 2025

CLA signatures confirmed

All contributors have signed the Contributor License Agreement.
Posted by the CLA Assistant Lite bot.

@yongquan-qu
Copy link
Contributor

@PasteurBot I have read the CLA Document and I hereby sign the CLA

@angela-ko
Copy link
Contributor Author

recheck

@angela-ko angela-ko requested a review from xalelax June 5, 2025 17:04
@angela-ko
Copy link
Contributor Author

why wont the CLA bot pass!!

@yongquan-qu
Copy link
Contributor

recheck

@dionhaefner
Copy link
Contributor

@yongquan-qu looks like your comment has some extra whitespace. Please copy-paste this verbatim and make sure there's no leading or trailing whitespace:

@PasteurBot I have read the CLA Document and I hereby sign the CLA

Copy link
Contributor

@dionhaefner dionhaefner left a comment

Choose a reason for hiding this comment

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

Let's iterate a bit more on docs/demo/lorenz_tesseract.md in a follow-up, but for now this is a great improvement. Thanks all!

@yongquan-qu
Copy link
Contributor

@PasteurBot I have read the CLA Document and I hereby sign the CLA

Copy link
Contributor

@xalelax xalelax left a comment

Choose a reason for hiding this comment

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

LGTM!

@dionhaefner dionhaefner merged commit c34932b into main Jun 6, 2025
36 of 37 checks passed
@dionhaefner dionhaefner deleted the ako/advanced_tut branch June 6, 2025 12:01
@pasteurlabs pasteurlabs locked and limited conversation to collaborators Jun 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants