Skip to content

feature/SOF 7894 2 - #305

Merged
timurbazhirov merged 3 commits into
mainfrom
feature/SOF-7894-2
May 12, 2026
Merged

feature/SOF 7894 2#305
timurbazhirov merged 3 commits into
mainfrom
feature/SOF-7894-2

Conversation

@VsevolodX

@VsevolodX VsevolodX commented May 12, 2026

Copy link
Copy Markdown
Member
  • update: name in key
  • chore: add labels
  • chore: name in
  • chore: fix qe scf
  • chore: fix qe scf
  • chore: remove plot

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated Quantum Espresso SCF workflow example with enhanced configuration procedures.
    • Removed energy visualization from the example workflow output.

Review Change Stack

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@coderabbitai

coderabbitai Bot commented May 12, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a00b9dc4-b259-492f-abee-65564c67d809

📥 Commits

Reviewing files that changed from the base of the PR and between 5f3a317 and ccc8942.

📒 Files selected for processing (1)
  • examples/workflow/qe_scf_calculation.ipynb

📝 Walkthrough

Walkthrough

The QE SCF calculation example notebook is updated to modernize its workflow API usage. The bash script is refactored to explicitly download the pseudopotential via curl, load modules, and redirect output. Template initialization switches to WorkflowStandata.get_by_name_first_match() for dynamic lookup. Job creation adds a _material field, and job monitoring is simplified by removing timeout arguments. The energy plotting cell is removed.

Changes

Quantum Espresso SCF Workflow Example

Layer / File(s) Summary
Bash script execution and workflow template initialization
examples/workflow/qe_scf_calculation.ipynb
The embedded bash script is updated to use curl for pseudopotential download, explicitly load the Espresso module, invoke pw.x via $EXEC_CMD, and redirect output to pw.out. Workflow initialization switches from loading a local JSON template file to using WorkflowStandata.get_by_name_first_match(...) with direct script injection.
Job creation payload and async job monitoring
examples/workflow/qe_scf_calculation.ipynb
Job creation payload adds a _material: "null" field to JOB_BODY. The wait_for_jobs_to_finish_async(...) call is simplified by removing explicit timeout and interval arguments.
Energy plotting cell removal
examples/workflow/qe_scf_calculation.ipynb
The matplotlib cell that plotted the extracted energy series against iteration steps is removed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • Exabyte-io/api-examples#301: Both PRs modify examples/workflow/qe_scf_calculation.ipynb's job-waiting behavior by switching or adjusting usage of wait_for_jobs_to_finish_async.
  • Exabyte-io/api-examples#303: Both PRs modify the SCF workflow to call wait_for_jobs_to_finish_async without explicit timeout and adjust pw.out handling to match redirected output.

Suggested reviewers

  • timurbazhirov

Poem

🐰 A rabbit hopped through the notebook with glee,
Replaced template files with dynamic decree,
Curl down the pseudos, redirect with care,
Job payloads trimmed, async waits pruned fair,
The plot was removed—cleaner workflows we share! 🌟

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/SOF-7894-2

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Ruff (0.15.12)
examples/workflow/qe_scf_calculation.ipynb

Unexpected end of JSON input


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@timurbazhirov
timurbazhirov merged commit 37836ca into main May 12, 2026
3 of 4 checks passed
@timurbazhirov
timurbazhirov deleted the feature/SOF-7894-2 branch May 12, 2026 23:12
@coderabbitai coderabbitai Bot mentioned this pull request Jun 15, 2026
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.

2 participants