Skip to content

Commit

Permalink
several changes to the structure
Browse files Browse the repository at this point in the history
  • Loading branch information
wkerzendorf committed Jul 19, 2019
1 parent c9cd958 commit 470c081
Show file tree
Hide file tree
Showing 14 changed files with 32 additions and 22 deletions.
24 changes: 16 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,20 @@ assistance.



.. toctree::
:maxdepth: 2

installation


============
Using Tardis
Using TARDIS
============

.. toctree::
:maxdepth: 2
:caption: Using TARDIS

installation
CHANGELOG.md
quickstart
running/index
examples/index
Expand All @@ -52,37 +57,40 @@ Physics of TARDIS

.. toctree::
:maxdepth: 2
:caption: The Physics of TARDIS

atomic/atomic_data
physics/index
montecarlo/index

====
Team
====

.. toctree::
:maxdepth: 2
:caption: Team & Credits

team
credits

=================
Developing Tardis
=================
================
Developers Guide
================

.. toctree::
:maxdepth: 2
:caption: Developers Guide

issues
workflow/development_workflow
running_tests
CHANGELOG.md

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

.. toctree::
:caption: References
zreferences

====
Expand Down
16 changes: 8 additions & 8 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ simple TARDIS calculations.

.. warning::

TARDIS is currently only compatbile with Python 2.7.
TARDIS is only compatbile with Python >3.6

.. note::
We strongly recommond to install TARDIS within an Anaconda environment and
We strongly recommend to install TARDIS within an Anaconda environment and
to always use the lastest github development version.

Requirements
============

You can see a list of all the requirements of TARDIS in the `environment definition file <https://raw.githubusercontent.com/tardis-sn/tardis/master/tardis_env27.yml>`_.
You can see a list of all the requirements of TARDIS in the `environment definition file <https://raw.githubusercontent.com/tardis-sn/tardis/master/tardis_env3.yml>`_.

TARDIS is using astropy's excellent installation helpers and thus uses similar
instructions to astropy.
TARDIS is using Astropy's excellent installation helpers and thus uses similar
instructions to Astropy.

.. _anaconda_inst_label:

Expand All @@ -45,13 +45,13 @@ machine. The next step is to create an environment for TARDIS that contains all
of the necessary packages (this ensures that TARDIS requirements won't clash
with any other python installs on disc::

First, download the `environment definition file <https://raw.githubusercontent.com/tardis-sn/tardis/master/tardis_env27.yml>`_ from::
First, download the `environment definition file <https://raw.githubusercontent.com/tardis-sn/tardis/master/tardis_env3.yml>`_ from::

https://raw.githubusercontent.com/tardis-sn/tardis/master/tardis_env27.yml
https://raw.githubusercontent.com/tardis-sn/tardis/master/tardis_env3.yml

To create the environment, change to the directory that you downloaded the environment definition file and run::

conda env create -f tardis_env27.yml
conda env create -f tardis_env3.yml

Then to activate this environment simply do::

Expand Down
2 changes: 2 additions & 0 deletions docs/news.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


GSOC 2017
---------

Expand Down
12 changes: 6 additions & 6 deletions docs/physics/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
************************************
Behind the scenes: Physics of TARDIS
************************************
*****************
Physics of TARDIS
*****************

.. warning::

Expand All @@ -23,10 +23,11 @@ Currently some information are available for

.. toctree::
new_plasma
montecarlo/index


Old Physics Section of the TARDIS Docu (Outdated)
======================================
=================================================

.. note::
The following entries reflects the physics section of the old TARDIS
Expand All @@ -37,7 +38,6 @@ Old Physics Section of the TARDIS Docu (Outdated)

.. toctree::
physical_quantities
montecarlo
new_plasma
montecarlo_old
plasma/index

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 470c081

Please sign in to comment.