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

restructure landing page to use notebooks #833

Merged
merged 6 commits into from
Jun 25, 2018
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: 3 additions & 3 deletions docs/atomic/atomic_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
Atomic Data for TARDIS
**********************

For a detailed description of the datasets go to :doc:`atomic_data_description`

.. include:: current_public_table.rst
.. toctree::
atomic_data_description
current_public_table.rst
4 changes: 0 additions & 4 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
.. _changelog:

*********
Changelog
*********

.. include:: ../CHANGELOG.rst
7 changes: 6 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,12 @@
'sphinxcontrib.bibtex']



nbsphinx_prolog = """
This notebook is available at
https://github.com/tardis-sn/tardis/tree/master/docs/notebooks/
{{ env.doc2path(env.docname, base=None) }}
----
"""
# -- General configuration ----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
Expand Down
36 changes: 36 additions & 0 deletions docs/examples/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
**************
Example Models
**************

The following provides some example setups for a number of typical TARDIS use
cases. You can use these examples as blueprints for your own TARDIS
applications.



.. toctree::
:maxdepth: 2

modelconfig
tardis_example

Simple Parametrized Models
==========================

These setups specify the ejecta solely via the YAML configuration file:

* :doc:`tardis_example <tardis_example>`


API demonstrations
=========================

An example on how to use the formal integrator with tardis:

:ref:`notebooks/integrator.ipynb`


Detailed Explosion Models
=========================

Coming soon
13 changes: 8 additions & 5 deletions docs/examples/modelconfig.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,15 @@ The density and composition may be specified independently in the following ways
Specifying the density
======================

* :doc:`using a power-law density profile <densitypow>`
* :doc:`using an exponential density profile <densityexp>`
* :doc:`using a custom density profile <densitycust>`
.. toctree::
densitypow
densityexp
densitycust


Specifying the composition
==========================

* :doc:`using a uniform composition <abundanceuni>`
* :doc:`using a custom stratified composition <abundancecust>`
.. toctree::
abundanceuni
abundancecust
39 changes: 24 additions & 15 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,36 +33,45 @@ acknowledge it by citing :cite:`Kerzendorf2014`.
Using Tardis
============

* :doc:`Installation <installation>`
* :doc:`Quickstart Guide <running>`
* :doc:`Ejecta Model Setup <examples/modelconfig>`
* :doc:`TARDIS Configuration <configuration/index>`
* :doc:`Examples <examples/examples>`
* :doc:`Storing simulations to HDF <to_hdf>`
* :doc:`Helper Scripts <scripts/index>`
* :doc:`Credit & Publication Policies <credits>`
.. toctree::
:maxdepth: 2

installation
running
examples/index
scripts/index
credits

======================
Looking under the hood
======================

* :doc:`Physics behind TARDIS <physics/index>`
* :doc:`Monte Carlo Primer <montecarlo/index>`
.. toctree::
:maxdepth: 2

atomic
physics/index
montecarlo/index


=================
Developing Tardis
=================

* :doc:`Reporting Issues <issues>`
* :doc:`How to contribute <workflow/development_workflow>`
* :doc:`Running tests <running_tests>`
* :doc:`Changelog <changelog>`
.. toctree::
:maxdepth: 2

issues
workflow/development_workflow
runnints_tests
changelog

==========
References
==========

* :doc:`Studies using TARDIS and TARDIS references <zreferences>`
.. toctree::
zreferences

====
News
Expand Down
10 changes: 10 additions & 0 deletions docs/montecarlo/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ can also be found in various papers by L. Lucy and in the main TARDIS publicatio
:cite:`Long2002`, :cite:`Lucy2002`, :cite:`Lucy2003`, :cite:`Lucy2005`,
:cite:`Kerzendorf2014`)

.. toctree::
basicprinciples
discretization
propagation
lineinteraction
estimators
virtualpackets
sourceintegration
randomsampling

* :doc:`Basic Principles of Monte Carlo Radiative Transfer <basicprinciples>`
* :doc:`Monte Carlo discretization <discretization>`
* :doc:`Propagation of Monte Carlo quanta <propagation>`
Expand Down
13 changes: 8 additions & 5 deletions docs/physics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Eventually, information about the following topics will be provided

Currently some information are available for

* :doc:`Plasma State Calculation <new_plasma>`
.. toctree::
new_plasma


Old Physics Section of the TARDIS Docu (Outdated)
Expand All @@ -33,8 +34,10 @@ Old Physics Section of the TARDIS Docu (Outdated)
outdated, many basic concepts are still applicable to the current TARDIS
version.

* :doc:`physical_quantities`
* :doc:`montecarlo`
* :doc:`new_plasma`
* :doc:`plasma/index`

.. toctree::
physical_quantities
montecarlo
new_plasma
plasma/index

2 changes: 1 addition & 1 deletion docs/physics/plasma/lte_plasma.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ the quantities calculated here.
Example Calculations
^^^^^^^^^^^^^^^^^^^^

.. plot:: physics/plasma/plasma_plots/lte_ionization_balance.py
.. .. plot:: physics/plasma/plasma_plots/lte_ionization_balance.py
:include-source:

2 changes: 1 addition & 1 deletion docs/physics/plasma/nebular_plasma.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,6 @@ the quantities calculated here.
Example Calculations
^^^^^^^^^^^^^^^^^^^^

.. plot:: physics/plasma/plasma_plots/nebular_ionization_balance.py
.. .. plot:: physics/plasma/plasma_plots/nebular_ionization_balance.py
:include-source: