Skip to content

Commit

Permalink
documentation change
Browse files Browse the repository at this point in the history
  • Loading branch information
ssim committed Jan 27, 2014
1 parent 14a46b6 commit 1007faf
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 34 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ We are using Astropy's excellent workflow - more details can be found at `<http:
installation
running
gui
uses
atomic
plasma
montecarlo
Expand Down
34 changes: 0 additions & 34 deletions docs/running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,37 +47,3 @@ Graphical User Interface

A graphical user interface is being developed for this code using QT. We envision to have this available in the next few minor releases.


**************************
What can I do with TARDIS?
**************************

TARDIS is designed to carry out calculations of synthetic supernova spectra (see Kerzendorf & Sim 2014). A TARDIS calculation requires

1) a model for the supernova eject (density and composition distribution) to be specified;
2) parameters determining the physical and numerical properties of the code are give.

These inputs are specified via the input file (yaml file). As a starting point, examine the input file in the example download (above). The example file sets up a very simple model in which the density distribution is based on the well-known W7 model () and in which uniform abundances are specified. To get you started, here is a short list of settings that can be experimented with to get a feel for using TARDIS. Please contact us if you have questions or woudl like information on more advanced possibilities!

Change the abundances
---------------------

In the example file you can alter the elemental abundances (mass fractions; specified in the "abundances" section). Use this to explore the sensitivity of features to composition.

Change the luminosity
---------------------

You can alter the (emergent) luminosity and see how this affects the synthetic spectrum. Do this by varying the "luminosity requested" in the "supernova" section.

Change the epoch
----------------

In the example file, you can change the epoch for which the synthetic spectrum is calculated (change the value of "time explosion"; specified in the "supernova" section). When doing this you might also change the inner boundary velocity ("start" value in the "velocity" section), and probably the luminosity (see above)!

Experiment with the treatment of line opacity
---------------------------------------------

In the "plasma" section you can change the "line interaction type" between "scatter", "downbranch" and "macroatom" - investigate how important fluorescence is in your synthetic spectrum. (See Kerzendorf & Sim and references therein for the meaning of these settings.)



33 changes: 33 additions & 0 deletions docs/uses.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
**************************
What can I do with TARDIS?
**************************

TARDIS is designed to carry out calculations of synthetic supernova spectra (see Kerzendorf & Sim 2014). A TARDIS calculation requires

1) a model for the supernova eject (density and composition distribution) to be specified;
2) parameters determining the physical and numerical properties of the code are give.

These inputs are specified via the input file (yaml file). As a starting point, examine the input file in the example download (above). The example file sets up a very simple model in which the density distribution is based on the well-known W7 model () and in which uniform abundances are specified. To get you started, here is a short list of settings that can be experimented with to get a feel for using TARDIS. Please contact us if you have questions or woudl like information on more advanced possibilities!

Change the abundances
===============

In the example file you can alter the elemental abundances (mass fractions; specified in the "abundances" section). Use this to explore the sensitivity of features to composition.

Change the luminosity
==============

You can alter the (emergent) luminosity and see how this affects the synthetic spectrum. Do this by varying the "luminosity requested" in the "supernova" section.

Change the epoch
===========

In the example file, you can change the epoch for which the synthetic spectrum is calculated (change the value of "time explosion"; specified in the "supernova" section). When doing this you might also change the inner boundary velocity ("start" value in the "velocity" section), and probably the luminosity (see above)!

Experiment with the treatment of line opacity
=============================

In the "plasma" section you can change the "line interaction type" between "scatter", "downbranch" and "macroatom" - investigate how important fluorescence is in your synthetic spectrum. (See Kerzendorf & Sim and references therein for the meaning of these settings.)



0 comments on commit 1007faf

Please sign in to comment.