# disksurf
<p align='center'>
<img src="HD163296_zeroth.png" width="793" height="549">
<br>
<a href='https://disksurf.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/disksurf/badge/?version=latest' alt='Documentation Status' />
</a>
<a href='https://doi.org/10.21105/joss.03827'>
<img src='https://joss.theoj.org/papers/10.21105/joss.03827/status.svg' alt='DOI'>
</a>
<a href="https://zenodo.org/badge/latestdoi/184391824">
<img src="https://zenodo.org/badge/184391824.svg" alt="DOI">
</a>
</p>
## What is it?
`disksurf` is a package which contains the functions to measure the height of optically thick emission, or photosphere, using the method presented in [Pinte et al. (2018)](https://ui.adsabs.harvard.edu/abs/2018A%26A...609A..47P/abstract) (with associated [example script](https://github.com/cpinte/CO_layers)).
## How do I install it?
Grab the latest version from PyPI:
```
$ pip install disksurf
```
This has a couple of dependencies, namely [astropy](https://github.com/astropy/astropy) and [GoFish](https://github.com/richteague/gofish), which should be installed automatically if you don't have them. To verify that everything was installed as it should, running through the [tutorials](https://disksurf.readthedocs.io/en/latest/tutorials/tutorial_1.html) should work without issue.
## How do I use it?
At its most basic, `disksurf` is as easy as:
```python
from disksurf import observation # import the module
cube = observations('path/to/cube.fits') # load up the data
surface = cube.get_emission_surface(inc=30.0, PA=45.0) # extract the surface
surface.plot_surface() # plot the surface
```
Follow our [tutorials](https://disksurf.readthedocs.io/en/latest/tutorials/tutorial_1.html) for a quick guide on how to use `disksurf` with DSHARP data and some of the additional functions that will help you extract the best surface possible.
## Citation
If you use this software, please remember to cite both [Pinte et al. (2018)](https://ui.adsabs.harvard.edu/abs/2018A%26A...609A..47P/abstract) for the method, and [Teague et al. (2021)](https://joss.theoj.org/papers/10.21105/joss.03827#) for the software.
```
@article{2018A&A...609A..47P,
doi = {10.1051/0004-6361/201731377},
year = {2018},
volume = {609},
eid = {A47},
pages = {A47},
author = {{Pinte}, C. and {M{\'e}nard}, F. and {Duch{\^e}ne}, G. and {Hill}, T. and {Dent}, W.~R.~F. and {Woitke}, P. and {Maret}, S. and {van der Plas}, G. and {Hales}, A. and {Kamp}, I. and {Thi}, W.~F. and {de Gregorio-Monsalvo}, I. and {Rab}, C. and {Quanz}, S.~P. and {Avenhaus}, H. and {Carmona}, A. and {Casassus}, S.},
title = "{Direct mapping of the temperature and velocity gradients in discs. Imaging the vertical CO snow line around IM Lupi}",
journal = {\aap}
}
@article{disksurf,
doi = {10.21105/joss.03827},
url = {https://doi.org/10.21105/joss.03827},
year = {2021},
publisher = {The Open Journal},
volume = {6},
number = {67},
pages = {3827},
author = {Richard Teague and Charles J. Law and Jane Huang and Feilong Meng},
title = {disksurf: Extracting the 3D Structure of Protoplanetary Disks},
journal = {Journal of Open Source Software}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/richteague/disksurf",
"name": "disksurf",
"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/ab/f5/ce27e6844d1e33bc0be89b02735cbe73bea238d553cfe29e0bbcb56633df/disksurf-1.2.8.tar.gz",
"platform": null,
"description": "# disksurf\n\n<p align='center'>\n <img src=\"HD163296_zeroth.png\" width=\"793\" height=\"549\">\n <br>\n <a href='https://disksurf.readthedocs.io/en/latest/?badge=latest'>\n <img src='https://readthedocs.org/projects/disksurf/badge/?version=latest' alt='Documentation Status' />\n </a>\n <a href='https://doi.org/10.21105/joss.03827'>\n <img src='https://joss.theoj.org/papers/10.21105/joss.03827/status.svg' alt='DOI'>\n </a>\n <a href=\"https://zenodo.org/badge/latestdoi/184391824\">\n <img src=\"https://zenodo.org/badge/184391824.svg\" alt=\"DOI\">\n </a>\n</p>\n\n## What is it?\n\n`disksurf` is a package which contains the functions to measure the height of optically thick emission, or photosphere, using the method presented in [Pinte et al. (2018)](https://ui.adsabs.harvard.edu/abs/2018A%26A...609A..47P/abstract) (with associated [example script](https://github.com/cpinte/CO_layers)).\n\n## How do I install it?\n\nGrab the latest version from PyPI:\n\n```\n$ pip install disksurf\n```\n\nThis has a couple of dependencies, namely [astropy](https://github.com/astropy/astropy) and [GoFish](https://github.com/richteague/gofish), which should be installed automatically if you don't have them. To verify that everything was installed as it should, running through the [tutorials](https://disksurf.readthedocs.io/en/latest/tutorials/tutorial_1.html) should work without issue.\n\n## How do I use it?\n\nAt its most basic, `disksurf` is as easy as:\n\n```python\nfrom disksurf import observation # import the module\ncube = observations('path/to/cube.fits') # load up the data\nsurface = cube.get_emission_surface(inc=30.0, PA=45.0) # extract the surface\nsurface.plot_surface() # plot the surface\n```\n\nFollow our [tutorials](https://disksurf.readthedocs.io/en/latest/tutorials/tutorial_1.html) for a quick guide on how to use `disksurf` with DSHARP data and some of the additional functions that will help you extract the best surface possible.\n\n## Citation\n\nIf you use this software, please remember to cite both [Pinte et al. (2018)](https://ui.adsabs.harvard.edu/abs/2018A%26A...609A..47P/abstract) for the method, and [Teague et al. (2021)](https://joss.theoj.org/papers/10.21105/joss.03827#) for the software.\n\n```\n@article{2018A&A...609A..47P,\n doi = {10.1051/0004-6361/201731377},\n year = {2018},\n volume = {609},\n eid = {A47},\n pages = {A47},\n author = {{Pinte}, C. and {M{\\'e}nard}, F. and {Duch{\\^e}ne}, G. and {Hill}, T. and {Dent}, W.~R.~F. and {Woitke}, P. and {Maret}, S. and {van der Plas}, G. and {Hales}, A. and {Kamp}, I. and {Thi}, W.~F. and {de Gregorio-Monsalvo}, I. and {Rab}, C. and {Quanz}, S.~P. and {Avenhaus}, H. and {Carmona}, A. and {Casassus}, S.},\n title = \"{Direct mapping of the temperature and velocity gradients in discs. Imaging the vertical CO snow line around IM Lupi}\",\n journal = {\\aap}\n}\n\n@article{disksurf,\n doi = {10.21105/joss.03827},\n url = {https://doi.org/10.21105/joss.03827},\n year = {2021},\n publisher = {The Open Journal},\n volume = {6},\n number = {67},\n pages = {3827},\n author = {Richard Teague and Charles J. Law and Jane Huang and Feilong Meng},\n title = {disksurf: Extracting the 3D Structure of Protoplanetary Disks},\n journal = {Journal of Open Source Software}\n}\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Infer and reproject a disk's 3D structure.",
"version": "1.2.8",
"project_urls": {
"Homepage": "https://github.com/richteague/disksurf"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "abf5ce27e6844d1e33bc0be89b02735cbe73bea238d553cfe29e0bbcb56633df",
"md5": "ea888022c3679f321a96a2ef8de67538",
"sha256": "19a3e73510029d50c9829ebad03f172c058f12f253e2954b9e04141112752100"
},
"downloads": -1,
"filename": "disksurf-1.2.8.tar.gz",
"has_sig": false,
"md5_digest": "ea888022c3679f321a96a2ef8de67538",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31243,
"upload_time": "2024-09-02T18:25:12",
"upload_time_iso_8601": "2024-09-02T18:25:12.603588Z",
"url": "https://files.pythonhosted.org/packages/ab/f5/ce27e6844d1e33bc0be89b02735cbe73bea238d553cfe29e0bbcb56633df/disksurf-1.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 18:25:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "richteague",
"github_project": "disksurf",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "disksurf"
}
JSON
