astro-eddy 3.0.0

Tools to study the dynamics of protoplanetary disks.

eddy - Extracting Disk Dynamics

What Is It?

eddy is a suite of Python tools to recover precise velocity profiles of protoplanetary disks from Doppler shifted line emission. eddy makes fitting of first moment maps and the inference of a rotation velocity from an annulus of spectra a breeze.

As of v3.0.0, the rotation-map model and likelihood are JAX-backed: JIT-compiled, autodifferentiable, and GPU-aware. Sampling can be done either with emcee (the default) or numpyro NUTS via mcmc='numpyro'; the Gaussian-process annulus path uses tinygp.

Installation

The most simple method is with pip,

pip install astro-eddy

Runtime dependencies are pulled in automatically: numpy, scipy, matplotlib, jax, jaxlib, emcee, zeus-mcmc, numpyro, tinygp, corner, and bettermoments. Python 3.10 or newer.

For an editable development install,

git clone https://github.com/PlanetFormationLab/eddy.git
cd eddy
pip install -e ".[test]"   # add test extras for running pytest

If things have installed correctly you should be able to run the Jupyter Notebooks with no errors. If something goes wrong, please open an issue.

Useage

For guides on how to use eddy you will find extensive examples in the documents. We shamelessly recommend bettermoments to make the moment maps required for the fitting.

Citations

If you use eddy as part of your research, please cite the JOSS article:

@article{eddy,
    doi = {10.21105/joss.01220},
    url = {https://doi.org/10.21105/joss.01220},
    year = {2019},
    month = {feb},
    publisher = {The Open Journal},
    volume = {4},
    number = {34},
    pages = {1220},
    author = {Richard Teague},
    title = {eddy},
    journal = {The Journal of Open Source Software}
}

A full list of citations including dependencies can be found on the citations page.

Works Using eddy

A list of the works using (or at least citing) eddy can be found on ADS.