# eddy - Extracting Disk Dynamics
<p align='center'>
<br/>
<img src="https://github.com/richteague/eddy/blob/master/docs/_static/eddy_logo.png" width="500" height="500">
<br/>
<br/>
<a href="http://joss.theoj.org/papers/2868c5ad4b6405eba1aaf1cd8ea53274"><img src="http://joss.theoj.org/papers/2868c5ad4b6405eba1aaf1cd8ea53274/status.svg">
</a>
<a href='https://eddy.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/eddy/badge/?version=latest' alt='Documentation Status' />
</a>
<a href="https://doi.org/10.5281/zenodo.1440051"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.1440051.svg" alt="DOI" />
</a>
<a href="http://ascl.net/1901.010"><img src="https://img.shields.io/badge/ascl-1901.010-blue.svg?colorB=262255" alt="ascl:1901.010" />
</a>
<br/>
<br/>
</p>
## 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.
## Installation
The most simple method is with `pip`,
```
pip install astro-eddy
```
The only real dependencies for this are `numpy`, `scipy`, `matplotlib`, and [`emcee`](https://github.com/dfm/emcee), If you want to run the Gaussian Process method you will also need [`celerite`](https://github.com/dfm/celerite) which can be easily installed if you follow their [installation guide](https://celerite.readthedocs.io/en/stable/python/install/).
If things have installed correctly you should be able to run the [Jupyter Notebooks](https://github.com/richteague/eddy/tree/master/docs/tutorials) with no errors. If something goes wrong, please [open an issue](https://github.com/richteague/eddy/issues/new).
## Useage
For guides on how to use `eddy` you will find extensive examples in the [documents](https://github.com/richteague/eddy/tree/master/docs). We shamelessly recommend [bettermoments](https://github.com/richteague/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](http://joss.theoj.org/papers/10.21105/joss.01220):
```latex
@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](./docs/citations.md) page.
## Works Using `eddy`
A list of the works using (or at least citing) `eddy` can be found on [ADS](https://ui.adsabs.harvard.edu/abs/2019JOSS....4.1220T/citations).
Raw data
{
"_id": null,
"home_page": "https://github.com/richteague/eddy",
"name": "astro-eddy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Richard Teague",
"author_email": "rteague@mit.edu",
"download_url": "https://files.pythonhosted.org/packages/13/84/8445b47da925c67a0f7704c3bf0c29c37ebfbd5ca846ed0a1601aff88925/astro-eddy-2.4.1.tar.gz",
"platform": null,
"description": "# eddy - Extracting Disk Dynamics\n\n<p align='center'>\n <br/>\n <img src=\"https://github.com/richteague/eddy/blob/master/docs/_static/eddy_logo.png\" width=\"500\" height=\"500\">\n <br/>\n <br/>\n <a href=\"http://joss.theoj.org/papers/2868c5ad4b6405eba1aaf1cd8ea53274\"><img src=\"http://joss.theoj.org/papers/2868c5ad4b6405eba1aaf1cd8ea53274/status.svg\">\n </a>\n <a href='https://eddy.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/eddy/badge/?version=latest' alt='Documentation Status' />\n </a>\n <a href=\"https://doi.org/10.5281/zenodo.1440051\"><img src=\"https://zenodo.org/badge/DOI/10.5281/zenodo.1440051.svg\" alt=\"DOI\" />\n </a>\n <a href=\"http://ascl.net/1901.010\"><img src=\"https://img.shields.io/badge/ascl-1901.010-blue.svg?colorB=262255\" alt=\"ascl:1901.010\" />\n </a>\n <br/>\n <br/>\n</p>\n\n## What Is It?\n\n`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.\n\n## Installation\n\nThe most simple method is with `pip`,\n\n```\npip install astro-eddy\n```\n\nThe only real dependencies for this are `numpy`, `scipy`, `matplotlib`, and [`emcee`](https://github.com/dfm/emcee), If you want to run the Gaussian Process method you will also need [`celerite`](https://github.com/dfm/celerite) which can be easily installed if you follow their [installation guide](https://celerite.readthedocs.io/en/stable/python/install/).\n\nIf things have installed correctly you should be able to run the [Jupyter Notebooks](https://github.com/richteague/eddy/tree/master/docs/tutorials) with no errors. If something goes wrong, please [open an issue](https://github.com/richteague/eddy/issues/new).\n\n## Useage\n\nFor guides on how to use `eddy` you will find extensive examples in the [documents](https://github.com/richteague/eddy/tree/master/docs). We shamelessly recommend [bettermoments](https://github.com/richteague/bettermoments) to make the moment maps required for the fitting.\n\n## Citations\n\nIf you use `eddy` as part of your research, please cite the [JOSS article](http://joss.theoj.org/papers/10.21105/joss.01220):\n\n```latex\n@article{eddy,\n doi = {10.21105/joss.01220},\n url = {https://doi.org/10.21105/joss.01220},\n year = {2019},\n month = {feb},\n publisher = {The Open Journal},\n volume = {4},\n number = {34},\n pages = {1220},\n author = {Richard Teague},\n title = {eddy},\n journal = {The Journal of Open Source Software}\n}\n```\n\nA full list of citations including dependencies can be found on the [citations](./docs/citations.md) page.\n\n## Works Using `eddy`\n\nA list of the works using (or at least citing) `eddy` can be found on [ADS](https://ui.adsabs.harvard.edu/abs/2019JOSS....4.1220T/citations).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tools to study the dynamics of protoplanetary disks.",
"version": "2.4.1",
"project_urls": {
"Homepage": "https://github.com/richteague/eddy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "13848445b47da925c67a0f7704c3bf0c29c37ebfbd5ca846ed0a1601aff88925",
"md5": "432e4d18a899d8950dc9882e8b2b8791",
"sha256": "b5fe465e326d15c3dfedd28f48fee97da02e1d70cbdad9a6fe75270e0c344773"
},
"downloads": -1,
"filename": "astro-eddy-2.4.1.tar.gz",
"has_sig": false,
"md5_digest": "432e4d18a899d8950dc9882e8b2b8791",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 75990,
"upload_time": "2024-06-18T09:13:38",
"upload_time_iso_8601": "2024-06-18T09:13:38.964715Z",
"url": "https://files.pythonhosted.org/packages/13/84/8445b47da925c67a0f7704c3bf0c29c37ebfbd5ca846ed0a1601aff88925/astro-eddy-2.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-18 09:13:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "richteague",
"github_project": "eddy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "astro-eddy"
}
JSON
