Commit ed525d52 authored by Zolnierczuk, Piotr's avatar Zolnierczuk, Piotr
Browse files

Merge branch 'pztest' into dev/nexus

parents 0bb8d9ba 986c0d63
Loading
Loading
Loading
Loading
+20 −18
Original line number Diff line number Diff line
DrSPINE Quick Installation Guide
# DrSPINE Quick Installation Guide
===================================

1. Prerequisites
-----------------
## Prerequisites

1. Fortran Compiler
2. GR Framework [https://gr-framework.org]()
3. TeX Live [https://www.tug.org/texlive]()
4. Python and some SciPy packages

### Fortran Compiler
Fortran 2008 compatible compiler, for example
@@ -15,12 +19,10 @@ The DrSPINE report command uses the GR Framework (gr-framework.org).
Follow installation instructions for the C version of the GR library.

### TeX Live
In order to rebuild the documentation or use report feature in DrSPINE
one needs full TeX Live https://www.tug.org/texlive distribution.

Note: it works "out of the box" on Ubuntu (14+) and MacOS with Tex Live 2016 or newer.
RedHat/CentOS 7 requires extra packages that have to be downloaded from the CTAN archive.
In order to use the report features in DrSPINE and build the documentation
one needs TeX Live https://www.tug.org/texlive distribution.

*Note: it works "out of the box" on Ubuntu (14+) and MacOS with Tex Live 2016 or newer. RedHat 7 requires extra packages that have to be downloaded from the CTAN archive*.

### Python
In order to use 'plot' command in DrSPINE one needs Python v3 interpreter
@@ -35,13 +37,13 @@ with the following command:

	`conda install ipython matplotlib numpy scipy`


 b) Or install full Anaconda Python distribution,
see [Anaconda website](https://docs.anaconda.com/anaconda/install for details).
 see [Anaconda website](https://docs.anaconda.com/anaconda/install for
 details).



2. Installation
-----------------
## Installation

### Create/edit Makefile.def
The defaults should work in most cases. Edit only if needed.
@@ -73,7 +75,7 @@ or, alternatively, build for J-NSE

    make all install INSTRUMENT=2 

### First time use
## First time use
Before using DrSPINE one needs to set-up the IPython profile: do it only once!

    source $HOME/local/bin/drspine_create_env.sh