Loading INSTALL.md +60 −24 Original line number Diff line number Diff line Loading @@ -5,7 +5,8 @@ DrSPINE Quick Installation Guide ----------------- ### Fortran Compiler - Fortran 2008 compatible compiler Fortran 2008 compatible compiler, for example - GFortran v4.8 or newer - Intel Fortran v12.0 or newer Loading @@ -13,25 +14,30 @@ DrSPINE Quick Installation Guide The report command in DrSPINE uses the GR Framework (gr-framework.org). Follow installation instructions for the C library GR. ### 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,16,20) and MacOS with Tex Live 2016 or newer. RedHat/CentOS 7 requires extra packages to be downloaded from the CTAN archive. ### Python In order to use 'plot' command in DrSPINE one needs Python3 interpreter and several SciPy (scipy.org) packages. In order to use 'plot' command in DrSPINE one needs Python v3 interpreter and several "scientific Python" packages (numpy, scipy, matplotlib and ipython). Two convenient methods exist: a) Install full Anaconda Python distribution, see http://www.continuum.io/anaconda a) Install a "minimal" Anaconda Python distribution - Miniconda, see [Miniconda website](https://docs.conda.io/en/latest/miniconda). Follow installation instructions and install the relevant Python modules with the following command: b) Or install minimal Anaconda - Miniconda, see http://conda.pydata.org/miniconda and then install only relevant scipy and numpy packages with the following command: `conda install ipython matplotlib numpy scipy` conda install ipython matplotlib numpy scipy ### TeX Live In order to rebuild the documentation one needs full TeX Live https://www.tug.org/texlive distribution. Note: it works "out of the box" on Ubuntu (14,16,20) and MacOS with Tex Live 2016 or newer. RedHat 7 requires extra packages to be downloaded from the CTAN archive. b) Or install full Anaconda Python distribution, see [Anaconda website](https://docs.anaconda.com/anaconda/install for details). 2. Installation Loading @@ -43,30 +49,60 @@ The defaults should work in most cases. Edit only if needed. cp Makefile.def.in Makefile.def edit Makefile.def There are five variables that can be adjusted in the Makefile.def file or on the command line as parameters to make command. The defaults are usually safe. # Installation top directory DESTDIR=$(HOME)/local # Default Instrument 1=SNS-NSE, 2=J-NSE INSTRUMENT=1 # Fortran compiler (use ifort or gfortran) FC = gfortran # Fortran compiler flags FCFLAGS = -g #external libraries (set to empty to disable) GRDIR = /usr/local/gr ### Build and install Build DrSPINE for SNS-NSE make INSTRUMENT=1 all && make install DESTDIR=$HOME/local make all install INSTRUMENT=1 or, alternatively, build for J-NSE make INSTRUMENT=2 all && make install DESTDIR=$HOME/local make all install INSTRUMENT=2 ### Set-up the IPython profile Do it only once! ### 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 ### Activate DrSpine environment and run a test ### DrSpine environment One needs to activate DrSPINE environment before using DrSPINE: source $HOME/local/bin/drspine_activate.sh drspine -o /tmp -d $HOME/local/share/drspine \ This has to be done before each DrSPINE session. A convenient shortcut is to add an alias to one's shell init script ($HOME/.bashrc for bash, or $HOME/.zshrc for zsh). alias nse=`source $HOME/local/bin/drspine_activate.sh` so next time before running DrSPINE one would need to type nse ### Testing installation Before proceeding with your own data reduction, it may be worthwile to test the installation with the following command drspine -S -o /tmp -d $HOME/local/share/drspine \ -x $HOME/local/share/drspine/macro_mk ### Add DrSpine environment to your shell initialization script Add the following line If all goes well one should get a plot with S(Q,t)  source $HOME/local/bin/drspine_activate.sh to your $HOME/.bashrc (for bash) or $HOME/.zshrc (for zsh) depending on which shell is your default. Makefile.def.in +4 −4 Original line number Diff line number Diff line # -*- Makefile -*- # vim: filetype=make # Installation DESTDIR=$(HOME) # Installation top directory DESTDIR=$(HOME)/local # Default Instrument 1=SNS-NSE, 2=J-NSE INSTRUMENT=1 # Fortran 2008 compiler (use ifort or gfortran) # Fortran compiler (use ifort or gfortran) FC = gfortran # Fortran 2003 compiler flags # Fortran compiler flags FCFLAGS = -g #external libraries (set to empty to disable) Loading Makefile.version +1 −1 Original line number Diff line number Diff line Loading @@ -3,7 +3,7 @@ export PROJECT=drspine export VERSION_MAJOR=1 export VERSION_MINOR=4 export VERSION_RELEASE=4 export VERSION_RELEASE=5 export PROJLIB=lib$(PROJECT).a export PROJARCH=$(PROJECT)-$(VERSION_MAJOR).$(VERSION_MINOR) Loading doc/quick_install_guide.tex +77 −39 Original line number Diff line number Diff line Loading @@ -8,10 +8,10 @@ Guide}\label{drspine-quick-installation-guide}} \hypertarget{fortran-compiler}{% \subsubsection{Fortran Compiler}\label{fortran-compiler}} Fortran 2008 compatible compiler, for example \begin{itemize} \tightlist \item Fortran 2008 compatible compiler \item GFortran v4.8 or newer \item Loading @@ -24,37 +24,40 @@ Guide}\label{drspine-quick-installation-guide}} The report command in DrSPINE uses the GR Framework (gr-framework.org). Follow installation instructions for the C library GR. \hypertarget{tex-live}{% \subsubsection{TeX Live}\label{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,16,20) and MacOS with Tex Live 2016 or newer. RedHat/CentOS 7 requires extra packages to be downloaded from the CTAN archive. \hypertarget{python}{% \subsubsection{Python}\label{python}} In order to use `plot' command in DrSPINE one needs Python3 interpreter and several SciPy (scipy.org) packages. In order to use `plot' command in DrSPINE one needs Python v3 interpreter and several ``scientific Python'' packages (numpy, scipy, matplotlib and ipython). Two convenient methods exist: \begin{enumerate} \def\labelenumi{\alph{enumi})} \item Install full Anaconda Python distribution, see http://www.continuum.io/anaconda \item Or install minimal Anaconda - Miniconda, see http://conda.pydata.org/miniconda and then install only relevant scipy and numpy packages with the following command: Install a ``minimal'' Anaconda Python distribution - Miniconda, see \href{https://docs.conda.io/en/latest/miniconda}{Miniconda website}. Follow installation instructions and install the relevant Python modules with the following command: conda install ipython matplotlib numpy scipy \texttt{conda\ install\ ipython\ matplotlib\ numpy\ scipy} \item Or install full Anaconda Python distribution, see \href{https://docs.anaconda.com/anaconda/install\%20for\%20details}{Anaconda website}. \end{enumerate} \hypertarget{tex-live}{% \subsubsection{TeX Live}\label{tex-live}} In order to rebuild the documentation one needs full TeX Live https://www.tug.org/texlive distribution. Note: it works ``out of the box'' on Ubuntu (14,16,20) and MacOS with Tex Live 2016 or newer. RedHat 7 requires extra packages to be downloaded from the CTAN archive. \hypertarget{installation}{% \subsection{2. Installation}\label{installation}} Loading @@ -68,51 +71,86 @@ cp Makefile.def.in Makefile.def edit Makefile.def \end{verbatim} There are five variables that can be adjusted in the Makefile.def file or on the command line as parameters to make command. The defaults are usually safe. \begin{verbatim} # Installation top directory DESTDIR=$(HOME)/local # Default Instrument 1=SNS-NSE, 2=J-NSE INSTRUMENT=1 # Fortran compiler (use ifort or gfortran) FC = gfortran # Fortran compiler flags FCFLAGS = -g #external libraries (set to empty to disable) GRDIR = /usr/local/gr \end{verbatim} \hypertarget{build-and-install}{% \subsubsection{Build and install}\label{build-and-install}} Build DrSPINE for SNS-NSE \begin{verbatim} make INSTRUMENT=1 all && make install DESTDIR=$HOME/local make all install INSTRUMENT=1 \end{verbatim} or, alternatively, build for J-NSE \begin{verbatim} make INSTRUMENT=2 all && make install DESTDIR=$HOME/local make all install INSTRUMENT=2 \end{verbatim} \hypertarget{set-up-the-ipython-profile}{% \subsubsection{Set-up the IPython profile}\label{set-up-the-ipython-profile}} \hypertarget{first-time-use}{% \subsubsection{First time use}\label{first-time-use}} Do it only once! Before using DrSPINE one needs to set-up the IPython profile: do it only once! \begin{verbatim} source $HOME/local/bin/drspine_create_env.sh \end{verbatim} \hypertarget{activate-drspine-environment-and-run-a-test}{% \subsubsection{Activate DrSpine environment and run a test}\label{activate-drspine-environment-and-run-a-test}} \hypertarget{drspine-environment}{% \subsubsection{DrSpine environment}\label{drspine-environment}} One needs to activate DrSPINE environment before using DrSPINE: \begin{verbatim} source $HOME/local/bin/drspine_activate.sh \end{verbatim} drspine -o /tmp -d $HOME/local/share/drspine \ -x $HOME/local/share/drspine/macro_mk This has to be done before each DrSPINE session. A convenient shortcut is to add an alias to one's shell init script (\$HOME/.bashrc for bash, or \$HOME/.zshrc for zsh). \begin{verbatim} alias nse=`source $HOME/local/bin/drspine_activate.sh` \end{verbatim} so next time before running DrSPINE one would need to type \begin{verbatim} nse \end{verbatim} \hypertarget{add-drspine-environment-to-your-shell-initialization-script}{% \subsubsection{Add DrSpine environment to your shell initialization script}\label{add-drspine-environment-to-your-shell-initialization-script}} \hypertarget{testing-installation}{% \subsubsection{Testing installation}\label{testing-installation}} Add the following line Before proceeding with your own data reduction, it may be worthwile to test the installation with the following command \begin{verbatim} source $HOME/local/bin/drspine_activate.sh drspine -S -o /tmp -d $HOME/local/share/drspine \ -x $HOME/local/share/drspine/macro_mk \end{verbatim} to your \$HOME/.bashrc (for bash) or \$HOME/.zshrc (for zsh) depending on which shell is your default. If all goes well one should get a plot with S(Q,t) \begin{figure} \centering \includegraphics{test_macro_plot.png} \caption{Example S(Q,t) plot} \end{figure} doc/test_macro_plot.png 0 → 100644 +72.1 KiB Loading image diff... Loading
INSTALL.md +60 −24 Original line number Diff line number Diff line Loading @@ -5,7 +5,8 @@ DrSPINE Quick Installation Guide ----------------- ### Fortran Compiler - Fortran 2008 compatible compiler Fortran 2008 compatible compiler, for example - GFortran v4.8 or newer - Intel Fortran v12.0 or newer Loading @@ -13,25 +14,30 @@ DrSPINE Quick Installation Guide The report command in DrSPINE uses the GR Framework (gr-framework.org). Follow installation instructions for the C library GR. ### 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,16,20) and MacOS with Tex Live 2016 or newer. RedHat/CentOS 7 requires extra packages to be downloaded from the CTAN archive. ### Python In order to use 'plot' command in DrSPINE one needs Python3 interpreter and several SciPy (scipy.org) packages. In order to use 'plot' command in DrSPINE one needs Python v3 interpreter and several "scientific Python" packages (numpy, scipy, matplotlib and ipython). Two convenient methods exist: a) Install full Anaconda Python distribution, see http://www.continuum.io/anaconda a) Install a "minimal" Anaconda Python distribution - Miniconda, see [Miniconda website](https://docs.conda.io/en/latest/miniconda). Follow installation instructions and install the relevant Python modules with the following command: b) Or install minimal Anaconda - Miniconda, see http://conda.pydata.org/miniconda and then install only relevant scipy and numpy packages with the following command: `conda install ipython matplotlib numpy scipy` conda install ipython matplotlib numpy scipy ### TeX Live In order to rebuild the documentation one needs full TeX Live https://www.tug.org/texlive distribution. Note: it works "out of the box" on Ubuntu (14,16,20) and MacOS with Tex Live 2016 or newer. RedHat 7 requires extra packages to be downloaded from the CTAN archive. b) Or install full Anaconda Python distribution, see [Anaconda website](https://docs.anaconda.com/anaconda/install for details). 2. Installation Loading @@ -43,30 +49,60 @@ The defaults should work in most cases. Edit only if needed. cp Makefile.def.in Makefile.def edit Makefile.def There are five variables that can be adjusted in the Makefile.def file or on the command line as parameters to make command. The defaults are usually safe. # Installation top directory DESTDIR=$(HOME)/local # Default Instrument 1=SNS-NSE, 2=J-NSE INSTRUMENT=1 # Fortran compiler (use ifort or gfortran) FC = gfortran # Fortran compiler flags FCFLAGS = -g #external libraries (set to empty to disable) GRDIR = /usr/local/gr ### Build and install Build DrSPINE for SNS-NSE make INSTRUMENT=1 all && make install DESTDIR=$HOME/local make all install INSTRUMENT=1 or, alternatively, build for J-NSE make INSTRUMENT=2 all && make install DESTDIR=$HOME/local make all install INSTRUMENT=2 ### Set-up the IPython profile Do it only once! ### 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 ### Activate DrSpine environment and run a test ### DrSpine environment One needs to activate DrSPINE environment before using DrSPINE: source $HOME/local/bin/drspine_activate.sh drspine -o /tmp -d $HOME/local/share/drspine \ This has to be done before each DrSPINE session. A convenient shortcut is to add an alias to one's shell init script ($HOME/.bashrc for bash, or $HOME/.zshrc for zsh). alias nse=`source $HOME/local/bin/drspine_activate.sh` so next time before running DrSPINE one would need to type nse ### Testing installation Before proceeding with your own data reduction, it may be worthwile to test the installation with the following command drspine -S -o /tmp -d $HOME/local/share/drspine \ -x $HOME/local/share/drspine/macro_mk ### Add DrSpine environment to your shell initialization script Add the following line If all goes well one should get a plot with S(Q,t)  source $HOME/local/bin/drspine_activate.sh to your $HOME/.bashrc (for bash) or $HOME/.zshrc (for zsh) depending on which shell is your default.
Makefile.def.in +4 −4 Original line number Diff line number Diff line # -*- Makefile -*- # vim: filetype=make # Installation DESTDIR=$(HOME) # Installation top directory DESTDIR=$(HOME)/local # Default Instrument 1=SNS-NSE, 2=J-NSE INSTRUMENT=1 # Fortran 2008 compiler (use ifort or gfortran) # Fortran compiler (use ifort or gfortran) FC = gfortran # Fortran 2003 compiler flags # Fortran compiler flags FCFLAGS = -g #external libraries (set to empty to disable) Loading
Makefile.version +1 −1 Original line number Diff line number Diff line Loading @@ -3,7 +3,7 @@ export PROJECT=drspine export VERSION_MAJOR=1 export VERSION_MINOR=4 export VERSION_RELEASE=4 export VERSION_RELEASE=5 export PROJLIB=lib$(PROJECT).a export PROJARCH=$(PROJECT)-$(VERSION_MAJOR).$(VERSION_MINOR) Loading
doc/quick_install_guide.tex +77 −39 Original line number Diff line number Diff line Loading @@ -8,10 +8,10 @@ Guide}\label{drspine-quick-installation-guide}} \hypertarget{fortran-compiler}{% \subsubsection{Fortran Compiler}\label{fortran-compiler}} Fortran 2008 compatible compiler, for example \begin{itemize} \tightlist \item Fortran 2008 compatible compiler \item GFortran v4.8 or newer \item Loading @@ -24,37 +24,40 @@ Guide}\label{drspine-quick-installation-guide}} The report command in DrSPINE uses the GR Framework (gr-framework.org). Follow installation instructions for the C library GR. \hypertarget{tex-live}{% \subsubsection{TeX Live}\label{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,16,20) and MacOS with Tex Live 2016 or newer. RedHat/CentOS 7 requires extra packages to be downloaded from the CTAN archive. \hypertarget{python}{% \subsubsection{Python}\label{python}} In order to use `plot' command in DrSPINE one needs Python3 interpreter and several SciPy (scipy.org) packages. In order to use `plot' command in DrSPINE one needs Python v3 interpreter and several ``scientific Python'' packages (numpy, scipy, matplotlib and ipython). Two convenient methods exist: \begin{enumerate} \def\labelenumi{\alph{enumi})} \item Install full Anaconda Python distribution, see http://www.continuum.io/anaconda \item Or install minimal Anaconda - Miniconda, see http://conda.pydata.org/miniconda and then install only relevant scipy and numpy packages with the following command: Install a ``minimal'' Anaconda Python distribution - Miniconda, see \href{https://docs.conda.io/en/latest/miniconda}{Miniconda website}. Follow installation instructions and install the relevant Python modules with the following command: conda install ipython matplotlib numpy scipy \texttt{conda\ install\ ipython\ matplotlib\ numpy\ scipy} \item Or install full Anaconda Python distribution, see \href{https://docs.anaconda.com/anaconda/install\%20for\%20details}{Anaconda website}. \end{enumerate} \hypertarget{tex-live}{% \subsubsection{TeX Live}\label{tex-live}} In order to rebuild the documentation one needs full TeX Live https://www.tug.org/texlive distribution. Note: it works ``out of the box'' on Ubuntu (14,16,20) and MacOS with Tex Live 2016 or newer. RedHat 7 requires extra packages to be downloaded from the CTAN archive. \hypertarget{installation}{% \subsection{2. Installation}\label{installation}} Loading @@ -68,51 +71,86 @@ cp Makefile.def.in Makefile.def edit Makefile.def \end{verbatim} There are five variables that can be adjusted in the Makefile.def file or on the command line as parameters to make command. The defaults are usually safe. \begin{verbatim} # Installation top directory DESTDIR=$(HOME)/local # Default Instrument 1=SNS-NSE, 2=J-NSE INSTRUMENT=1 # Fortran compiler (use ifort or gfortran) FC = gfortran # Fortran compiler flags FCFLAGS = -g #external libraries (set to empty to disable) GRDIR = /usr/local/gr \end{verbatim} \hypertarget{build-and-install}{% \subsubsection{Build and install}\label{build-and-install}} Build DrSPINE for SNS-NSE \begin{verbatim} make INSTRUMENT=1 all && make install DESTDIR=$HOME/local make all install INSTRUMENT=1 \end{verbatim} or, alternatively, build for J-NSE \begin{verbatim} make INSTRUMENT=2 all && make install DESTDIR=$HOME/local make all install INSTRUMENT=2 \end{verbatim} \hypertarget{set-up-the-ipython-profile}{% \subsubsection{Set-up the IPython profile}\label{set-up-the-ipython-profile}} \hypertarget{first-time-use}{% \subsubsection{First time use}\label{first-time-use}} Do it only once! Before using DrSPINE one needs to set-up the IPython profile: do it only once! \begin{verbatim} source $HOME/local/bin/drspine_create_env.sh \end{verbatim} \hypertarget{activate-drspine-environment-and-run-a-test}{% \subsubsection{Activate DrSpine environment and run a test}\label{activate-drspine-environment-and-run-a-test}} \hypertarget{drspine-environment}{% \subsubsection{DrSpine environment}\label{drspine-environment}} One needs to activate DrSPINE environment before using DrSPINE: \begin{verbatim} source $HOME/local/bin/drspine_activate.sh \end{verbatim} drspine -o /tmp -d $HOME/local/share/drspine \ -x $HOME/local/share/drspine/macro_mk This has to be done before each DrSPINE session. A convenient shortcut is to add an alias to one's shell init script (\$HOME/.bashrc for bash, or \$HOME/.zshrc for zsh). \begin{verbatim} alias nse=`source $HOME/local/bin/drspine_activate.sh` \end{verbatim} so next time before running DrSPINE one would need to type \begin{verbatim} nse \end{verbatim} \hypertarget{add-drspine-environment-to-your-shell-initialization-script}{% \subsubsection{Add DrSpine environment to your shell initialization script}\label{add-drspine-environment-to-your-shell-initialization-script}} \hypertarget{testing-installation}{% \subsubsection{Testing installation}\label{testing-installation}} Add the following line Before proceeding with your own data reduction, it may be worthwile to test the installation with the following command \begin{verbatim} source $HOME/local/bin/drspine_activate.sh drspine -S -o /tmp -d $HOME/local/share/drspine \ -x $HOME/local/share/drspine/macro_mk \end{verbatim} to your \$HOME/.bashrc (for bash) or \$HOME/.zshrc (for zsh) depending on which shell is your default. If all goes well one should get a plot with S(Q,t) \begin{figure} \centering \includegraphics{test_macro_plot.png} \caption{Example S(Q,t) plot} \end{figure}
