Merge pull request #91 from wkerzendorf/documentation/download_atomic…

…_datasets Documentation update to download atomic databases
tardis-sn · Apr 1, 2014 · 2f47ee5 · 2f47ee5
2 parents b8306de + e6e8e47
commit 2f47ee5
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 5 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -9,6 +9,12 @@ Bugfixes
 - warning added to documentation since plasma is out of date (temp
   solution only) #108
 
+New Features
+^^^^^^^^^^^^
+- added data_sources and version to `AtomData` set
+- added atomic database table with downloads to documentation
+- added more conversion routines for Species strings (e.g. Si IX) to util
+
 
 0.9.1 (2014-02-03)
 ------------------

diff --git a/docs/atomic/atomic_data.rst b/docs/atomic/atomic_data.rst
@@ -0,0 +1,11 @@
+.. _atomic-data-download:
+
+**********************
+Atomic Data for TARDIS
+**********************
+
+For a detailed description of the datasets go to :doc:`atomic_data_description`
+
+.. include:: current_public_table.rst
+
+
diff --git a/docs/atomic.rst → docs/atomic/atomic_data_description.rst b/docs/atomic.rst → docs/atomic/atomic_data_description.rst
@@ -1,7 +1,8 @@
-.. _atomic-data:
+.. _atomic-data-descritpion:
 
-Atomic Data
-===========
+******************************
+Atomic Data Format Description
+******************************
 .. currentmodule:: tardis.atomic
 
 

diff --git a/docs/atomic/current_public_table.rst b/docs/atomic/current_public_table.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,11 +13,10 @@ rapid spectral modelling of supernovae. The code is described in this documentat
 
     installation
     running
-    gui
     uses
     examples/examples
     testing
-    atomic
+    atomic/atomic_data
     plasma
     montecarlo
     changelog

diff --git a/docs/running.rst b/docs/running.rst
@@ -13,6 +13,7 @@ Simple Example
 After installing TARDIS just download the example directory `<https://www.dropbox.com/s/svvyr5i7m8ouzdt/tardis_example.tar.gz>`_
 and run TARDIS with:
 
+
 .. code-block:: none
 
     tar zxvf tardis_example.tar.gz
@@ -31,6 +32,9 @@ Then plot the output_spectrum.dat with your favourite plotting program. Here's a
     plot(tardis_spec[:,0], tardis_spec[:,1])
 
 
+More atomic datasets can be downloaded from :ref:`atomic-data-download`.
+
+
 Scripting TARDIS
 ================