Files
Atomizer/docs/archive/historical/QUICK_CONFIG_REFERENCE.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

82 lines
1.5 KiB
Markdown

# Quick Configuration Reference
## Change NX Version (e.g., when NX 2506 is released)
**Edit ONE file**: [`config.py`](../config.py)
```python
# Line 14-15
NX_VERSION = "2506" # ← Change this
NX_INSTALLATION_DIR = Path(f"C:/Program Files/Siemens/NX{NX_VERSION}")
```
**That's it!** All modules automatically use new paths.
---
## Change Python Environment
**Edit ONE file**: [`config.py`](../config.py)
```python
# Line 49
PYTHON_ENV_NAME = "my_new_env" # ← Change this
```
---
## Verify Configuration
```bash
python config.py
```
Output shows all paths and validates they exist.
---
## Using Config in Your Code
```python
from config import (
NX_RUN_JOURNAL, # Path to run_journal.exe
NX_MATERIAL_LIBRARY, # Path to material library XML
PYTHON_ENV_NAME, # Current environment name
get_nx_journal_command, # Helper function
)
# Generate journal command
cmd = get_nx_journal_command(
journal_script,
arg1,
arg2
)
```
---
## What Changed?
**OLD** (hardcoded paths in multiple files):
- `optimization_engine/nx_updater.py`: Line 66
- `dashboard/api/app.py`: Line 598
- `README.md`: Line 92
- `docs/NXOPEN_INTELLISENSE_SETUP.md`: Line 269
- ...and more
**NEW** (all use `config.py`):
- Edit `config.py` once
- All files automatically updated
---
## Files Using Config
-`optimization_engine/nx_updater.py`
-`dashboard/api/app.py`
- Future: All NX-related modules will use config
---
**See also**: [SYSTEM_CONFIGURATION.md](SYSTEM_CONFIGURATION.md) for full documentation