Welcome to the special documentation

Recent technological progress in high-contrast imaging has allowed the spectral characterization of directly imaged giant planet and brown dwarf companions at ever shorter angular separation from their host stars, hence opening a new avenue to study their formation, evolution, and composition.

In this context, special is a Python package for the SPEctral Characterization of directly ImAged Low-mass companions. While some tools are specific to the characterisation of low-mass (M, L, T) dwarfs down to giant planets at optical/IR wavelengths, the main routines of special (MCMC and nested samplers) can also be used in a more general way for the characterisation of any type of object with a measured spectrum, provided a relevant input model grid, regardless of the observational method used to obtain the spectrum (direct imaging or not) and regardless of the format of the spectra (multi-band photometry, low-resolution or medium-resolution spectrum, or a combination thereof).

Getting started

• What makes it special?
• TL;DR setup guide
• Installation and dependencies
  • Using pip
  • Using the setup.py file
  • Using Git
  • Loading special

About

• Contributions
• Questions and suggestions
• Acknowledgements

Package content

• special package
  • Submodules
  • special.chi module
    • gof_scal()
    • goodness_of_fit()
  • special.config module
    • time_fin()
    • time_ini()
    • timing()
  • special.fits module
    • info_fits()
    • open_fits()
    • write_fits()
  • special.mcmc_sampling module
    • chain_zero_truncated()
    • confidence()
    • lnlike()
    • lnprob()
    • mcmc_spec_sampling()
    • show_corner_plot()
    • show_walk_plot()
  • special.model_resampling module
    • interpolate_model()
    • make_model_from_params()
    • make_resampled_models()
    • resample_model()
  • special.nested_sampling module
    • nested_spec_sampling()
    • show_nestle_results()
    • show_ultranest_results()
  • special.spec_corr module
    • combine_spec_corrs()
    • spectral_correlation()
  • special.spec_indices module
    • digit_to_spt()
    • sp_idx_to_gravity()
    • sp_idx_to_spt()
    • spectral_idx()
    • spt_to_digit()
  • special.template_fit module
    • best_fit_tmp()
    • get_chi()
  • special.utils_mcmc module
    • autocorr_test()
    • gelman_rubin()
    • gelman_rubin_from_chain()
  • special.utils_nested module
    • un_burning()
  • special.utils_spec module
    • akaike()
    • blackbody()
    • convert_F_units()
    • convert_F_vs_mag()
    • extinction()
    • find_nearest()
    • inject_em_line()
    • mj_from_rj_and_logg()
    • nrefrac()
  • Module contents

API

• Index

• Module Index

• Search Page