Welcome to Wakeflow’s documentation!

Contents

• Overview
  • Installation
  • Usage
  • Testing
  • Contributing
  • License
  • Citing
  • Getting Help
  • Contact
  • Acknowledgments
• Quickstart Tutorial
  • Model Setup and Configuration
  • Running the Model
  • Results Format
  • Reading Results and Visualisation
• Using Wakeflow with MCFOST
  • Prerequisites
  • Required Parameters
  • Running Wakeflow
  • Running MCFOST
  • Extra Integrations
• Advanced Configuration
  • Configuring model from .yaml file
  • Configuring model from dictionary
  • Configuring developer parameters

Reference

• Wakeflow Parameters
  • Model Parameters
  • MCFOST Interface Parameters
  • Developer Parameters
• Disk Structure
  • Temperature
  • Density
  • Velocities
  • Surface Density

API Docs

• Wakeflow User API
  • Module contents
  • Wakeflow module
• Spiralmoments User API
  • Sub-module contents
  • Spiralmoments sub-module
• Wakeflow Dev API
  • wakeflow.burgers
  • wakeflow.grid
  • wakeflow.linear_perts
  • wakeflow.mcfost_interface
  • wakeflow.model_setup
  • wakeflow.non_linear_perts
  • wakeflow.transformations

Indices and tables

• Index

• Module Index

• Search Page