Skip to content

cpinte/mcfost

Repository files navigation

The MCFOST radiative transfer code



test-suite Documentation Status

About

MCFOST is a 3D continuum and line radiative transfer code based on an hybrid Monte Carlo and ray-tracing method. It is mainly designed to study the circumstellar environment of young stellar objects, but has been used for a wide range of astrophysical problems. The calculations are done exactly within the limitations of the Monte Carlo noise and machine precision, i.e. no approximation are used in the calculations. The code has been strongly optimized for speed.

Code of conduct

If you wish to use the code, please make sure you agree to adhere to the code of conduct.

Code Papers

Core papers :

Radiative transfer in atomic lines:

Licence

See LICENCE file for usage and distribution conditions.

The code is open source under GPLv3. We also kindly ask you cite the code papers in scientific publications if you are using the code in your research.

If the code is useful for your research, please get in touch with us. We welcome scientific collaborations, and hopefully we will be able to help.

Contributing

We welcome contributions, including (but not limited to):

  1. Code, via pull request. Please read the developer section of the user guide for guidelines. We use the pre-commit framework to automatically fix some coding bad practices. It is recommended to install pre-commit by running the following commands from the top level of the repo
python3 -m pip install pre-commit
pre-commit install
  1. Documentation, also by pull request. Docs can be edited in the docs/ directory of the main code.
  2. Suggestions for features or bug reports, via the issue tracker. Please file bugs via github rather than by email.

Questions?

Discussions about the code and its use have moved here.

Visualising your results

We suggest to use pymcfost. Alternative options are discussed in the documentation.