Antoine/Atomizer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
0c252e3a65ad7431d2912970fb9b43cf30e8c12c
Atomizer/docs/00_INDEX.md
Anto01 ea437d360e docs: Major documentation overhaul - restructure folders, update tagline, add Getting Started guide 
- Restructure docs/ folder (remove numeric prefixes):
  - 04_USER_GUIDES -> guides/
  - 05_API_REFERENCE -> api/
  - 06_PHYSICS -> physics/
  - 07_DEVELOPMENT -> development/
  - 08_ARCHIVE -> archive/
  - 09_DIAGRAMS -> diagrams/

- Replace tagline 'Talk, don't click' with 'LLM-driven optimization framework' in 9 files

- Create comprehensive docs/GETTING_STARTED.md:
  - Prerequisites and quick setup
  - Project structure overview
  - First study tutorial (Claude or manual)
  - Dashboard usage guide
  - Neural acceleration introduction

- Rewrite docs/00_INDEX.md with correct paths and modern structure

- Archive obsolete files:
  - 01_PROTOCOLS.md -> archive/historical/01_PROTOCOLS_legacy.md
  - 03_GETTING_STARTED.md -> archive/historical/
  - ATOMIZER_PODCAST_BRIEFING.md -> archive/marketing/

- Update timestamps to 2026-01-20 across all key files

- Update .gitignore to exclude docs/generated/

- Version bump: ATOMIZER_CONTEXT v1.8 -> v2.0
2026-01-20 10:03:45 -05:00

221 lines
7.2 KiB
Markdown
Raw Blame History

# Atomizer Documentation Index
**Last Updated**: 2026-01-20
**Project Version**: 1.0.0 (AtomizerSpec v2.0 - Full LLM Integration)
---
## Quick Start
New to Atomizer? Start here:
1. **[README.md](../README.md)** - Project overview and philosophy
2. **[Getting Started](GETTING_STARTED.md)** - Installation, first study, dashboard
3. **[Protocol System](protocols/README.md)** - How Atomizer is organized
4. **[Example Studies](../studies/)** - Working examples
---
## Documentation Structure
### Core Documentation
| Document | Purpose |
|----------|---------|
| **[GETTING_STARTED.md](GETTING_STARTED.md)** | Setup, first study, dashboard basics |
| **[ARCHITECTURE.md](ARCHITECTURE.md)** | System architecture, hooks, data flow |
| **[protocols/README.md](protocols/README.md)** | Protocol Operating System overview |
### Protocol System
The Protocol Operating System (POS) provides structured workflows:
```
protocols/
├── README.md # Protocol system overview
├── operations/ # How-to guides (OP_01-08)
│ ├── OP_01_CREATE_STUDY.md
│ ├── OP_02_RUN_OPTIMIZATION.md
│ ├── OP_03_MONITOR_PROGRESS.md
│ ├── OP_04_ANALYZE_RESULTS.md
│ ├── OP_05_EXPORT_TRAINING_DATA.md
│ ├── OP_06_TROUBLESHOOT.md
│ ├── OP_07_DISK_OPTIMIZATION.md
│ └── OP_08_GENERATE_REPORT.md
├── system/ # Technical specifications (SYS_10-18)
│ ├── SYS_10_IMSO.md # Intelligent optimization
│ ├── SYS_11_MULTI_OBJECTIVE.md
│ ├── SYS_12_EXTRACTOR_LIBRARY.md
│ ├── SYS_13_DASHBOARD_TRACKING.md
│ ├── SYS_14_NEURAL_ACCELERATION.md
│ ├── SYS_15_METHOD_SELECTOR.md
│ ├── SYS_16_SELF_AWARE_TURBO.md
│ ├── SYS_17_STUDY_INSIGHTS.md
│ └── SYS_18_CONTEXT_ENGINEERING.md
└── extensions/ # Extensibility (EXT_01-04)
├── EXT_01_CREATE_EXTRACTOR.md
├── EXT_02_CREATE_HOOK.md
├── EXT_03_CREATE_PROTOCOL.md
└── EXT_04_CREATE_SKILL.md
```
### User Guides
Located in `guides/`:
| Guide | Purpose |
|-------|---------|
| **[CANVAS.md](guides/CANVAS.md)** | Visual study builder (AtomizerSpec v2.0) |
| **[DASHBOARD.md](guides/DASHBOARD.md)** | Dashboard overview and features |
| **[NEURAL_FEATURES_COMPLETE.md](guides/NEURAL_FEATURES_COMPLETE.md)** | Neural acceleration guide |
| **[NEURAL_WORKFLOW_TUTORIAL.md](guides/NEURAL_WORKFLOW_TUTORIAL.md)** | Data → Training → Optimization |
| **[hybrid_mode.md](guides/hybrid_mode.md)** | Hybrid FEA/NN optimization |
| **[TRAINING_DATA_EXPORT_GUIDE.md](guides/TRAINING_DATA_EXPORT_GUIDE.md)** | Exporting data for neural training |
### API Reference
Located in `api/`:
| Document | Purpose |
|----------|---------|
| **[system_configuration.md](api/system_configuration.md)** | Configuration format reference |
| **[nx_integration.md](api/nx_integration.md)** | NX Open API integration |
| **[GNN_ARCHITECTURE.md](api/GNN_ARCHITECTURE.md)** | Graph Neural Network details |
| **[NXOPEN_RESOURCES.md](api/NXOPEN_RESOURCES.md)** | NX Open documentation resources |
### Physics Documentation
Located in `physics/`:
| Document | Purpose |
|----------|---------|
| **[ZERNIKE_FUNDAMENTALS.md](physics/ZERNIKE_FUNDAMENTALS.md)** | Zernike polynomial basics |
| **[ZERNIKE_OPD_METHOD.md](physics/ZERNIKE_OPD_METHOD.md)** | OPD method for mirror optimization |
### Development
Located in `development/`:
| Document | Purpose |
|----------|---------|
| **[DEVELOPMENT_GUIDANCE.md](development/DEVELOPMENT_GUIDANCE.md)** | Development guidelines |
| **[DEVELOPMENT_ROADMAP.md](development/DEVELOPMENT_ROADMAP.md)** | Future plans |
| **[Philosophy.md](development/Philosophy.md)** | Design philosophy |
### Diagrams
Located in `diagrams/`:
| Document | Purpose |
|----------|---------|
| **[architecture_overview.md](diagrams/architecture_overview.md)** | System architecture diagrams |
| **[protocol_workflows.md](diagrams/protocol_workflows.md)** | Protocol execution flows |
---
## Documentation by Task
### Creating Studies
1. **[GETTING_STARTED.md](GETTING_STARTED.md)** - First study tutorial
2. **[OP_01_CREATE_STUDY.md](protocols/operations/OP_01_CREATE_STUDY.md)** - Detailed creation protocol
3. **[guides/CANVAS.md](guides/CANVAS.md)** - Visual study builder
### Running Optimizations
1. **[OP_02_RUN_OPTIMIZATION.md](protocols/operations/OP_02_RUN_OPTIMIZATION.md)** - Run protocol
2. **[SYS_10_IMSO.md](protocols/system/SYS_10_IMSO.md)** - Intelligent optimization
3. **[SYS_15_METHOD_SELECTOR.md](protocols/system/SYS_15_METHOD_SELECTOR.md)** - Method selection
### Neural Acceleration
1. **[guides/NEURAL_FEATURES_COMPLETE.md](guides/NEURAL_FEATURES_COMPLETE.md)** - Overview
2. **[SYS_14_NEURAL_ACCELERATION.md](protocols/system/SYS_14_NEURAL_ACCELERATION.md)** - Technical spec
3. **[guides/NEURAL_WORKFLOW_TUTORIAL.md](guides/NEURAL_WORKFLOW_TUTORIAL.md)** - Step-by-step
### Analyzing Results
1. **[OP_04_ANALYZE_RESULTS.md](protocols/operations/OP_04_ANALYZE_RESULTS.md)** - Analysis protocol
2. **[SYS_17_STUDY_INSIGHTS.md](protocols/system/SYS_17_STUDY_INSIGHTS.md)** - Physics visualizations
### Troubleshooting
1. **[OP_06_TROUBLESHOOT.md](protocols/operations/OP_06_TROUBLESHOOT.md)** - Troubleshooting guide
2. **[GETTING_STARTED.md#troubleshooting](GETTING_STARTED.md#troubleshooting)** - Common issues
---
## Quick Reference
### Protocol Summary
| Protocol | Name | Purpose |
|----------|------|---------|
| **OP_01** | Create Study | Study creation workflow |
| **OP_02** | Run Optimization | Execution workflow |
| **OP_03** | Monitor Progress | Real-time monitoring |
| **OP_04** | Analyze Results | Results analysis |
| **OP_06** | Troubleshoot | Debugging issues |
| **SYS_10** | IMSO | Intelligent optimization |
| **SYS_12** | Extractors | Physics extraction library |
| **SYS_14** | Neural | Neural network acceleration |
### Essential Commands
```bash
# Activate environment
conda activate atomizer
# Run optimization
python run_optimization.py --start --trials 50
# Resume interrupted run
python run_optimization.py --start --resume
# Start dashboard
python launch_dashboard.py
# Neural turbo mode
python run_nn_optimization.py --turbo --nn-trials 5000
```
### Key Extractors
| ID | Physics | Function |
|----|---------|----------|
| E1 | Displacement | `extract_displacement()` |
| E2 | Frequency | `extract_frequency()` |
| E3 | Stress | `extract_solid_stress()` |
| E4 | Mass (BDF) | `extract_mass_from_bdf()` |
| E5 | Mass (CAD) | `extract_mass_from_expression()` |
| E22 | Zernike OPD | `extract_zernike_opd()` |
Full catalog: [SYS_12_EXTRACTOR_LIBRARY.md](protocols/system/SYS_12_EXTRACTOR_LIBRARY.md)
---
## Archive
Historical documents are preserved in `archive/`:
- `archive/historical/` - Legacy documents, old protocols
- `archive/marketing/` - Briefings, presentations
- `archive/session_summaries/` - Past development sessions
---
## LLM Resources
For Claude/AI integration:
| Resource | Purpose |
|----------|---------|
| **[../CLAUDE.md](../CLAUDE.md)** | System instructions |
| **[../.claude/ATOMIZER_CONTEXT.md](../.claude/ATOMIZER_CONTEXT.md)** | Session context |
| **[../.claude/skills/](../.claude/skills/)** | Skill modules |
---
**Last Updated**: 2026-01-20
**Maintained By**: Antoine / Atomaste
Reference in New Issue View Git Blame Copy Permalink