Python implementation of Parker wind models for planetary atmospheres. So many p's! (Hence the name for the code.)
The main objective of this code is to produce simplified, 1-D models of the upper atmosphere of a planet, and perform radiative transfer to calculate observable spectral signatures.
The scalable implementation of 1D models allows for atmospheric retrievals to calculate atmospheric escape rates and temperatures. In addition, the modular implementation allows for a smooth plugging-in of more complex descriptions to forward model their corresponding spectral signatures (e.g., self-consistent or 3D models).
A paper describing p-winds and its usage for research-grade astronomical applications has been accepted for publication in the journal Astronomy & Astrophysics. If you use this code in your research, please consider citing it.
p-winds 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).
You can install p-winds using pip or by compiling it from source.
Simply run the following command:
pip install p-winds
First, clone the repository and then navigate to it:
git clone https://github.com/ladsantos/p-winds.git
cd p-winds
And then compile it from source:
python setup.py install
You can test the installation from source with pytest (you may need to
install pytest first):
pytest tests
Check out a quickstart Google Colab Notebook here. A similar quickstart Jupyter notebook is also available inside the docs/source/ folder.
You can contribute to the development of p-winds either by submitting issues, or by submitting pull requests (PR). If you choose to submit a PR, please pull it to the dev branch, which is where the experiments happen before being merged to the main branch.
Check out the open issues.