User Guide

This guide provides detailed information on using the quactuary package effectively.

Contents:

• Optimization Overview
  • Quick Decision Guide
  • Available Optimizations
  • Performance vs Accuracy Trade-offs
  • Configuration Examples
  • Industry-Specific Use Cases
  • Next Steps
• Optimization Quick Start
  • Installation
  • Basic Usage
  • Common Scenarios
  • Monitoring Performance
  • Best Practices
  • Common Issues
  • Next Steps
• Optimization Configuration Guide
  • Overview
  • Core Parameters
  • JIT Compilation Parameters
  • Parallel Processing Parameters
  • Memory Management Parameters
  • Vectorization Parameters
  • Quasi-Monte Carlo Parameters
  • User Interface Parameters
  • Configuration Presets
  • Environment Variables
  • Advanced Configuration
  • Next Steps
• Optimization Best Practices
  • General Principles
  • JIT Compilation Best Practices
  • Parallel Processing Best Practices
  • Memory Management Best Practices
  • QMC Best Practices
  • Production Deployment
  • Next Steps
• Numerical Stability Guide
  • Why Numerical Stability Matters
  • Using the Numerical Utilities
  • Best Practices for Specific Calculations
  • Example: Stable Tweedie Implementation
  • Common Pitfalls to Avoid
  • Testing for Numerical Stability
  • Conclusion
• Distribution Parameter Reference
  • Overview
  • Parameter Naming by Distribution Type
  • Migration Guide
  • Best Practices
  • Examples
  • See Also
• Optimization Configuration Guide
  • Overview
  • Quick Start
  • Configuration Options
  • How Auto-Optimization Works
  • Common Optimization Combinations
  • Advanced Usage
  • Performance Guidelines
  • Troubleshooting
  • Best Practices
  • Examples
  • See Also
• Testing Best Practices
  • Tolerance Guidelines
  • Testing Stochastic Methods
  • Hardware-Dependent Tests
  • Numerical Accuracy Testing
  • Integration Test Patterns
  • Common Pitfalls and Solutions
  • Best Practices Summary
  • Example: Complete Test Module
  • See Also
• API Migration Guide
  • Distribution Parameter Changes
  • Optimization API Changes
  • Testing Tolerance Changes
  • Complete Migration Examples
  • Automated Migration Script
  • Troubleshooting
  • Version History
• MCP Server Integration Guide
  • What is MCP?
  • Installation
  • Starting the Server
  • Configuring Claude Desktop
  • Available Tools
  • Usage Examples
  • Best Practices
  • Troubleshooting
  • Advanced Usage
  • Security Considerations
  • Performance Tips
  • Further Resources

Getting Started

The quactuary package provides tools for actuarial loss modeling with both classical and quantum computing backends. Key features include:

• Frequency and severity distributions

• Compound distribution modeling

• Portfolio-based pricing

• Risk measure calculations (VaR, TVaR)

• Performance optimization (JIT, parallel, QMC)

• Quantum computing integration

• MCP Server for LLM integration (Claude, etc.)

Performance Optimization

The quactuary package includes comprehensive optimization features to accelerate Monte Carlo simulations:

• Optimization Overview (Optimization Overview) - Understand available optimization strategies and when to use them

• Quick Start Guide (Optimization Quick Start) - Get started with optimization in minutes

• Configuration Guide (Optimization Configuration Guide) - Detailed reference for all optimization parameters

• Best Practices (Optimization Best Practices) - Learn from real-world optimization patterns

Advanced Topics

Numerical Stability

Working with actuarial calculations often involves extreme values and complex operations. The Numerical Stability Guide guide provides best practices for ensuring accurate results even with challenging numerical conditions.

API Reference

• Distribution Parameters (Distribution Parameter Reference) - Complete reference for all distribution parameter names and conventions

• Optimization Configuration (Optimization Configuration Guide) - Guide to using OptimizationConfig for performance tuning

• API Migration Guide (API Migration Guide) - Migrate from older versions to the current API

Development

• Testing Best Practices (Testing Best Practices) - Write robust tests for stochastic methods and numerical computations

LLM Integration

• MCP Integration Guide (MCP Server Integration Guide) - Use quActuary tools directly in Claude and other LLM assistants via Model Context Protocol

Basic Usage

See the main documentation page for basic usage examples. For optimization-specific examples, refer to the Optimization Quick Start guide.