.. DIRTY documentation master file, created by
   sphinx-quickstart on Mon Sep 10 13:56:31 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

######################################
DIRTY: DustI Radiative Transfer, Yeah!
######################################

The DIRTY radiative tranfer/dust emission model for dusty astrophysical
sources.  DIRTY solves the radiative transfer problem in full 3D including
non-equilibrium and equilibrium thermal dust emission.

User Documentation
==================

.. toctree::
  :maxdepth: 1

  Frequently Asked Questions <faq.rst>
  Parameter File <parameter_file.rst>
  Dust Grains <dust_grains.rst>

Installation
============

.. toctree::
 :maxdepth: 2

 How to install <install.rst>

Repository
==========

GitHub: `DIRTY_dustrt <https://github.com/karllark/DIRTY_dustrt>`_

Quick Start
===========

make

create a parameter file

dirty parameter_file

rinse, repeat

Reporting Issues
================

If you have found a bug in ``DIRTY_dustrt`` please report it by creating a
new issue on the ``DIRTY_dustrt`` `GitHub issue tracker
<https://github.com/karllark/DIRTY_dustrt/issues>`_.

Please include an example that demonstrates the issue sufficiently so that
the developers can reproduce and fix the problem.

Contributing
============

``DIRTY_dustrt`` is made both by and for its
users.  We accept contributions at all levels, spanning the gamut from
fixing a typo in the documentation to developing a major new feature.
While DIRTY is not written in python, we welcome contributors who will
abide by the `Python Software Foundation Code of Conduct
<https://www.python.org/psf/codeofconduct/>`_.

For the complete list of contributors please see the `DIRTY_dustrt
contributors page on Github
<https://github.com/karllark/DIRTY_dustrt/graphs/contributors>`_.