Skip to main content

MCMC fitting code for low temperature atmosphere spectra

Project description

UCDMCMC

Markov Chain Monte Carlo (MCMC) fitting code for low-temperature stars, brown dwarfs and extrasolar planet spectra, tuned particularly to the near-infrared. This code is continually being updated, so please suggest fixes, features, and/or improvements.

INSTALLATION NOTES

ucdmcmc can be installed from pip:

pip install ucdmcmc

or from git:

git clone https://github.com/aburgasser/ucdmcmc.git
cd ucdmcmc
python -m setup.py install

It is recommended that you install in a conda environment to ensure the dependencies do not conflict with your own installation

conda create -n ucdmcmc python=3.13
conda activate ucdmcmc
pip install ucdmcmc

A check that this worked is that you can import ucdmcmc into python/jupyter noteobook, and that the ucdmcmc.MODEL_FOLDER points to the models folder that was downloaded

ucdmcmc uses the following external packages:

Optionally install SPLAT

To generate new model sets using the built-in generateModels() function, you will need to install SPLAT (note: this is not necessary for the other functionality in this code). SPLAT is not automatically installed on setup. The instructions are essentially the same:

git clone https://github.com/aburgasser/splat.git
cd splat
python -m pip install .

See https://github.com/aburgasser/splat for additional instructions

Models

ucdmcmc comes with a starter set of models that play nicely with the code. An extended set can be downloaded from https://spexarchive.coolstarlab.ucsd.edu/ucdmcmc/. These should be placed in the folder .ucdmcmc_models in your home directory (i.e., /home/adam/.ucdmcmc_models). If it doesn't already exist, this directory will be created on the first call to ucdmcmc. In addition, models that exist on this website and not present in this folder will be downloaded directly when getModelSet()`` is called. You can also generate your own set of models using the generateModels()` function (see note above).

ucdmcmc has been successfully run with the following models:

Additional models are continuously being added, please let us know if there are models you'd like to see included!

Spectra

ucdmcmc comes with a starter set of spectra for the following instruments:

User spectra can be read in using ucdmcmc.Spectrum("filename"). Files can be .fits, .csv, .txt (space-delimited), or .tsv (tab-delimited), and should have wavelength, flux, and uncertainty arrays. You can also read in these files separately and create a Spectrum object using the call ucdmcmc.Spectrum(wave=[wave array,flux=[flux array],noise=[uncertainty array]). See the docstring for ucdmcmc.Spectrum for further details.

Usage

ucdmcmc comes with samples to help you test the code which you can read in with the function ucdmcmc.getSample():

import ucdmcmc
sp = ucdmcmc.getSample('JWST-NIRSPEC-PRISM')
sp.plot()
plot1

Fitting requires reading in a model set; for existing sets specify the model name and the instrument:

models,wave = ucdmcmc.getModelSet('elfowl24','JWST-NIRSPEC-PRISM')

We map our spectrum to the model wave grid, then we can conduct a grid fit to find the single best fitting model using ucdmcmc.fitGrid():

sp.toWavelengths(wave)
par = ucdmcmc.fitGrid(sp,models)

Output:

Best parameters:
	model = elfowl24
	co = 0.5
	kzz = 7.0
	logg = 4.75
	teff = 600.0
	z = -1.0
	scale = 1.616424519232685e-20
	chis = 1290354.449246344
	radius = 0.056390540414855445
	dof = 853.0
	rchi = 1512.7250284247878
plot2

These grid parameters can be used to initiate an MCMC fit using using ucdmcmc.fitMCMC():

npar = ucdmcmc.fitMCMC(sp,models,par,nstep=100,burn=0.25,absolute=True,verbose=False)

Output:

Best parameters:
	model: elfowl24
	co: 0.580211857460554
	kzz: 7.3919278336945515
	logg: 5.365954958490183
	teff: 633.8145781129864
	z: -0.9388765775373868
	scale: 1.328342456515958e-20
	chis: 1328254.9586724846
	radius: 0.05111914351717615
	dof: 848
	rchi: 1512.7250284247878
plot3

(note: it is recommended to run with more than 100 steps!)

You can visualize the parameter distributions using ucdmcmc.plotCorner():

ucdmcmc.plotCorner(npar)
plot4

There are many variations to these fits, as well as secondary parameters (e.g., RV, vsini, line broadening, reddening, etc) that can be explored. Please see the help files associated with the specific functions.

Opacities

[TBD]

Citing the code

If you use this code in your research, publications, or presentations, please include the following citation:

Burgasser, Brooks, Morrissey, Haynes, & Liou (2025). aburgasser/ucdmcmc (vXXX). Zenodo. https://doi.org/10.5281/zenodo.16921710

or in bibtex:

@software{adam_burgasser_2026_16921710,
  author       = {Adam Burgasser and
                  Brooks, Hunter and
                  Morrissey, Sara and
                  Haynes, Julia and
                  Liou, Tiffany},
  title        = {aburgasser/ucdmcmc: vXXXX},
  month        = jan,
  year         = 2026,
  publisher    = {Zenodo},
  version      = {v1.4},
  doi          = {10.5281/zenodo.16921710},
  url          = {https://doi.org/10.5281/zenodo.16921710},
}

where (vXXX) corresponds to the version used.

ucdmcmc and its antecedents has been used in the following publications:

Please let me know if you make use of the code so we can include your publication in the list above!

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

ucdmcmc-1.4.3.tar.gz (62.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ucdmcmc-1.4.3-py3-none-any.whl (61.4 MB view details)

Uploaded Python 3

File details

Details for the file ucdmcmc-1.4.3.tar.gz.

File metadata

  • Download URL: ucdmcmc-1.4.3.tar.gz
  • Upload date:
  • Size: 62.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ucdmcmc-1.4.3.tar.gz
Algorithm Hash digest
SHA256 aea6833b79ede9b1d3189f070561031529c620e02879c73f25b798f33957a142
MD5 282d162a4aa02cd5a4896f36091d30ea
BLAKE2b-256 421cb1c1673ba66508234e6d08e46ab763898dabc514080b58728c6bba61ca02

See more details on using hashes here.

Provenance

The following attestation bundles were made for ucdmcmc-1.4.3.tar.gz:

Publisher: pypi-publish.yml on aburgasser/ucdmcmc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ucdmcmc-1.4.3-py3-none-any.whl.

File metadata

  • Download URL: ucdmcmc-1.4.3-py3-none-any.whl
  • Upload date:
  • Size: 61.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ucdmcmc-1.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 baf5bfa9a2d91d435d65971e0a2eb12c6c50ad011c0eb91ee9f0b5c3777ccc58
MD5 a03daca94e50146ba52868404c9c3a73
BLAKE2b-256 dd28086ff3417b06a3ad37c361f1c0e3c0fb775187f8e299c9048030002b4d61

See more details on using hashes here.

Provenance

The following attestation bundles were made for ucdmcmc-1.4.3-py3-none-any.whl:

Publisher: pypi-publish.yml on aburgasser/ucdmcmc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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