feat: Major update - Physics docs, Zernike OPD, insights, NX journals, tools
Documentation: - Add docs/06_PHYSICS/ with Zernike fundamentals and OPD method docs - Add docs/guides/CMA-ES_EXPLAINED.md optimization guide - Update CLAUDE.md and ATOMIZER_CONTEXT.md with current architecture - Update OP_01_CREATE_STUDY protocol Planning: - Add DYNAMIC_RESPONSE plans for random vibration/PSD support - Add OPTIMIZATION_ENGINE_MIGRATION_PLAN for code reorganization Insights System: - Update design_space, modal_analysis, stress_field, thermal_field insights - Improve error handling and data validation NX Journals: - Add analyze_wfe_zernike.py for Zernike WFE analysis - Add capture_study_images.py for automated screenshots - Add extract_expressions.py and introspect_part.py utilities - Add user_generated_journals/journal_top_view_image_taking.py Tests & Tools: - Add comprehensive Zernike OPD test suite - Add audit_v10 tests for WFE validation - Add tools for Pareto graphs and mirror data extraction - Add migrate_studies_to_topics.py utility Knowledge Base: - Initialize LAC (Learning Atomizer Core) with failure/success patterns Dashboard: - Update Setup.tsx and launch_dashboard.py - Add restart-dev.bat helper script 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -71,6 +71,71 @@ When creating a new study:
|
||||
|
||||
---
|
||||
|
||||
## README Hierarchy (Parent-Child Documentation)
|
||||
|
||||
**Two-level documentation system**:
|
||||
|
||||
```
|
||||
studies/{geometry_type}/
|
||||
├── README.md # PARENT: Project-level context
|
||||
│ ├── Project overview # What is this geometry/component?
|
||||
│ ├── Physical system specs # Material, dimensions, constraints
|
||||
│ ├── Optical/mechanical specs # Domain-specific requirements
|
||||
│ ├── Design variables catalog # ALL possible variables with descriptions
|
||||
│ ├── Objectives catalog # ALL possible objectives
|
||||
│ ├── Campaign history # Summary of all sub-studies
|
||||
│ └── Sub-studies index # Links to each sub-study
|
||||
│
|
||||
├── sub_study_V1/
|
||||
│ └── README.md # CHILD: Study-specific details
|
||||
│ ├── Link to parent # "See ../README.md for context"
|
||||
│ ├── Study focus # What THIS study optimizes
|
||||
│ ├── Active variables # Which params enabled
|
||||
│ ├── Algorithm config # Sampler, trials, settings
|
||||
│ ├── Baseline/seeding # Starting point
|
||||
│ └── Results summary # Best trial, learnings
|
||||
│
|
||||
└── sub_study_V2/
|
||||
└── README.md # CHILD: References parent, adds specifics
|
||||
```
|
||||
|
||||
### Parent README Content (Geometry-Level)
|
||||
|
||||
| Section | Content |
|
||||
|---------|---------|
|
||||
| Project Overview | What the component is, purpose, context |
|
||||
| Physical System | Material, mass targets, loading conditions |
|
||||
| Domain Specs | Optical prescription (mirrors), structural limits (brackets) |
|
||||
| Design Variables | Complete catalog with ranges and descriptions |
|
||||
| Objectives | All possible metrics with formulas |
|
||||
| Campaign History | Evolution across sub-studies |
|
||||
| Sub-Studies Index | Table with links, status, best results |
|
||||
| Technical Notes | Domain-specific implementation details |
|
||||
|
||||
### Child README Content (Study-Level)
|
||||
|
||||
| Section | Content |
|
||||
|---------|---------|
|
||||
| Parent Reference | `> See [../README.md](../README.md) for project context` |
|
||||
| Study Focus | What differentiates THIS study |
|
||||
| Active Variables | Which parameters are enabled (subset of parent catalog) |
|
||||
| Algorithm Config | Sampler, n_trials, sigma, seed |
|
||||
| Baseline | Starting point (seeded from prior study or default) |
|
||||
| Results | Best trial, improvement metrics |
|
||||
| Key Learnings | What was discovered |
|
||||
|
||||
### When to Create Parent README
|
||||
|
||||
- **First study** for a geometry type → Create parent README immediately
|
||||
- **Subsequent studies** → Add to parent's sub-studies index
|
||||
- **New geometry type** → Create both parent and child READMEs
|
||||
|
||||
### Example Reference
|
||||
|
||||
See `studies/M1_Mirror/README.md` for a complete parent README example.
|
||||
|
||||
---
|
||||
|
||||
## Detailed Steps
|
||||
|
||||
### Step 1: Gather Requirements
|
||||
|
||||
Reference in New Issue
Block a user