Skip to content

Rewrite MC-01a and MC-01b tutorials - #54

Closed
egull wants to merge 1 commit into
mainfrom
fix/mc01-rewrite
Closed

Rewrite MC-01a and MC-01b tutorials#54
egull wants to merge 1 commit into
mainfrom
fix/mc01-rewrite

Conversation

@egull

@egull egull commented May 31, 2026

Copy link
Copy Markdown
Contributor

Summary

MC-01a (Autocorrelations)

  • Fix code block languages: ALPS parameter files and shell commands were incorrectly tagged as Python; only actual Python code now uses that tag
  • Fix task file count: said task1 through task5 but there are 6 system sizes
  • Remove outdated Internet Explorer reference
  • Expand the Cluster updates section with full runnable code and a physical explanation of critical slowing down ($\tau \sim L^z$)
  • Add an intro paragraph explaining autocorrelation time and the binning analysis

MC-01b (Equilibration)

  • Remove broken "Read here to see how it works." placeholder
  • Rewrite awkward "The headers:" code fragments into proper prose-plus-code sections
  • Expand the convergence section to explain what checkConvergence does and when to act on its output
  • Add a Questions section

Test plan

  • Code blocks render with correct syntax highlighting (plain for parameters/shell, Python for scripts)
  • All download links for parm1a, parm1b, tutorial1a.py, tutorial1b.py resolve
  • Figures mcs01binlocal.png and mcs01bincluster.png render correctly
  • Prose is physically accurate (critical slowing down, binning analysis, steady-state check)

🤖 Generated with Claude Code

MC-01a: fix code block languages (parameter files and shell commands were
incorrectly tagged as Python); fix task file count (said 1-5, should be
1-6); remove outdated Internet Explorer reference; expand the cluster
updates section to include full code and a physical explanation of critical
slowing down; add an explanatory intro on autocorrelation times and binning.

MC-01b: remove broken "Read here" placeholder; rewrite the terse "The
headers:" code fragments into proper prose-plus-code sections; expand the
convergence section to explain what checkConvergence does and when to act
on its output; add a Questions section.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR rewrites the English MC-01a (autocorrelations) and MC-01b (equilibration) tutorial pages to fix formatting issues, correct factual errors, and expand the physical explanations.

Changes:

  • Correct code-fence languages (parameter/shell blocks are no longer tagged as Python), fix the task-count text (six tasks for L = 2…48), and drop outdated browser-specific commands.
  • Expand the MC-01a Cluster updates section with full runnable command-line and Python snippets and a physical explanation of critical slowing down ($\tau \sim L^z$).
  • Rewrite MC-01b with a clearer equilibration intro, prose-driven checkSteadyState/checkConvergence walkthroughs, and a new Questions section.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
content/en/tutorials/mcs/mc01a.md Reworks intro, fixes code-fence languages and task counts, drops IE/browser instructions, and expands the cluster-update section with full code and critical-slowing-down explanation.
content/en/tutorials/mcs/mc01b.md Adds equilibration/burn-in intro, consolidates the Python setup block, expands checkSteadyState/checkConvergence discussion, and adds a Questions section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Ooolab

Ooolab commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Could @egull resolve the conflicts? I was confused with "current change" and "incoming change". Did you change the file twice?

@egull

egull commented Jun 1, 2026

Copy link
Copy Markdown
Contributor Author

Closing due to merge conflicts — mc01a.md and mc01b.md were already updated via PRs #47 and #48. Will redo the improvements on top of current main.

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.

4 participants