discminer 0.2.7

Python package for parametric modelling of intensity channel maps from gas discs

The Channel Map Modelling Code

Welcome to the discminer repository! Looking for quick examples and tutorials? Check out the docs.
Report a Bug · Request a Feature · Ask a Question

• Model channel maps from molecular line observations of discs by fitting intensity and rotation velocity.
• Compute moment maps, rotation curves and meridional velocities, intensity and line width profiles.
• Quantify deviations from Keplerian motion and investigate their relationship to intensity and line width fluctuations.
• Customise model parameterisations as function of the 3D disc coordinates easily (azimuthal asymmetries are possible!).
• Employ different prescriptions for the disc rotation velocity if needed: Keplerian + pressure support + self-gravity.
• Model upper and lower emitting surfaces of the disc simultaneously.
• Use irregular emitting surfaces obtained with external non-parametric methods if required.
• Analyse the disc physical structure and dynamics using built-in tools.

Mining, analysis and visualisation tools

rail

• Extract azimuthal and radial profiles of intensity, line width and velocity from moment maps.
• Compute rotation curves and decompose the three-dimensional velocity field of the disc.
• Reveal large-scale substructures and investigate coherence of observable signatures.

pick

• Quantify small-scale fluctuations in the disc.
• Reveal localised velocity perturbations and/or sites of enhanced velocity dispersion.

moment maps

• Compute moment maps. Available kernels: Gaussian, bell, doubleGaussian, doubleBell.
• Output moments include peak intensity, line width and centroid velocity.

channel maps

• Visualise model/data channels, and extract spectra interactively.

disc geometry

• Use sky or disc [Cartesian or polar] projections interchangeably.
• Overlay the geometric structure of the disc on moment and channel maps easily.

Installation

pip install discminer

Optional Dependencies

• termtables
• termplotlib
• FilFinder
• ipython
• schwimmbad

How to use

The package documentation is under construction but you can find practical examples showing the main functionality of discminer in the ./template folder of this repository. To run the examples on your local machine you can clone this repository and follow the instructions in the readme file,

git clone https://github.com/andizq/discminer.git
cd discminer/template
less README.rst

Discminer history

discminer began life as the model.disc2d.py library of sf3dmodels.

v0.0.x

• Transiting to astropy units.
• Addition of mining tools.

License

discminer is published under the MIT license.

Citation

If you find discminer useful for your research please cite the work of Izquierdo et al. 2021,

@ARTICLE{2021A&A...650A.179I,
       author = {{Izquierdo}, A.~F. and {Testi}, L. and {Facchini}, S. and {Rosotti}, G.~P. and {van Dishoeck}, E.~F.},
        title = "{The Disc Miner. I. A statistical framework to detect and quantify kinematical perturbations driven by young planets in discs}",
      journal = {\aap},
     keywords = {planet-disk interactions, planets and satellites: detection, protoplanetary disks, radiative transfer, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Solar and Stellar Astrophysics},
         year = 2021,
        month = jun,
       volume = {650},
          eid = {A179},
        pages = {A179},
          doi = {10.1051/0004-6361/202140779},
archivePrefix = {arXiv},
       eprint = {2104.09596},
 primaryClass = {astro-ph.EP},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2021A&A...650A.179I},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}