Skip to content

Commit

Permalink
added a description for the installation
Browse files Browse the repository at this point in the history
  • Loading branch information
wkerzendorf committed Jul 1, 2015
1 parent c534eb2 commit 2a94789
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 14 deletions.
File renamed without changes.
15 changes: 3 additions & 12 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -133,16 +133,7 @@ doctest:
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."


GH_PAGES_SOURCES = _templates

gh-pages:
git checkout gh-pages
rm -rf build _sources _static
git checkout master $(GH_PAGES_SOURCES)
git reset HEAD
make html
mv -fv build/html/* ./
rm -rf $(GH_PAGES_SOURCES) build
git add -A
git ci -m "Generated gh-pages for `git log master -1 --pretty=short --abbrev-commit`" && git push origin gh-pages ; git checkout master
git checkout gh-pages
rm -rf *
git checkout master tardisnuclear docs
24 changes: 22 additions & 2 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,27 @@ Installation

``tardisnuclear`` has several dependencies that are easiest installed via
`Anaconda <http://continuum.io/downloads>`_ and all further instructions will
assume that you use that for your installation. The first package that needs
to be installed is pyne::
assume that you use that for your installation.

We will first clone the github repository of tardisnuclear::

git clone https://github.com/tardis-sn/tardisnuclear.git
cd tardisnuclear

Next we will create an environment that has exactly the libraries needed for
tardisnuclear to run::

conda create -n tardisnuclear python=2 --file conda-requirements

Then activate it::

source activate tardisnuclear


A further important packate that needs to be installed is pyne::

conda install -c cyclus -c pyne pyne=0.5.0

and then we are ready to install tardisnuclear with::

python setup.py install

0 comments on commit 2a94789

Please sign in to comment.