<p align="center"> <img src="https://raw.githubusercontent.com/andizq/andizq.github.io/master/discminer/discminer_logo.jpeg" width="500" height="" ></p> <h2 align="center">The Channel Map Modelling Code</h2> <div align="center"> <a href="https://github.com/andizq/discminer/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-FEE440.svg?style=for-the-badge"></a> <a href="https://github.com/andizq/discminer/pulls"><img alt="Pull request?" src="https://img.shields.io/badge/Become%20a-miner%20%e2%9a%92-00BBF9.svg?style=for-the-badge"></a> <a href="https://github.com/andizq"><img alt="andizq" src="https://img.shields.io/badge/with%20%e2%99%a1%20by-andizq-ff1414.svg?style=for-the-badge"></a> <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge"></a> </div> <div align="center"> Welcome to the discminer repository! Looking for quick examples and tutorials? Check out the <mark>example/</mark> folder. <br /> <a href="https://github.com/andizq/discminer/issues/new?assignees=&labels=bug&title=bug%3A+">Report a Bug</a> · <a href="https://github.com/andizq/discminer/issues/new?assignees=&labels=enhancement&title=feature%3A+">Request a Feature</a> · <a href="https://github.com/andizq/discminer/issues/new?assignees=&labels=question&title=question%3A+">Ask a Question</a> </div>

Model channel maps from molecular line emission of discs by fitting intensity and rotation velocity
Analyse the disc's dynamics by modelling Keplerian motion, and optionally pressure support + self-gravity
Investigate the disc vertical structure by modelling front and back side emission surfaces
Compute moment maps that accurately capture complex line profile morphologies
Extract rotation curves, radial and meridional velocities, intensity, and line width profiles
Identify velocity and intensity substructures, and examine their coherence and degree of localisation
Support non-axisymmetric models; all attributes can be described in three-dimensional coordinates

Mining tools

Discminer offers a wide range of analysis and visualisation tools to fully explore the physical and dynamical structure of discs.

cube

Compute moment maps that accurately capture complex line profile morphologies.
Output moment maps include peak intensity, line width, line slope, and centroid velocity.
Easily clip, downsample, and convert data to brightness temperature units.
Quickly visualise model versus data channels and interactively extract spectra.

rail

Extract azimuthal and radial profiles of intensity, line width, and velocity from moment maps.
Compute rotation curves and decompose disc velocities into their three-dimensional components.
Identify large-scale structures and quantify their pitch angle, width, extent, and degree of coherence.

pick

Identify small-scale perturbations and estimate their degree of localisation.

plottools

Customise intensity channels, moments, and residual maps.
Use sky or disc projections interchangeably for improved visualisation of features.
Easily overlay disc geometry (considering orientation and vertical structure) onto any observable product.
Load in 1D profiles or 2D maps from external data e.g. to highlight the presence of dust substructures.

Installation

pip install discminer

To upgrade the code,

pip install -U discminer

Optional dependencies

How to use

You can find practical examples demonstrating the main functionality of the code in the ./example folder of this repository.

To run the examples on your local machine, clone this repository and follow the instructions provided in the README file,

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

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

Discminer

Install / Use

README