-
Notifications
You must be signed in to change notification settings - Fork 0
Learning Instructor Guide
github-actions[bot] edited this page Jun 23, 2026
·
1 revision
Use this guide to teach CaeReflex in workshops, onboarding sessions, or academic modules.
A successful session should help learners:
- operate CaeReflex from the CLI;
- interpret structured evidence and warnings;
- explain the safe-use boundary;
- choose the right output for humans, agents, or APIs; and
- understand where developer extensions belong.
| Time | Activity |
|---|---|
| 0-10 min | Explain CaeReflex, ReflexCase, and the safety boundary |
| 10-30 min | Run CLI-first Inspection |
| 30-45 min | Compare caereflex.json, agent_context.json, and Markdown report |
| 45-55 min | Write a safe summary and identify human follow-up checks |
| 55-60 min | Review common mistakes |
- Environment setup.
- CLI-first inspection.
- One domain project: Gmsh, OpenFOAM, or VTK.
- CrossRef literature context with mock data.
- Assessment discussion.
- CLI-first inspection.
- OpenFOAM case review.
- VTK result context.
- CrossRef literature context.
- REST/OpenAPI agent workflow.
- Adapter extension design.
- Group critique using the assessment rubric.
- Treating inspection as validation.
- Ignoring warnings because a command exited successfully.
- Giving agents full local paths instead of workspace-relative paths.
- Using live CrossRef calls when deterministic mock data is better for teaching.
- Forgetting to explain what a qualified engineer still needs to review.
Ask:
- Which facts were extracted from files?
- Which statements are assumptions?
- Which warnings matter most to a reviewer?
- Which output would you give to a human? Which to an agent?
- What would be an unsafe claim?
- Confirm CaeReflex installs in the teaching environment.
- Run
caereflex examples list. - Run the CLI-first project once before class.
- Keep the safe-use policy visible during discussion.
- Use mock CrossRef responses for deterministic results.
- Decide whether REST/OpenAPI work is included or optional.
- Home
- Architecture
- Developer-Guide
- Learning
- Reference
- Releases
- User-Guide
Synced from /wiki/docs in the main CaeReflex repository.