magritte-rt 0.0.1
A modern software library for simulating radiation transport.
Requires Python: >=3.6

<img src="docs/src/images/Magritte_logo_plain.svg" alt="logo" width="350"/>

[![Build Status](https://travis-ci.com/Magritte-code/Magritte.svg?branch=master)](https://travis-ci.com/Magritte-code/Magritte)
[![Documentation Status](https://readthedocs.com/projects/magritte-magritte/badge/?version=latest&token=7d7b32178f0e9cfbbf7e0967233b680ccf113dd73b8d4b567f3587445c936036)](https://magritte-magritte.readthedocs-hosted.com/en/latest/?badge=latest)
---

Welcome to the Magritte repository! Magritte is a open-source software library for
simulating radiation transport, developed at
[University College London](https://www.ucl.ac.uk/) (UCL, UK) and
[KU Leuven](https://www.kuleuven.be/english/) (Belgium).

Magritte is currently mainly used for post-processing hydrodynamical simulations by
creating synthetic observations, but the techniques could also be applied more general.
It can either be used as a Python package or as a C++ library.
Magritte uses a deterministic ray-tracer with a formal solver that currently focusses on
line radiative transfer (see
[De Ceuster et al. 2019](https://ui.adsabs.harvard.edu/abs/2020MNRAS.492.1812D/abstract)
for more details). The plot below shows synthetic observations made with
Magritte at three different inclinations for a hydro simulation of the stellar wind around
an asymptotic giant branch (AGB) star as it is perturbed by a companion.

<img src="docs/src/_static/movie.gif" alt="movie"/>

The hydro model was created by Jan Bolte using [MPI-AMRVAC](http://amrvac.org/). See the
[examples](https://magritte.readthedocs.io/en/latest/1_examples/index.html) in the
documentation to learn how these synthetic observations were created with Magritte.


## Documentation
Please find our online documentation [here](https://magritte.readthedocs.io).
In particular, see our
[quickstart documentation](https://magritte.readthedocs.io/en/latest/0_getting_started/0_quickstart.html)
for a quick intro.


## Papers about Magritte
The following list of papers might provide further insights in the inner workings of
Magritte:
* _Magritte II: Adaptive ray-tracing, mesh construction and reduction_
([arXiv](https://arxiv.org/abs/2011.14998), [MNRAS](https://doi.org/10.1093/mnras/staa3199));
* _Magritte I: Non-LTE atomic and molecular line modelling_
([arXiv](https://arxiv.org/abs/1912.08445),
[MNRAS](https://doi.org/10.1093/mnras/stz3557)).

Please note that some features presented in these papers might not yet be implemented
and documented in the latest release of Magritte.


## Issues & Contact
Please report any issues with Magritte or its documentation
[here](https://github.com/UCL/Magritte/issues).
If you need any further help, please contact
[Frederik De Ceuster](https://www.kuleuven.be/wieiswie/en/person/00101884).


## Cite
Please contact the authors of the papers referenced above if you want to use
Magritte in your research. We are currently working on documentation and
examples to facilitate its independent use. Until then, please
[contact us](https://www.kuleuven.be/wieiswie/en/person/00101884).


## Developers & Contributors
**Developers**
* Frederik De Ceuster
* Thomas Ceulemans
* Atulit Srivastava

**Scientific & Technical advisors**
* Ward Homan
* Jan Bolte
* Jeremy Yates
* Leen Decin
* Peter Boyle
* James Hetherington

**Contributors**
* Silke Maes
* Jolien Malfait


## Acknowledgements
FDC is supported by the EPSRC iCASE studentship programme, Intel Corporation and Cray Inc.
FDC, JB, WH, and LD acknowledge support from the ERC consolidator grant 646758 AEROSOL.