Skip to main content

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

Metadata

Release files for disksurf 1.2.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for disksurf 1.2.8
File Size Uploaded
disksurf-1.2.8.tar.gz 31.2 kB Details

Release files / disksurf-1.2.8.tar.gz

Download URL disksurf-1.2.8.tar.gz
Size 31.2 kB
Tags Source
SHA-256 checksum
How to use checksums
19a3e73510029d50c9829ebad03f172c058f12f253e2954b9e04141112752100
BLAKE2b-256 checksum
How to use checksums
abf5ce27e6844d1e33bc0be89b02735cbe73bea238d553cfe29e0bbcb56633df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.12

Release history Release notifications | RSS feed

This release

1.2.8 This release

1 release file

1.2.7

1 release file

1.2.6

1 release file

1.2.5

1 release file

1.2.4

1 release file

1.2.3

1 release file

1.2.2

1 release file

1.2.1

1 release file

1.2

1 release file

1.1.2

1 release file

1.1.1

1 release file

1.1.0

1 release file

0.1.8

1 release file

0.1.7

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page