disksurf
disksurf: Extracting the 3D Structure of Protoplanetary Disks - Published in JOSS (2021)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 9 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
✓Committers with academic emails
4 of 5 committers (80.0%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Measure the molecular emission surface of protoplanetary disks. Based on Pinte et al. (2018).
Basic Info
Statistics
- Stars: 10
- Watchers: 3
- Forks: 8
- Open Issues: 2
- Releases: 1
Metadata Files
README.md
disksurf
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) (with associated example script).
How do I install it?
Grab the latest version from PyPI:
$ pip install disksurf
This has a couple of dependencies, namely astropy and 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 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 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) for the method, and Teague et al. (2021) 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} } ```
Owner
- Name: Rich Teague
- Login: richteague
- Kind: user
- Location: Cambridge, MA
- Company: Massachusetts Institute of Technology
- Website: https://richteague.github.io
- Repositories: 7
- Profile: https://github.com/richteague
JOSS Publication
disksurf: Extracting the 3D Structure of Protoplanetary Disks
Authors
Center for Astrophysics | Harvard & Smithsonian, 60 Garden St., Cambridge, MA 02138, USA
Center for Astrophysics | Harvard & Smithsonian, 60 Garden St., Cambridge, MA 02138, USA
Department of Astronomy, University of Michigan, 323 West Hall, 1085 South University Avenue, Ann Arbor, MI 48109, USA, NASA Hubble Fellowship Program Sagan Fellow
Department of Astronomy, University of Michigan, 323 West Hall, 1085 South University Avenue, Ann Arbor, MI 48109, USA
Editor
Christina Hedges
Tags
astronomy protoplanetary disksGitHub Events
Total
- Watch event: 1
- Fork event: 1
Last Year
- Watch event: 1
- Fork event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Richard Teague | r****e@c****u | 109 |
| richteague | r****e@m****u | 21 |
| Aviad Levis | a****s@g****m | 1 |
| Rich Teague | r****e@u****u | 1 |
| Jane Huang | j****g@s****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 5
- Total pull requests: 2
- Average time to close issues: 7 days
- Average time to close pull requests: 1 day
- Total issue authors: 4
- Total pull request authors: 2
- Average comments per issue: 1.0
- Average comments per pull request: 0.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- j6626 (2)
- MaileRuiz (1)
- richteague (1)
- emptymalei (1)
Pull Request Authors
- aviadlevis (1)
- j6626 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 14 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 23
- Total maintainers: 1
pypi.org: disksurf
Infer and reproject a disk's 3D structure.
- Homepage: https://github.com/richteague/disksurf
- Documentation: https://disksurf.readthedocs.io/
- License: MIT
-
Latest release: 1.2.8
published over 1 year ago
Rankings
Maintainers (1)
Dependencies
- jupyter *
- nbsphinx *
- pandoc *
- pygments >=2.4.1
- sphinx >=1.7.5
- astropy *
- emcee *
- gofish *
- matplotlib *
- numpy *
- scipy *