Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update to download atomic databases #91

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
------------------
Expand Down
11 changes: 11 additions & 0 deletions docs/atomic/atomic_data.rst
Original file line number Diff line number Diff line change
@@ -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


7 changes: 4 additions & 3 deletions docs/atomic.rst → docs/atomic/atomic_data_description.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.. _atomic-data:
.. _atomic-data-descritpion:

Atomic Data
===========
******************************
Atomic Data Format Description
******************************
.. currentmodule:: tardis.atomic


Expand Down
32 changes: 32 additions & 0 deletions docs/atomic/current_public_table.rst

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
================

Expand Down