Skip to content

Latest commit

 

History

History
53 lines (45 loc) · 2.39 KB

index.rst

File metadata and controls

53 lines (45 loc) · 2.39 KB

p-winds: Documentation

GitHub Documentation Status Build Coverage DOI

p-winds is an open-source Python implementation of Parker wind models for planetary atmospheres, more specifically their upper atmosphere or corona. A paper describing p-winds was published in Dos Santos et al. (2022). The code is largely based on the theoretical framework of Oklopčić & Hirata (2018) and Lampón et al. (2020), which themselves based their work on the stellar wind model of Parker (1958).

In the current version, the code solves the stead-state ionization distribution of hydrogen and helium around the planet based on its physical parameters and the high-energy irradiation arriving at the planet. It also calculates the wavelength-dependent transit depths in the metastable helium triplet at 1.083 microns.

If you want to use the code without installing it locally, you can always run it on the cloud (see this Google Colaboratory quickstart notebook). Otherwise, check out the :ref:`Installation <installation>` guide.

You can contribute to the project using GitHub.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   api
   quickstart
   advanced_tutorial