# The Template Test

This page cannot be edited. To use the template copy the following code into a new page. To see what the template will look like, click here. An ASCII file of the template can be downloaded here.

====== The Template Test ======

Start with a killer-graphic that encapsulates what the test is all about:\\
{{:template.png?300}}

===== Overview =====

==== Description ====
Brief description of the test.

==== Included physics ====
Specify which physics are being tested.

==== Purpose ====
The point in doing the test in the first place.

==== Analytical solution ====
If there is an analytic solution to the test put this (or a reference to it) here.

==== Publications using this test ====
List published/posted papers involving this test here.

==== Useful references ====
Relevant background reading, or similar tests to be referenced here. This can also cross-reference other pages within this wiki.

===== Details of setup =====
==== Units and constants ====
** very important ** please specify the units and physical constants adopted in the test. This is usually only relevant for understanding the initial conditions and set-up. The following units/constants are an example; they will not all be relevant for every test:

**//mass_unit//** = ? \\
**//velocity_unit//** = ? \\
**//length_unit//** = ?\\
**//time_unit//** = ? \\
**//energy_per_unit_mass_unit//** = ? \\
**//gas_const//** ? \\
**//thermal energy U//** = ? \\

**//adiabatic index gamma//**=5/3 \\
**//mean molar mass, mu//**=1.0 \\

You may prefer to specify the units using LaTeX, e.g.:

<latex>M = \mathrm{M}_\odot</latex>\\
<latex>L = \mathrm{kpc}</latex>\\
<latex>T = \mathrm{Gyrs}</latex>\\
<latex>V = \mathrm{km/s}</latex>\\

==== Initial Conditions ====
Carefully describe the initial conditions here. Please include the actual files! (see below).

==== Files ====
Add the initial conditions files here. Please make sure that your file format is described in [[:home:fileformats]].

|                 ^ ASCII file                   ^ File format 2  ^
^ Simulation 1    | {{:example.txt|example.txt}} | file         |
^ Simulation 2    | file                         | file         |

It would be good to always add the following: //Please see [[:home:fileformats]] for a description of the above file formats and a collection of conversion tools.//

===== How to analyse the test? =====
Describe here how the test is analysed and how it can be compared with results from other simulations, or to analytic results. It would be helpful to include a link to the analysis software used. It would be good to always add the following: //Please see [[:home:code:analysistools]] to obtain the above analysis tools.//

==== Examples ====
List here some example results from the test and describe their implications. Typically this will mean posting a couple of results figures.

====== Tests run so far ======
Describe here the software used to perform the test and the results. We recommend using separate pages for each piece of software, though many can be presented simultaneously if this is more convenient. The former is more work, but is also more easily expanded upon in the future. Please store these tests in the namespace //indcodetests//, e.g.:

<file>
indcodetests:mytest:myfavecode
</file>

so that these do not appear in the menu in the side bar.

^ Code                                 ^ Person ^ Publication ^
| [[indcodetests:template:myfavecode]] | Bob    |             |

====== Discussion forum for this test ======
~~DISCUSSION~~