Welcome to the special documentation

special is a package for the SPEctral Characterization of directly ImAged Low-mass companions. While some tools are specific to the characterisation of directly imaged (sub-)stellar companions, the main features of special can also be used in a more general way for the characterisation of any object with a measured spectrum, provided an input model or template grid.

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
  • special.config module
  • special.fits module
  • special.mcmc_sampling module
  • special.model_resampling module
  • special.nested_sampling module
  • special.spec_corr module
  • special.spec_indices module
  • special.template_fit module
  • special.utils_mcmc module
  • special.utils_nested module
  • special.utils_spec module
  • Module contents

API

• Index

• Module Index

• Search Page