docs: review documentation updates for 7911e3bd1

[github-actions]

Documentation Update Review

Triggered by commit: 7911e3bd1
Generated: 2026-05-08 16:24 UTC
Compare: b3ae1ed35d2db63f5e6e280589a45696df557b4e...7911e3bd1

Affected Documents

Document	Files Changed	Status
DVC Setup Guide	1 file	✅ Reviewed

All Changed Files in This Commit

Click to expand

pychron/dvc/dvc_persister.py
pychron/experiment/experiment_executor.py
pychron/labspy/client.py
pychron/paths.py

---

DVC Setup Guide {#dvc-setup-guide}

Doc file: docs/dvc_setup_guide.md
Matched prefixes: pychron/dvc/

Changed Files

• pychron/dvc/dvc_persister.py

AI Review

Code Change Summary

The code changes introduce simulation mode protection to the DVC persister by checking globalv.communication_simulation before performing data persistence operations. When simulation mode is active, both post_measurement_save() and save_run_log_file() operations are skipped with warning messages to prevent simulated data from being written to DVC repositories.

Documentation Updates Required

• Section/Topic: Configuration fields and preference paths
  Issue: The communication_simulation global variable is not documented as a configuration option that affects DVC behavior
  Suggested update: Add documentation for the communication_simulation setting, explaining that when set to True, it prevents DVC data persistence operations to avoid contaminating repositories with simulated measurement data

• Section/Topic: Failure modes or troubleshooting section
  Issue: Missing information about simulation mode behavior and the associated warning messages
  Suggested update: Add a note that when running in simulation mode (communication_simulation=True), users will see warning messages about skipping DVC operations, and explain that this is expected behavior to prevent simulated data from being persisted to the actual DVC repositories

• Section/Topic: DVC storage layers or data persistence workflow
  Issue: The documentation may not clearly explain when and how data persistence can be bypassed
  Suggested update: Include information that data persistence to DVC repositories can be conditionally disabled (such as in simulation mode) and that this affects both measurement data saves and run log file saves

---

This file was auto-generated by scripts/doc_audit.py. A human must review and apply any changes to the documentation.