Skip to content

DEMO-1 quarto notebook (run workflow from pecan.xml)#3531

Merged
dlebauer merged 81 commits intoPecanProject:developfrom
AritraDey-Dev:gsoc/demo-1-run-workflow-from-pecan-xml
Aug 25, 2025
Merged

DEMO-1 quarto notebook (run workflow from pecan.xml)#3531
dlebauer merged 81 commits intoPecanProject:developfrom
AritraDey-Dev:gsoc/demo-1-run-workflow-from-pecan-xml

Conversation

@AritraDey-Dev
Copy link
Copy Markdown
Member

@AritraDey-Dev AritraDey-Dev commented May 26, 2025

Description

This PR introduces the initial version of a Quarto notebook as part of the Quarto PEcAn notebooks-based workflow GSoC project. The notebook enables users to run a complete PEcAn workflow using a pre-generated pecan.xml . It replicates the web-based Demo 1 workflow starting after the configuration step, allowing users to execute model runs, perform analysis, and visualize results directly from within the notebook interface.

Motivation and Context

This PR targets PEcAn gsoc project running worflows from quarto notebook.It is decided to keep two separate notebooks for replicating demo 1 workflow running via the web.

  • first notebook -> One for interactively generating the pecan.xml file based on user inputs (model, site, met selection, etc.).
  • second notebook -> Another that takes a pre-generated pecan.xml as input and handles the model run, analysis, and visualization, replicating the web interface flow post-setup.

This particular PR targets the second notebook, which uses a pre-generated pecan.xml file (either configured via the PEcAn web interface or to be created by the first notebook, which will be introduced in a follow-up PR).

Directory Structure

Few things to point at this point is about the directory structure -
i planned to keep the quarto notebook in this directory pecan/base/inst/quarto-notebooks/_extensions/
then two folder demo 1 and demo 2
demo 1 folder will consist of two notebooks 1)generate_xml.qmd 2)run_pecan.qmd
demo2 folder will consist of single notebook which will do ensemble,sensivity analysis basically replicating demo 2 workflow.

_extensions/
├── demo1/
│   ├── generate_xml.qmd     # Interactive XML configuration notebook
│   └── run_pecan.qmd        # Run PEcAn workflow using pre-generated XML
└── demo2/
    └── demo2_workflow.qmd   # Notebook for uncertainty & ensemble analysis

Any feedback on this directory structure is appreciated.

Knit report: PEcAn_workflow.pdf

Review Time Estimate

  • Immediately
  • Within one week
  • When possible

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • My name is in the list of CITATION.cff
  • I agree that PEcAn Project may distribute my contribution under any or all of
    • the same license as the existing code,
    • and/or the BSD 3-clause license.
  • I have updated the CHANGELOG.md.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@github-actions github-actions bot added the base label May 26, 2025
@AritraDey-Dev AritraDey-Dev changed the title DEMO-1 quarto (run workflow from pecan.xml) DEMO-1 quarto notebook (run workflow from pecan.xml) May 26, 2025
Copy link
Copy Markdown
Member

@dlebauer dlebauer left a comment

Choose a reason for hiding this comment

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

@AritraDey-Dev this is a great start! @mdietze thanks for the great feedback, I concur and look forward to reviewing on the next iteration!

Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
@AritraDey-Dev AritraDey-Dev requested a review from infotroph August 5, 2025 21:10
Signed-off-by: Aritra Dey <adey01027@gmail.com>
@AritraDey-Dev
Copy link
Copy Markdown
Member Author

@mdietze @infotroph Have your concerns mentioned above been addressed? If so, we can probably merge this one.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please remove from PR and replace with download as needed, as suggested in https://github.com/PecanProject/pecan/pull/3531/files#r2289497541

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Thanks for putting it in a gist.

AritraDey-Dev and others added 9 commits August 21, 2025 19:05
Co-authored-by: David LeBauer <dlebauer@gmail.com>
Co-authored-by: David LeBauer <dlebauer@gmail.com>
Co-authored-by: David LeBauer <dlebauer@gmail.com>
Co-authored-by: David LeBauer <dlebauer@gmail.com>
Co-authored-by: David LeBauer <dlebauer@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
Co-authored-by: David LeBauer <dlebauer@gmail.com>
Signed-off-by: Aritra Dey <adey01027@gmail.com>
@dlebauer dlebauer dismissed mdietze’s stale review August 25, 2025 21:30

suggested changes have been implemented

@dlebauer dlebauer added this pull request to the merge queue Aug 25, 2025
Merged via the queue into PecanProject:develop with commit 40728a0 Aug 25, 2025
18 of 25 checks passed
@AritraDey-Dev AritraDey-Dev deleted the gsoc/demo-1-run-workflow-from-pecan-xml branch August 26, 2025 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants