From 470c08175ff30a1a7f0efdcbf140316b2a4480c9 Mon Sep 17 00:00:00 2001 From: Wolfgang Kerzendorf Date: Thu, 18 Jul 2019 23:47:09 -0400 Subject: [PATCH] several changes to the structure --- docs/index.rst | 24 ++++++++++++------- docs/installation.rst | 16 ++++++------- docs/news.rst | 2 ++ docs/physics/index.rst | 12 +++++----- .../montecarlo/basicprinciples.rst | 0 .../montecarlo/discretization.rst | 0 docs/{ => physics}/montecarlo/estimators.rst | 0 docs/{ => physics}/montecarlo/index.rst | 0 .../montecarlo/lineinteraction.rst | 0 docs/{ => physics}/montecarlo/propagation.rst | 0 .../montecarlo/randomsampling.rst | 0 .../montecarlo/sourceintegration.rst | 0 .../montecarlo/virtualpackets.rst | 0 .../{montecarlo.rst => montecarlo_old.rst} | 0 14 files changed, 32 insertions(+), 22 deletions(-) rename docs/{ => physics}/montecarlo/basicprinciples.rst (100%) rename docs/{ => physics}/montecarlo/discretization.rst (100%) rename docs/{ => physics}/montecarlo/estimators.rst (100%) rename docs/{ => physics}/montecarlo/index.rst (100%) rename docs/{ => physics}/montecarlo/lineinteraction.rst (100%) rename docs/{ => physics}/montecarlo/propagation.rst (100%) rename docs/{ => physics}/montecarlo/randomsampling.rst (100%) rename docs/{ => physics}/montecarlo/sourceintegration.rst (100%) rename docs/{ => physics}/montecarlo/virtualpackets.rst (100%) rename docs/physics/{montecarlo.rst => montecarlo_old.rst} (100%) diff --git a/docs/index.rst b/docs/index.rst index 4b2aa575bad..abd9f095fe9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 @@ -52,10 +57,9 @@ Physics of TARDIS .. toctree:: :maxdepth: 2 + :caption: The Physics of TARDIS - atomic/atomic_data physics/index - montecarlo/index ==== Team @@ -63,26 +67,30 @@ 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 ==== diff --git a/docs/installation.rst b/docs/installation.rst index 91e1d10406d..307dd3b1a23 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -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 `_. +You can see a list of all the requirements of TARDIS in the `environment definition file `_. -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: @@ -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 `_ from:: +First, download the `environment definition file `_ 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:: diff --git a/docs/news.rst b/docs/news.rst index 4ded50877ff..a9773400a91 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -1,3 +1,5 @@ + + GSOC 2017 --------- diff --git a/docs/physics/index.rst b/docs/physics/index.rst index 0a4697f2472..ce7f8b15dbe 100644 --- a/docs/physics/index.rst +++ b/docs/physics/index.rst @@ -1,6 +1,6 @@ -************************************ -Behind the scenes: Physics of TARDIS -************************************ +***************** +Physics of TARDIS +***************** .. warning:: @@ -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 @@ -37,7 +38,6 @@ Old Physics Section of the TARDIS Docu (Outdated) .. toctree:: physical_quantities - montecarlo - new_plasma + montecarlo_old plasma/index diff --git a/docs/montecarlo/basicprinciples.rst b/docs/physics/montecarlo/basicprinciples.rst similarity index 100% rename from docs/montecarlo/basicprinciples.rst rename to docs/physics/montecarlo/basicprinciples.rst diff --git a/docs/montecarlo/discretization.rst b/docs/physics/montecarlo/discretization.rst similarity index 100% rename from docs/montecarlo/discretization.rst rename to docs/physics/montecarlo/discretization.rst diff --git a/docs/montecarlo/estimators.rst b/docs/physics/montecarlo/estimators.rst similarity index 100% rename from docs/montecarlo/estimators.rst rename to docs/physics/montecarlo/estimators.rst diff --git a/docs/montecarlo/index.rst b/docs/physics/montecarlo/index.rst similarity index 100% rename from docs/montecarlo/index.rst rename to docs/physics/montecarlo/index.rst diff --git a/docs/montecarlo/lineinteraction.rst b/docs/physics/montecarlo/lineinteraction.rst similarity index 100% rename from docs/montecarlo/lineinteraction.rst rename to docs/physics/montecarlo/lineinteraction.rst diff --git a/docs/montecarlo/propagation.rst b/docs/physics/montecarlo/propagation.rst similarity index 100% rename from docs/montecarlo/propagation.rst rename to docs/physics/montecarlo/propagation.rst diff --git a/docs/montecarlo/randomsampling.rst b/docs/physics/montecarlo/randomsampling.rst similarity index 100% rename from docs/montecarlo/randomsampling.rst rename to docs/physics/montecarlo/randomsampling.rst diff --git a/docs/montecarlo/sourceintegration.rst b/docs/physics/montecarlo/sourceintegration.rst similarity index 100% rename from docs/montecarlo/sourceintegration.rst rename to docs/physics/montecarlo/sourceintegration.rst diff --git a/docs/montecarlo/virtualpackets.rst b/docs/physics/montecarlo/virtualpackets.rst similarity index 100% rename from docs/montecarlo/virtualpackets.rst rename to docs/physics/montecarlo/virtualpackets.rst diff --git a/docs/physics/montecarlo.rst b/docs/physics/montecarlo_old.rst similarity index 100% rename from docs/physics/montecarlo.rst rename to docs/physics/montecarlo_old.rst