Skip to content

feature/SOF-8091 Update: a description above every code cell of the SrTiO3 notebooks - #405

Open
VsevolodX wants to merge 2 commits into
mainfrom
feature/SOF-8091
Open

VsevolodX wants to merge 2 commits into
mainfrom
feature/SOF-8091

Conversation

@VsevolodX

@VsevolodX VsevolodX commented Oct 29, 2026 •

Copy link
Copy Markdown
Member

Every code cell in slab_strontium_titanate.ipynb and slab_strontium_titanate_SIMULATION.ipynb now has a markdown description directly above it; markdown only, no code change (follow-up to #386).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Reorganized the slab-creation guidance into separate sections covering plane formulas and cleaved slabs, with clearer explanations of plane notation and slab faces.
    • Added headings to the simulation walkthrough for account and project selection, material loading and saving, model and compute setup, job creation and submission, and result retrieval.
    • Clarified that simulation materials, jobs, and projects are associated with the selected account.

VsevolodX and others added 2 commits October 26, 2026 15:38
Structure notebook: section 3 split into 3.1 (formula of a plane) and 3.2 (cleaved slab per orientation, with the
even-planes sentence moved there); section 4 into 4.1 (cut and remove) and 4.2 (report). Simulation notebook: a
sentence above the account selection; section 6 split into 6.1 (find or create a job), 6.2 (one Total Energy job per
material) and 6.3 (submit and wait). Markdown only.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…s of the notebook, section 4 as before

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@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 Oct 29, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b11cc8ae-baa8-4047-b46b-28dc6df79248
Commits

Reviewing files that changed from the base of the PR and between 0d674c1 and 948400e.

Files selected for processing: 2
  • other/materials_designer/specific_examples/slab_strontium_titanate.ipynb
  • other/materials_designer/specific_examples/slab_strontium_titanate_SIMULATION.ipynb

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The pull request reorganizes explanations and section headings in two SrTiO3 notebooks. It adds account context to the simulation notebook and updates cell IDs. Slab-generation and simulation code remain unchanged.

Changes: SrTiO3 notebook documentation

Layer / File(s) Summary
Slab notebook sections
other/materials_designer/specific_examples/slab_strontium_titanate.ipynb
The plane-formula section describes the formula notation. A new section explains alternating planes and differing slab faces. Subsequent cell IDs are updated.
Simulation notebook sections
other/materials_designer/specific_examples/slab_strontium_titanate_SIMULATION.ipynb
The notebook adds account context and subsection headings for material and compute setup, job execution, and result analysis. Cell IDs are updated; computational code is unchanged.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

  • mat3ra/api-examples#386: Added the SrTiO3 structure and simulation notebooks that this pull request reorganizes and documents.

Suggested reviewers: timurbazhirov

Merge Risk: Minimal · up to 94840

The documentation-only notebook changes introduce no established merge-blocking risk.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title accurately describes the main change: adding Markdown descriptions above code cells in the SrTiO3 notebooks. It is specific and related to the changeset.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

This branch has not been deployed

No deployments
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.

1 participant