From 9aad49ef8d52f2794efdf660b182af6aed191e97 Mon Sep 17 00:00:00 2001 From: Wolfgang Kerzendorf Date: Wed, 18 Feb 2015 18:46:08 +0100 Subject: [PATCH 1/2] added the anaconda installation procedure to the documentation --- docs/installation.rst | 46 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 43 insertions(+), 3 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index d6cd97d4472..6baff048b3a 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -30,15 +30,55 @@ TARDIS has the following requirements: - `pyyaml `_ 3.0 or later Most of these requirements are easy to install using package managers like -OS X's macports or linux package managers. +OS X's macports or linux package managers or using the Anaconda python +distribution. TARDIS is using astropy's excellent installation helpers and thus uses similar instructions to astropy. -Installing TARDIS with virtualenvs (recommended) + +Installing TARDIS with Anaconda (recommended) +============================================= + +We highly recommend using the Anaconda python environment to install TARDIS (or + any other scientific packages for that matter). Anaconda has the advantage of + being an isolated environment that can be set to be the default one, but +by no means will mess with your other environments. It will also work on +computers where ``root``-rights are not available. Use these +`instructions `_ to install +Anaconda on your 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:: + + conda create -n tardis-release --file https://raw.githubusercontent.com/tardis-sn/tardis/master/pip-requirements python=2 pip + +Then to activate this environment simply do:: + + source activate tardis-release + +and after you are done with TARDIS you can deactivate:: + + source deactivate + +One does not need to recreate the environment, but simply activate it everytime +TARDIS is used. + +To install the latest stable version of TARDIS simply do:: + + pip install tardis-sn + +or to use the development version:: + + pip install git+https://github.com/tardis-sn/tardis + + + + + +Installing TARDIS with virtualenvs ================================================ -We highly recommend installing TARDIS in a virtual environment. A virtual +A virtual environment is python's way to ensure that the versions of third-party libraries that TARDIS requires do not interfere with the system-wide installation. This is also the way that the majority of core developers for TARDIS operate. From 383552427134fe1ca64181c7c3c15cd568894801 Mon Sep 17 00:00:00 2001 From: Wolfgang Kerzendorf Date: Wed, 18 Feb 2015 18:47:30 +0100 Subject: [PATCH 2/2] added the running and development sections to the installation document --- docs/installation.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/installation.rst b/docs/installation.rst index 6baff048b3a..5199869ff9f 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -36,6 +36,14 @@ distribution. TARDIS is using astropy's excellent installation helpers and thus uses similar instructions to astropy. +If you are interested in doing some development for TARDIS please read +:doc:`workflow/development_workflow`. + + +Once you are done you can run the simple example listed in :doc:`running`. + + + Installing TARDIS with Anaconda (recommended) =============================================