From cec0f359aa33337fd50f40391c6505ec1d2a5120 Mon Sep 17 00:00:00 2001 From: Wolfgang Kerzendorf Date: Fri, 10 Feb 2017 11:40:07 +0100 Subject: [PATCH 1/2] add new installation instructions --- docs/installation.rst | 95 +++---------------------------------------- 1 file changed, 6 insertions(+), 89 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 417095ce8d9..6d50d706fbb 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -5,8 +5,8 @@ Installation ************ Before installing TARDIS, please check its :ref:`requirements -`. We provide instructions for multiple ways of installing -TARDIS here, but we strongly recommend to follow the Anaconda :ref:`guide +`. We provide instructions for installing TARDIS using + Anaconda :ref:`guide `. If you encounter problems, consult the :ref:`troubleshooting ` section. Once you have installed TARDIS, check out :doc:`running` for instructions of how to perform @@ -31,8 +31,8 @@ instructions to astropy. .. _anaconda_inst_label: -Installing TARDIS with Anaconda (recommended) -============================================= +Installing TARDIS with Anaconda +=============================== We highly recommend using the Anaconda python environment to install TARDIS (or any other scientific packages for that matter). Anaconda has the advantage of @@ -63,99 +63,16 @@ and after you are done with TARDIS you can deactivate:: One does not need to recreate the environment, but simply activate it every time TARDIS is used. -To install the latest stable version of TARDIS simply do:: - - pip install tardis-sn - -or to use the development version:: +Use the development version:: pip install git+https://github.com/tardis-sn/tardis -Installing TARDIS with virtualenv -================================== - - -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. - -It is nevertheless recommended to install a number of python packages using the -system packagemanager. This ensures that third-party non-python libraries like -`libhdf5`, `lapack`, etc. are installed. - -For OS X we recommend the `macports `_ package -manager:: - - sudo port install python27 py27-scipy py27-numpy py27-virtualenv py27-astropy py27-h5py py27-yaml py27-pandas py27-pip py27-tables - -In Ubuntu 14.04 the pre-requesite install works with this:: - - sudo apt-get install python-virtualenv python-numpy python-pandas python-scipy python-h5py python-yaml ipython python-matplotlib cython git -First use the following guide to install virtualenv and the TARDIS requirements -:doc:`workflow/python_environment`. - -After the virtualenv and the requirements are installed, there are a few options -of how to proceed. - -If one just wants to use TARDIS you can install the latest stable version:: +To install the latest stable version of TARDIS simply do (usually outdated):: pip install tardis-sn -the latest development version can be installed using:: - - pip install git+https://github.com/tardis-sn/tardis - -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 system-wide (not recommended) -=============================================== - -On Ubuntu (14.04) ------------------ - -We use a clean install of Ubuntu 14.04 as one of our testing grounds. Here's how we get TARDIS to run:: - - sudo apt-get install python-dev python-pip python-numpy python-scipy python-h5py python-pandas python-yaml - -We now need to install the newest astropy and we will install everything into our users directory:: - - pip install astropy --user - -Once astropy is installed, install TARDIS:: - - pip install tardis-sn - -.. note:: - pip often tries to take care of many of the dependencies, this might be annoying as they already exist. - Adding `--no-deps` will help with this problem. - - -On MAC OS X (10.8.5) --------------------- - -On a clean install of Mountain Lion, here's how we get TARDIS running:: - -First install `macports `_ - -Use macports to install:: - - sudo port install python27 py27-astropy py27-h5py py27-yaml py27-pandas py27-pip - -Then install TARDIS:: - - pip-2.7 install tardis-sn --user --pre - -Before running, ensure that the directory ~/Library/Python/2.7/bin is in the appropriate path. -.. note:: - This has also been successfully tested on a clean MAC OS 10.9.1 (Mavericks) install. .. _troubleshooting_inst_label: From 2ec183a6c0ee169ca371095df0ba9b2303a47e7e Mon Sep 17 00:00:00 2001 From: Wolfgang Kerzendorf Date: Fri, 10 Feb 2017 11:54:09 +0100 Subject: [PATCH 2/2] Add Ulli's changes --- docs/installation.rst | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 6d50d706fbb..08a25107880 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -20,10 +20,6 @@ Requirements .. warning:: TARDIS only works on 64-bit python installations. -The requirements for running TARDIS are easy to install using package managers like -OS X's macports or Linux package managers or using the Anaconda python -distribution. - 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 @@ -63,7 +59,7 @@ and after you are done with TARDIS you can deactivate:: One does not need to recreate the environment, but simply activate it every time TARDIS is used. -Use the development version:: +Since TARDIS has reached a mature state, we recommend always installing the latest development version:: pip install git+https://github.com/tardis-sn/tardis