slam

Spectral Line Analysis/Modeling

https://github.com/jinshisai/slam

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Spectral Line Analysis/Modeling

Basic Info
  • Host: GitHub
  • Owner: jinshisai
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 204 MB
Statistics
  • Stars: 5
  • Watchers: 1
  • Forks: 4
  • Open Issues: 0
  • Releases: 2
Created over 4 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

Documentation Status

SLAM: Spectral Line Analysis/Modeling

SLAM (Spectral Line Analysis/Modeling) is a python library to analyze/model spectral line data especially obtained with radio telescopes. The current main package, pvanalysis, is to derive the rotational velocity as a function of radius and fit the profile with a power-law function. The detail of the method is presented in Aso et al. 2015, Sai et al. 2020 and the reference therein. More analysis tools will be coming in future.

Demo and Usage

The file example.py will help to find how to use pvanalysis. bash git clone https://github.com/jinshisai/SLAM cd SLAM python example.py To keep the package updated, type the command below in the directory SLAM, always before you use. bash git pull Also, setting the path in .bashrc (or .zshrc etc.) will be useful. bash export PYTHONPATH=${PYTHONPATH}:/YOUR_PATH_TO/SLAM

Features

pvanalysis can do the following things. * Get edge and ridge points in the directions of positional and velocity axes from a FITS file of a position-velocity diagram. * Write out the derived points in text files. * Fit the derived points with the Keplerian, single power-law, or double power-law functions, using the MCMC method (emcee). * Systemic velocity Vsys can also be a free parameter. * Get the central stellar mass calculated from the best-fit functions, in addition to the fitting parameters. * Plot the derived points and best-fit functions on the position-velocity diagram in the linear or logR-logV planes.

Requirement

  • astropy
  • copy
  • corner
  • emcee
  • dynesty
  • math
  • matplotlib
  • mpl_toolkits
  • numpy
  • scipy

Installation

Download from https://github.com/jinshisai/SLAM or git clone. bash git clone https://github.com/jinshisai/SLAM

Note

  • Edge/ridge x is derived by xcut in dv steps. Edge/ridge v is derived by vcut in bmaj / 2 steps.
  • The derived points are removed (1) before the maximum value, (2) in the opposite quadrant, and (3) before the cross of xcut and vcut results. These removing operations can be switched on/off by nanbeforemax, nanopposite, and nanbeforecross, respectively, in get_edgeridge. Default is True for all the three.
  • Each 1D profile of xcut and vcut are also provided as outnamepvfitxcut.pdf and outnamepvfitvcut.pdf.
  • In outname.edge.dat and outname.ridge.dat files, xcut results have dv=0, and vcut results have dx=0.
  • The double power-law fitting, fit_edgeridge, uses chi2 = ((x - Xmodel(v)) / dx)^2 + ((v - Vmodel(x)) / dv)^2. Vmodel = sgn(x) Vb (|x|/Rb)^-p, where p=pin for |x| < Rb and p=pin+dp for |x| > Rb. Xmodel(v) is the inverse function of Vmodel(x).
  • dx and dv are the fitting undertainty for 'gaussian' ridge, the uncertainty propagated from the image noise for 'mean' ridge, and the image noise divided by the emission gradient for edge.
  • Min, Mout, and Mb are stellar masses calculated from the best-fit model at the innermost, outermost, and Rb radii, respectively. When p is not 0.5, these masses are just for reference.

Authors

  • Jinshi Sai
    • Affiliation: Academia Sinica Institute of Astronomy and Astrophysics
    • E-mail: jsai@asiaa.sinica.edu.tw
  • Yusuke Aso
    • Affiliation: Korea Astronomy and Space Science Institute
    • E-mail: yaso@kasi.re.kr

License

"SLAM" is under GNU General Public License Version 3.

Owner

  • Name: Jinshi Sai
  • Login: jinshisai
  • Kind: user
  • Location: Taiwan
  • Company: ASIAA

Postdoc fellow at ASIAA. Studying radio astronomy.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "Please cite SLAM as below if you use."
authors:
  - family-names: Aso
    given-names: Yusuke
    orcid: https://orcid.org/0000-0002-8238-7709
  - family-names: Sai
    given-names: Jinshi
    orcid: https://orcid.org/0000-0003-4361-5577
title: SLAM v1.2.0
version: 1.2.0
date-released: 2023-10-12
url: https://github.com/jinshisai/SLAM

GitHub Events

Total
  • Delete event: 5
  • Push event: 94
  • Pull request event: 15
  • Create event: 8
Last Year
  • Delete event: 5
  • Push event: 94
  • Pull request event: 15
  • Create event: 8

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 8
  • Average time to close issues: N/A
  • Average time to close pull requests: 6 minutes
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 8
  • Average time to close issues: N/A
  • Average time to close pull requests: 6 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • yusukeaso-astron (12)
  • jinshisai (1)
Top Labels
Issue Labels
Pull Request Labels