.. Wind-AE documentation master file, created by sphinx-quickstart on Tue Aug 19 03:18:05 2025. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Wind-AE Overview =================================== **Wind-AE** (pronounced /windy/) stands for "wind atmospheric escape" and is a relatively fast 1D, steady-state, hydrodynamic, non-isothermal, Parker wind relaxation code for modeling atmospheric escape based on `Murray-Clay et al. (2009) `_ . **Wind-AE** is a forward model that solves the energy conservation, momentum conservation, and ionization equilibrium equations at the substellar point using the `Numerical Recipes in C `_ relaxation method. This allows **Wind-AE** to quickly compute the atmosphere mass loss rate as well as upper atmosphere (:math:`\gtrsim 100` microbar) velocity, temperature, density, and ionization structure as a function of altitude. **Wind-AE** updates `Murray-Clay et al. (2009) `_ to allow for the modeling of atomic metals and multifrequency XUV stellar spectra (`Broome et al. (2025) `_). As a relaxation code, **Wind-AE** runs quickly, but the relaxation method is sensitive to having a good initial guess for the solution in order to numerically converge to the final solution. With that in mind, we provide a number of starting points for simulations in the ``saves/`` folder and include a python wrapper (:ref:`relax_wind`) which handles ramping from the initial guess to the goal solution. If you use **Wind-AE**, please consider citing `Broome et al. (2025) `_. .. note:: This project is under active development. Please report any bugs via `Github `_ or via email to mabroome@ucsc.edu and we appreciate your patience as we roll out changes. Check out the :doc:`usage` section for further information, including instructions on :ref:`installation` of the project. Contents -------- .. toctree:: :maxdepth: 2 :caption: Contents: self usage.rst installation.rst Quickstart relax_wind.rst windsoln.rst additional_modules.rst Indices and Tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`