Files
Atomizer/docs/protocols/extensions/EXT_03_CREATE_PROTOCOL.md
Antoine 602560c46a feat: Add MLP surrogate with Turbo Mode for 100x faster optimization
Neural Acceleration (MLP Surrogate):
- Add run_nn_optimization.py with hybrid FEA/NN workflow
- MLP architecture: 4-layer (64->128->128->64) with BatchNorm/Dropout
- Three workflow modes:
  - --all: Sequential export->train->optimize->validate
  - --hybrid-loop: Iterative Train->NN->Validate->Retrain cycle
  - --turbo: Aggressive single-best validation (RECOMMENDED)
- Turbo mode: 5000 NN trials + 50 FEA validations in ~12 minutes
- Separate nn_study.db to avoid overloading dashboard

Performance Results (bracket_pareto_3obj study):
- NN prediction errors: mass 1-5%, stress 1-4%, stiffness 5-15%
- Found minimum mass designs at boundary (angle~30deg, thick~30mm)
- 100x speedup vs pure FEA exploration

Protocol Operating System:
- Add .claude/skills/ with Bootstrap, Cheatsheet, Context Loader
- Add docs/protocols/ with operations (OP_01-06) and system (SYS_10-14)
- Update SYS_14_NEURAL_ACCELERATION.md with MLP Turbo Mode docs

NX Automation:
- Add optimization_engine/hooks/ for NX CAD/CAE automation
- Add study_wizard.py for guided study creation
- Fix FEM mesh update: load idealized part before UpdateFemodel()

New Study:
- bracket_pareto_3obj: 3-objective Pareto (mass, stress, stiffness)
- 167 FEA trials + 5000 NN trials completed
- Demonstrates full hybrid workflow

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-06 20:01:59 -05:00

5.1 KiB

EXT_03: Create New Protocol

Overview

This protocol guides you through creating new protocol documents for the Atomizer Protocol Operating System (POS). Use this when adding significant new system capabilities.

Privilege Required: admin


When to Use

Trigger Action
Adding major new system capability Follow this protocol
"create protocol", "new protocol" Follow this protocol
Need to document architectural pattern Follow this protocol

Protocol Types

Layer Prefix Purpose Example
Operations OP_ How-to guides OP_01_CREATE_STUDY
System SYS_ Core specifications SYS_10_IMSO
Extensions EXT_ Extensibility guides EXT_01_CREATE_EXTRACTOR

Step-by-Step Guide

Step 1: Determine Protocol Type

  • Operations (OP_): User-facing procedures
  • System (SYS_): Technical specifications
  • Extensions (EXT_): Developer guides

Step 2: Assign Protocol Number

Operations: Sequential (OP_01, OP_02, ...) System: By feature area (SYS_10=optimization, SYS_11=multi-obj, etc.) Extensions: Sequential (EXT_01, EXT_02, ...)

Check existing protocols to avoid conflicts.

Step 3: Create Protocol File

Use the template from templates/protocol_template.md:

# {LAYER}_{NUMBER}_{NAME}.md

<!--
PROTOCOL: {Full Name}
LAYER: {Operations|System|Extensions}
VERSION: 1.0
STATUS: Active
LAST_UPDATED: {YYYY-MM-DD}
PRIVILEGE: {user|power_user|admin}
LOAD_WITH: [{dependencies}]
-->

## Overview

{1-3 sentence description of what this protocol does}

---

## When to Use

| Trigger | Action |
|---------|--------|
| {keyword or condition} | Follow this protocol |

---

## Quick Reference

{Tables with key parameters, commands, or mappings}

---

## Detailed Specification

### Section 1: {Topic}

{Content}

### Section 2: {Topic}

{Content}

---

## Examples

### Example 1: {Scenario}

{Complete working example}

---

## Troubleshooting

| Symptom | Cause | Solution |
|---------|-------|----------|
| {error} | {why} | {fix} |

---

## Cross-References

- **Depends On**: [{protocol}]({path})
- **Used By**: [{protocol}]({path})
- **See Also**: [{related}]({path})

---

## Version History

| Version | Date | Changes |
|---------|------|---------|
| 1.0 | {DATE} | Initial release |

Step 4: Write Content

Required Sections:

  1. Overview - What does this protocol do?
  2. When to Use - Trigger conditions
  3. Quick Reference - Fast lookup
  4. Detailed Specification - Full content
  5. Examples - Working examples
  6. Troubleshooting - Common issues
  7. Cross-References - Related protocols
  8. Version History - Changes over time

Writing Guidelines:

  • Front-load important information
  • Use tables for structured data
  • Include complete code examples
  • Provide troubleshooting for common issues

Step 5: Update Navigation

docs/protocols/README.md:

| {NUM} | {Name} | [{Layer}]({layer}/{filename}) |

.claude/skills/01_CHEATSHEET.md:

| {task} | {LAYER}_{NUM} | {key info} |

.claude/skills/02_CONTEXT_LOADER.md: Add loading rules if needed.

Step 6: Update Cross-References

Add references in related protocols:

  • "Depends On" in new protocol
  • "Used By" or "See Also" in existing protocols

Step 7: Validate

# Check markdown syntax
# Verify all links work
# Test code examples
# Ensure consistent formatting

Protocol Metadata

Header Comment Block

<!--
PROTOCOL: Full Protocol Name
LAYER: Operations|System|Extensions
VERSION: Major.Minor
STATUS: Active|Draft|Deprecated
LAST_UPDATED: YYYY-MM-DD
PRIVILEGE: user|power_user|admin
LOAD_WITH: [SYS_10, SYS_11]
-->

Status Values

Status Meaning
Draft In development, not ready for use
Active Production ready
Deprecated Being phased out

Privilege Levels

Level Who Can Use
user All users
power_user Developers who can extend
admin Full system access

Versioning

Semantic Versioning

  • Major (X.0): Breaking changes
  • Minor (1.X): New features, backward compatible
  • Patch (1.0.X): Bug fixes (usually omit for docs)

Version History Format

| Version | Date | Changes |
|---------|------|---------|
| 2.0 | 2025-12-15 | Redesigned architecture |
| 1.1 | 2025-12-05 | Added neural support |
| 1.0 | 2025-11-20 | Initial release |

Troubleshooting

Issue Cause Solution
Protocol not found Wrong path Check location and README
LLM not loading Missing from context loader Update 02_CONTEXT_LOADER.md
Broken links Path changed Update cross-references

Cross-References

  • Template: templates/protocol_template.md
  • Navigation: docs/protocols/README.md
  • Context Loading: .claude/skills/02_CONTEXT_LOADER.md

Version History

Version Date Changes
1.0 2025-12-05 Initial release