Welcome to DebrisPy

DebrisPy is a Python package for modelling the surface-density structure of eccentric debris discs using a semi-analytic formalism.

Based on the framework presented in Rafikov (2023), DebrisPy computes azimuthally averaged surface-density profiles, \(\bar{\Sigma}(r)\), from prescribed distributions of semi-major axis and orbital eccentricity.

The package is designed for forward-modelling debris-disc structures and for exploring how eccentric parent-body distributions map into observable radial surface-density profiles.

Key features

• Compute and visualise azimuthally averaged surface-density profiles, \(\bar{\Sigma}(r)\), from input \(\Sigma_a(a)\) and \(\psi(e,a)\) profiles.

• Support both deterministic eccentricity profiles, \(e(a)\), and full eccentricity distributions, \(\psi(e,a)\).

• Define built-in or user-supplied semi-major-axis and eccentricity profiles.

• Construct eccentricity kernels and evaluate the corresponding ASD integral.

• Perform Monte Carlo sampling as an independent check of the semi-analytic calculation.

• Generate 1D radial profiles and 2D surface-density realisations.

• Use optional adaptive gridding, interpolation, and parallelisation for more demanding calculations.

Documentation contents

Getting Started

• Quick Start Guide
• Theoretical Framework
• Package Design

Package Structure

• Using the SigmaA Class
• Unique Eccentricity Profiles
• Built-In Eccentricity Distributions
• Custom Eccentricity Distribution
• Using the Kernel Class
• The ASD Class
• Monte Carlo Sampling

Additional Information

• Benchmarking
• API Reference

Contact

This package was developed and is maintained by Deniz Akansoy.

For questions, feedback, or suggestions, please open an issue on GitHub or contact Deniz Akansoy at da619@cam.ac.uk.