FluxCompensator Documentation¶
Introduction¶
This is the documentation for the FluxCompensator, an open-source post-processing tool of continuum radiative transfer codes. It is capable of producing “realistic” synthetic observations from the output of radiative transfer codes such as Hyperion. The FluxCompensator (as Hyperion) can be accessed via Python scripts. However, little knowledge of Python is required as we provide pre-constructed pipelines and interfaces.
Compatibility with Other Codes¶
The FluxCompensator package has been designed to be able to post-process the radiative transfer output of Hyperion. It follows the same philosophy as Hyperion in using object-oriented Python scripts and making it therefore more user friendly and generic. Very little Python knowledge is required to work with either Hyperion or the FluxCompensator. As the tool has been designed for Hyperion, some features of the FluxCompensator will only work optimally if Hyperion inputs are used. However, in principle it should be easy to adapt the FluxCompensator so that it can read in any arbitrary ideal observations from other radiative transfer codes, provided that they can output a spectral cube. Aside from the input, most of the code is not specific to Hyperion. For assistance with other radiative transfer outputs contact as here.
Documentation¶
Built-in Tools¶
Tutorials¶
Credits¶
This work was carried out in the Max Planck Research Group “Star formation throughout the Milky Way Galaxy” at the Max Planck Institute for Astronomy lead by Thomas Robitaille. We further acknowledge support from the International Max Planck Research School for Astronomy and Cosmic Physics (IMPRS) at the University of Heidelberg and the Bayerischen Gleichstellungsförderung.
References¶
Note that this text is merely the documentation of the FluxCompensator code and therefore, please consider Koepferl & Robitaille (subm. to ApJ) for relevant references. When using the FluxCompensator please cite Koepferl & Robitaille (subm. to ApJ) and relevant references therein.
Important
We do not take any responsibility about the correctness of the results. The users are responsible that they understand the physical processes happening in the FluxCompensator and that the results are reasonable.
Otherwise – have fun :)