add converters

tardis-sn · Jul 22, 2019 · cf35dfc · cf35dfc
1 parent e0f5a04
commit cf35dfc
Show file tree

Hide file tree

Showing 21 changed files with 34 additions and 9 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,7 +19,7 @@ TARDIS is an open-source Monte Carlo radiative-transfer spectral synthesis code
 for 1D models of supernova ejecta. It is designed for rapid spectral modelling
 of supernovae. It is developed and maintained by a :ref:`multi-disciplinary team <team>`
 including software engineers, computer scientists, statisticians,
-and astrophysicists. `--- dsfjsdlkfjsdlf`
+and astrophysicists.
 
 If you use this code for any publications or presentations please follow our
 citation guidelines in :ref:`tardiscredits`

diff --git a/docs/models/examples/index.rst b/docs/models/examples/index.rst
@@ -13,7 +13,7 @@ applications.
 
     modelconfig
     tardis_example
-    stella_to_tardis
+
 
 Simple Parametrized Models
 ==========================

diff --git a/docs/models/index.rst b/docs/models/index.rst
@@ -43,6 +43,13 @@ to define custom density and abundance profiles in separate files and reference
 these files directly in the main TARDIS configuration file. For further details,
 see the following links:
 
-* For general information: :ref:`modelconfig`
-* For defining a custom density file: :ref:`densitycust`
-* For defining a custom abundance file: :ref:`abundancecust`
+.. toctree::
+    :maxdepth: 1
+
+    examples/modelconfig
+    examples/densityexp
+    examples/densitypow
+    examples/densitycust
+    examples/abundanceuni
+    examples/abundancecust
+
diff --git a/docs/scripts/cmfgen.rst → docs/running/converters/cmfgen.rst b/docs/scripts/cmfgen.rst → docs/running/converters/cmfgen.rst
diff --git a/docs/running/converters/index.rst b/docs/running/converters/index.rst
@@ -0,0 +1,13 @@
+==========
+Converters
+==========
+
+There are a variety of formats for models from other codes
+(both hydro and radiative transfer) that can be converted to TARDIS input files.
+Here we aim to provide converters for the most commonly used file formats.
+
+.. toctree::
+    :maxdepth: 2
+
+    stella_to_tardis
+    cmfgen
diff --git a/docs/models/examples/mesa.stella.dat → docs/running/converters/mesa.stella.dat b/docs/models/examples/mesa.stella.dat → docs/running/converters/mesa.stella.dat
diff --git a/docs/models/examples/stella_to_tardis.ipynb → ...running/converters/stella_to_tardis.ipynb b/docs/models/examples/stella_to_tardis.ipynb → ...running/converters/stella_to_tardis.ipynb
diff --git a/docs/running/index.rst b/docs/running/index.rst
@@ -7,7 +7,6 @@ The TARDIS code needs three components to calculate spectra:
 
 .. toctree::
     :maxdepth: 1
-    :numbered:
 
     ../models/index
     ../configuration/index
@@ -24,7 +23,13 @@ A quick start guide to run TARDIS can be found
 
     commandline
     gui
-    notebooks/index.rst
+    interaction/index
+
+
+.. toctree::
+    :maxdepth: 2
+
+    converters/index
 
 
 

diff --git a/...ebooks/Custom_TARDIS_Model_Tutorial.ipynb → ...action/Custom_TARDIS_Model_Tutorial.ipynb b/...ebooks/Custom_TARDIS_Model_Tutorial.ipynb → ...action/Custom_TARDIS_Model_Tutorial.ipynb
diff --git a/docs/running/access.rst → docs/running/interaction/access.rst b/docs/running/access.rst → docs/running/interaction/access.rst
diff --git a/docs/running/access_iterations.rst → ...running/interaction/access_iterations.rst b/docs/running/access_iterations.rst → ...running/interaction/access_iterations.rst
diff --git a/docs/running/notebooks/data/abund.dat → docs/running/interaction/data/abund.dat b/docs/running/notebooks/data/abund.dat → docs/running/interaction/data/abund.dat
diff --git a/...nning/notebooks/data/config_init_trad.yml → ...ing/interaction/data/config_init_trad.yml b/...nning/notebooks/data/config_init_trad.yml → ...ing/interaction/data/config_init_trad.yml
diff --git a/...ng/notebooks/data/config_no_init_trad.yml → .../interaction/data/config_no_init_trad.yml b/...ng/notebooks/data/config_no_init_trad.yml → .../interaction/data/config_no_init_trad.yml
diff --git a/docs/running/notebooks/data/density.txt → docs/running/interaction/data/density.txt b/docs/running/notebooks/data/density.txt → docs/running/interaction/data/density.txt
diff --git a/docs/running/notebooks/hdf_writer.ipynb → docs/running/interaction/hdf_writer.ipynb b/docs/running/notebooks/hdf_writer.ipynb → docs/running/interaction/hdf_writer.ipynb
diff --git a/docs/running/notebooks/index.rst → docs/running/interaction/index.rst b/docs/running/notebooks/index.rst → docs/running/interaction/index.rst
@@ -1,5 +1,5 @@
-TARDIS interactive runs
-==================================================
+Interacting with TARDIS
+=======================
 
 To get more information from each run of TARDIS one can run it interactively and
 have full access to the model properties (as described in :ref:`physical_quantities`)

diff --git a/docs/running/notebooks/init_trad_bug.ipynb → docs/running/interaction/init_trad_bug.ipynb b/docs/running/notebooks/init_trad_bug.ipynb → docs/running/interaction/init_trad_bug.ipynb
diff --git a/docs/models/examples/integrator.ipynb → docs/running/interaction/integrator.ipynb b/docs/models/examples/integrator.ipynb → docs/running/interaction/integrator.ipynb
diff --git a/...nning/notebooks/isotope_pd_subclass.ipynb → ...ing/interaction/isotope_pd_subclass.ipynb b/...nning/notebooks/isotope_pd_subclass.ipynb → ...ing/interaction/isotope_pd_subclass.ipynb
diff --git a/docs/running/notebooks/to_hdf.ipynb → docs/running/interaction/to_hdf.ipynb b/docs/running/notebooks/to_hdf.ipynb → docs/running/interaction/to_hdf.ipynb