Skip to main content

Infer and reproject a disk's 3D structure.

Project description

disksurf


Documentation Status DOI DOI

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:

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}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

disksurf-1.1.1.tar.gz (29.8 kB view details)

Uploaded Source

File details

Details for the file disksurf-1.1.1.tar.gz.

File metadata

  • Download URL: disksurf-1.1.1.tar.gz
  • Upload date:
  • Size: 29.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/56.2.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.4

File hashes

Hashes for disksurf-1.1.1.tar.gz
Algorithm Hash digest
SHA256 65e80591b93d68766f17b115a52b3bc925ccca18c6c6c36a4491bac25611dd7c
MD5 b3c5cf420b08b2a9f8a76c5357fbb2fe
BLAKE2b-256 6b7b206e770b1adf2c03985207b1b12dbe895ea1b6eafe89b05391b31964fecb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page