Welcome to TripodPy’s documentation!

TripodPy is a Python package to simulate the evolution of dust in protoplanetary disks.

This documentation is for TripodPy v1.0.0.

TripodPy simulates the radial evolution of gas and dust in protoplanetary disks, including viscous evolution of the gas, advection and diffusion of the dust, as well as dust growth by an the TriPoD Method.

The TriPoD method has been published in Pfeil et al. 2024.

TriPoDPy has been submitted to the Journal of Open Source Software(JOSS) and is awaiting review. There are currently a number of planned publications using TriPoDPy in the works, so if you plan on using TriPoDPy in your work, consider contacting us to avoid conflicts/duplication of work. We are always happy to collaborate/add new features.

TripodPy requires a Python3 distribution and a Fortran compiler.

TripodPy can be installed via pip after cloning the repository:

pip install .

TripodPy is based on the Simframe framework for scientific simulation (Stammler & Birnstiel 2022).

Please have a look at the Simframe Documentation for details of its usage.

Contents:

• 0. Algorithm
  • Derivation
  • Evolution
  • Step-by-step Summary
• 1. Basic Usage
  • The Simulation Frame
  • Initializing
  • Running a Simulation
  • Plotting
  • Reading data files
  • Reading Dump Files
• 2. Simple Customization
  • Stellar parameters
  • Grid parameters
  • Gas Parameters
  • Dust Parameters
  • Changing the Initial Conditions
  • Changing the Snapshots
  • Changing the Output Directory
• 3. Advanced Customization
  • Customizing the Grids
  • Customizing the Physics of a Field
  • Adding Custom Fields
  • Modifying the Update Order
  • Systoles and Diastoles
  • Customizing the Snapshots
• 4. The Standard Model
  • Dust
  • Gas
  • Components
  • Grid
  • Star
  • Time
  • Integrator
  • Writer
• 5. Compositional Tracking
  • Theory
  • Setting Up a Simulation with Components
  • Default Components
  • Adding Custom Components
  • Evaporating and Condensating Component
• Common pitfalls setting up simulations using components
• Example: Evaporation and Condensation of Multiple Chemical Species
• Module Reference
  • tripodpy Package
  • tripodpy.simulation Module
  • tripodpy.std Package
  • tripodpy.std.dust Module
  • tripodpy.std.gas Module
  • tripodpy.std.compo Module
  • tripodpy.std.sim Module
  • dustpy.utils Package

Indices and tables

• Index

• Module Index

• Search Page