How pluvium27/heurams works
HeurAMS is a heuristic spaced-repetition scheduler and TUI learning tool. The documented user path is to launch the TUI, navigate memory repositories, work through scheduled review and new-memory stages, and complete recall puzzles; the kernel routes review sessions and applies scheduling algorithms. The interface also exposes repository synchronization, settings, favorites, and audio precaching. Several screen implementations and repository-loading paths were not excerpted, so those links are omitted or marked unverified rather than inferred.
Main entry points: router.py Stage router · dashboard.py Dashboard · repo.py Memory repositories · procession.py Review procession
Components 25
Application interface
- CLI entry
src/heurams/__main__.py - TUI app
src/heurams/interface/__init__.py - Dashboard
src/heurams/interface/screens/dashboard.py - Repository navigation
src/heurams/interface/screens/navigator.py - Session preparation
src/heurams/interface/screens/preparation.py - Review queue
src/heurams/interface/screens/memoqueue.py - Puzzle widgets
src/heurams/interface/widgets/base_puzzle_widget.py - Repository sync
src/heurams/interface/screens/synctool.py - Settings
src/heurams/interface/screens/setting.py - Audio precaching
src/heurams/interface/screens/precache.py
Memory content
- Memory repositories
src/heurams/kernel/repolib/repo.py - Memory records
src/heurams/kernel/particles/atom.py - Recall puzzles
src/heurams/kernel/puzzles/mcq.py - Review state
src/heurams/kernel/particles/electron.py
Review engine
- Stage router
src/heurams/kernel/reactor/router.py - Review procession
src/heurams/kernel/reactor/procession.py - Prompt expansion
src/heurams/kernel/reactor/expander.py - Session states
src/heurams/kernel/reactor/states.py - Scheduling algorithms
src/heurams/kernel/algorithms/base.py
Supporting services
- Runtime context
src/heurams/context.py - Configuration
src/heurams/services/config.py - Favorites
src/heurams/services/favorite_service.py - Text-to-speech service
src/heurams/services/tts_service.py - TTS providers
src/heurams/providers/tts/edge_tts.py
Other components
- Learner
Connections 25
- Learner → CLI entry: runs
README.md - CLI entry → TUI app: launches
src/heurams/__main__.py - TUI app → Dashboard: opens
src/heurams/interface/__init__.py - Dashboard → Repository navigation: opens
src/heurams/interface/screens/dashboard.py - Dashboard → Session preparation: opens
src/heurams/interface/screens/dashboard.py - Repository navigation → Memory repositories: browses
- Session preparation → Stage router: starts session
- Review queue → Stage router: requests stage
- Stage router → Review procession: creates queues
src/heurams/kernel/reactor/router.py - Stage router → Session states: sets state
src/heurams/kernel/reactor/router.py - Review procession → Prompt expansion: calls
src/heurams/kernel/reactor/procession.py - Review procession → Session states: reads state
src/heurams/kernel/reactor/procession.py - Prompt expansion → Memory records: uses records
src/heurams/kernel/reactor/expander.py - Prompt expansion → Recall puzzles: creates puzzles
src/heurams/kernel/reactor/expander.py - Puzzle widgets → Recall puzzles: renders
- Stage router → Memory records: routes records
src/heurams/kernel/reactor/router.py - Memory records → Review state: contains state
- Review state → Scheduling algorithms: uses algorithms
src/heurams/kernel/particles/electron.py - Dashboard → Memory repositories: loads repositories
src/heurams/interface/screens/dashboard.py - Repository sync → Memory repositories: synchronizes
- Settings → Runtime context: reads context
src/heurams/interface/screens/setting.py - Runtime context → Configuration: initializes
src/heurams/context.py - Audio precaching → Memory repositories: reads content
src/heurams/interface/screens/precache.py - Audio precaching → Text-to-speech service: requests speech
src/heurams/interface/screens/precache.py - Text-to-speech service → TTS providers: selects provider
src/heurams/services/tts_service.py