Neutryx Core Documentation¶
Welcome to the comprehensive documentation for Neutryx Core — the JAX-powered quantitative finance platform for derivatives pricing, risk management, and regulatory compliance.
Quick Navigation¶
🚀 Getting Started¶
Start your journey with Neutryx Core:
- Getting Started Guide - Installation, first examples, and quick wins
- Overview - Vision, architecture, and core capabilities
- Tutorials - Hands-on tutorials from beginner to advanced
📚 Core Documentation¶
Fundamentals¶
- Architecture Guide - System design, patterns, and components
- API Reference - Complete API documentation
- Products Guide - Multi-asset class derivatives
Operational Guides¶
- Performance Tuning - Optimization strategies and best practices
- Troubleshooting - Common issues and solutions
- Configuration - System configuration reference
- Deployment - Production deployment guide
Infrastructure¶
- Market Data - Real-time data feeds, storage, and validation
- Monitoring & Observability - Metrics, tracing, and alerting
- CI/CD Pipeline - Continuous integration and deployment
💼 Use Case Guides¶
Pricing & Valuation¶
- Valuations Index - XVA framework overview
- Valuations Quick Start - Get started in 5 minutes
- Comprehensive Valuations Guide - Full XVA documentation
- Valuations API - API reference
Risk Management¶
- Risk Analytics - VaR, stress testing, and limits
- Risk Tutorials - Hands-on risk management
- Risk Reference - Comprehensive risk documentation
- Risk Controls - Position limits and pre-trade controls
Model Calibration¶
- Calibration Overview - Calibration framework
- Calibration Tutorials - Step-by-step guides
- Calibration Reference - Advanced techniques
- Model Selection - Best practices
Models & Pricing¶
- Models Overview - Available models (BS, Heston, SABR)
- Model Tutorials - Model implementation guides
- Model Reference - Detailed model documentation
🔬 Advanced Topics¶
Theory & Mathematics¶
- Mathematical Foundations - Core mathematics
- Pricing Models - Model theory and derivations
- Numerical Methods - PDE solvers, MC methods
- Calibration Theory - Parameter estimation theory
Integration & Extensions¶
- FpML Integration - Financial product markup language
- Trade Management - Trade lifecycle management
- Orchestration - Workflow orchestration
👨💻 For Developers¶
- Developer Guide - Contributing, coding standards, testing
- Design Decisions - Architecture and design rationale
- Roadmap - Development roadmap and milestones
- References - Academic papers and resources
📊 Project Information¶
Documentation¶
- Documentation Index - Jupyter notebooks and examples
- Test Coverage - Code coverage reports
- Security Audit - Security analysis and best practices
Project Management¶
- Changelog - Version history and changes
- Release Checklist - Release process
- Codebase Exploration - Code analysis
Featured Documentation¶
Valuations & XVA Framework¶
Comprehensive derivatives valuation, XVA calculations, risk management, and regulatory compliance:
- XVA Components: CVA, DVA, FVA, MVA, KVA
- Risk Metrics: VaR, Expected Shortfall (CVaR), Greeks
- Exposure Analytics: EE, PFE, EPE profiles
- Initial Margin: ISDA SIMM methodology
- Stress Testing: Scenario analysis and historical scenarios
- Wrong-Way Risk: Advanced correlation modeling
- P&L Attribution: Daily explain and factor attribution
Quick Links: - Valuations Quick Start - 5-minute setup - Comprehensive Guide - Full documentation - API Reference - Complete API
Risk Management Framework¶
Enterprise risk analytics with multiple VaR methodologies and position controls:
- VaR Methodologies: Historical, Monte Carlo, parametric VaR, ES/CVaR
- Component Risk: Incremental VaR, component VaR, marginal VaR
- Position Limits: Notional, VaR, concentration, issuer exposure limits
- Pre-Trade Controls: Real-time limit checking, what-if analysis, approval workflows
- Stress Testing: Historical scenarios, hypothetical scenarios, reverse stress testing
Quick Links: - Risk Overview - Framework introduction - Risk Controls Atlas - Comprehensive guide - Risk Tutorials - Hands-on learning
Market Data Infrastructure¶
Production-grade real-time market data pipeline:
- Vendor Integration: Bloomberg Terminal/API, Refinitiv RDP/Eikon
- Storage Solutions: PostgreSQL, MongoDB, TimescaleDB with 90% compression
- Data Quality: Price validation, spread checks, volume spike detection, quality scoring
- Feed Management: Real-time orchestration, automatic failover, buffering
Quick Links: - Market Data Guide - Complete documentation
Observability & Monitoring¶
Enterprise observability stack for production deployments:
- Metrics: Prometheus with custom business metrics
- Dashboards: Pre-built Grafana dashboards (overview, performance, risk)
- Tracing: OpenTelemetry + Jaeger distributed tracing
- Profiling: Automatic performance profiling with cProfile
- Alerting: Intelligent alerts with configurable thresholds
Quick Links: - Monitoring Guide - Setup and configuration - Observability Guide - Best practices
Learning Paths¶
For Quantitative Analysts¶
- Getting Started - Setup and basics
- Tutorials - Pricing and risk examples
- Valuations Guide - XVA framework
- Model Reference - Model documentation
For Risk Managers¶
- Getting Started - Installation
- Risk Overview - Risk framework
- Risk Controls - Limits and controls
- Risk Tutorials - Practical examples
For Developers¶
- Developer Guide - Setup and standards
- Architecture Guide - System design
- Performance Tuning - Optimization
- Troubleshooting - Common issues
For System Administrators¶
- Deployment Guide - Production setup
- Configuration - System configuration
- Monitoring - Observability stack
- Troubleshooting - Operations guide
Quick Start Example¶
Get pricing in 60 seconds:
import jax.numpy as jnp
from neutryx.models.bs import price, greeks
# Price a European call option
call_price = price(
spot=100.0,
strike=100.0,
maturity=1.0,
risk_free=0.05,
dividend=0.02,
volatility=0.20,
option_type="call"
)
# Calculate Greeks
delta, gamma, vega, theta, rho = greeks(
100.0, 100.0, 1.0, 0.05, 0.02, 0.20, "call"
)
print(f"Call Price: ${call_price:.4f}")
print(f"Delta: {delta:.4f}")
Next Steps: Getting Started Guide
Support & Community¶
- Documentation: You're here!
- GitHub Repository: neutryx-lab/neutryx-core
- Issues: Report bugs or request features
- Discussions: Ask questions and share ideas
- Website: neutryx.tech
License¶
Neutryx Core is released under the MIT License. See LICENSE for details.
Built for Investment Banks, Hedge Funds, and Quantitative Researchers
Accelerating quantitative finance with differentiable computing and enterprise-grade infrastructure