How chrisswdavis/animaire-public works
Main Components and Architecture
The system should be represented as a layered architecture with the following main components:
a) User Interface Layer:
• Entry point through AniMAIRE.py
• Example notebooks (AniMAIRE_examples.ipynb)
• Plotting utilities (dose_plotting.py)
b) Core Processing Layer:
• Anisotropic MAIRE Engine
• Spectral Calculations Module
• Asymptotic Direction Processing
c) Data Layer:
• Response data files (NM64 responses)
• Cached magnetocosmics runs
• Investigation data
d) External Dependencies:
• MAGNETOCOSMICS (required external component)
• Python scientific stack (numpy, pandas, etc.)
Component Relationships
[User Input] → [AniMAIRE Interface]
• ↓
[Anisotropic MAIRE Engine] ←→ [MAGNETOCOSMICS]
• ↓ ↓
[Spectral Calculations] ←→ [Asymptotic Direction Processing]
• ↓
[Response Data] → [Dose Rate Calculations]
• ↓
[Output & Visualization]
Detailed Component Specifications
a) AniMAIRE Interface:
• Input handlers for spectra, pitch angles, and coordinates
• Configuration management
• Run orchestration
b) Anisotropic MAIRE Engine:
• generalEngineInstance
• singleParticleEngineInstance
• Integration with MAGNETOCOSMICS
c) Spectral Calculations:
• Momenta Distribution
• Particle Distribution
• Pitch Angle Distribution
• Rigidity Spectrum
d) Data Processing:
• Response table handling
• Cache management
• Results formatting
Key Interactions to Highlight
• Data flow between MAGNETOCOSMICS and the core engine
• Caching mechanism for magnetocosmics runs
• Spectral calculation pipeline
• Response data integration
• Output generation and visualization flow
Implementation Notes
• Linux-only compatibility
• MAGNETOCOSMICS dependency requirement
• Caching behavior for performance optimization
• Supported input/output formats
• Key configuration parameters