From af1895fd0c7857971d9d7094bef3f661efe4dbc5 Mon Sep 17 00:00:00 2001
From: Gennady Pospelov <g.pospelov@fz-juelich.de>
Date: Fri, 7 Feb 2014 12:50:00 +0100
Subject: [PATCH] Minor fixed in user manual (fitting, installation)
---
Doc/UserManual/CMakeLists.txt | 189 ++++++++++++++++-------
Doc/UserManual/FittingImplementation.tex | 6 +-
Doc/UserManual/Installation.tex | 8 +-
Doc/UserManual/QuickStart.tex | 2 +-
4 files changed, 140 insertions(+), 65 deletions(-)
diff --git a/Doc/UserManual/CMakeLists.txt b/Doc/UserManual/CMakeLists.txt
index 8520322c809..43e5e39e3c8 100644
--- a/Doc/UserManual/CMakeLists.txt
+++ b/Doc/UserManual/CMakeLists.txt
@@ -1,56 +1,133 @@
-cmake_minimum_required(VERSION 2.8.3 FATAL_ERROR)
-
-project(UserManual NONE)
-
-# user manual version number will be automatically propagated into tes
-set(UM_VERSION_MAJOR 0)
-set(UM_VERSION_MINOR 2)
-set(UM_VERSION_PATCH 2)
-
-
-set(LATEX_COMPILER_FLAGS
-"-interaction=nonstopmode --enable-write18"
-CACHE STRING "Flags passed to latex."
-)
-
-if(BORNAGAIN_MAN)
- # --- configure a header file to pass CMake settings to the source code
- configure_file(
- "${CMAKE_SOURCE_DIR}/cmake/scripts/UserManualVersion.tex.in"
- "${CMAKE_SOURCE_DIR}/Doc/UserManual/UserManualVersion.tex"
- )
- include(${CMAKE_MODULE_PATH}/UseLATEX.cmake)
-
-else()
- # to compile in standalone mode
- configure_file(
- "${CMAKE_SOURCE_DIR}/../../cmake/scripts/UserManualVersion.tex.in"
- "${CMAKE_SOURCE_DIR}/../../Doc/UserManual/UserManualVersion.tex"
- )
- include(../../cmake/modules/UseLATEX.cmake)
-
-endif()
-
-
-set(UM_IMAGES
- Figures/toyfit_expdata.eps
- Figures/toyfit_simdata.eps
- Figures/toyfit_chi2_p12.eps
- Figures/toyfit_chi2_p23.eps
- Figures/minimization_workflow.eps
- Figures/Manual_ex1.eps
- Figures/multilayer3d3.eps
- Figures/basic_architecture.eps
-)
-
-
-file(GLOB tex_inputs RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.tex)
-
-ADD_LATEX_DOCUMENT(UserManual.tex
- INPUTS ${tex_inputs}
- BIBFILES jw7.bib
- IMAGES ${UM_IMAGES}
- DEFAULT_SAFEPDF
-)
-
-
+cmake_minimum_required(VERSION 2.8.3 FATAL_ERROR)
+
+project(UserManual NONE)
+
+# user manual version number will be automatically propagated into tes
+set(UM_VERSION_MAJOR 0)
+set(UM_VERSION_MINOR 2)
+set(UM_VERSION_PATCH 2)
+
+
+set(LATEX_COMPILER_FLAGS
+"-interaction=nonstopmode --enable-write18"
+CACHE STRING "Flags passed to latex."
+)
+
+if(BORNAGAIN_MAN)
+ # --- configure a header file to pass CMake settings to the source code
+ configure_file(
+ "${CMAKE_SOURCE_DIR}/cmake/scripts/UserManualVersion.tex.in"
+ "${CMAKE_SOURCE_DIR}/Doc/UserManual/UserManualVersion.tex"
+ )
+ include(${CMAKE_MODULE_PATH}/UseLATEX.cmake)
+
+else()
+ # to compile in standalone mode
+ configure_file(
+ "${CMAKE_SOURCE_DIR}/../../cmake/scripts/UserManualVersion.tex.in"
+ "${CMAKE_SOURCE_DIR}/../../Doc/UserManual/UserManualVersion.tex"
+ )
+ include(../../cmake/modules/UseLATEX.cmake)
+
+endif()
+
+
+set(UM_IMAGES
+ Figures/toyfit_expdata.eps
+ Figures/toyfit_simdata.eps
+ Figures/toyfit_chi2_p12.eps
+ Figures/toyfit_chi2_p23.eps
+ Figures/minimization_workflow.eps
+ Figures/Manual_ex1.eps
+ Figures/multilayer3d3.eps
+ Figures/basic_architecture.eps
+ Figures/AnisoPyramid2dxy.eps
+ Figures/AnisoPyramid2dxz.eps
+ Figures/AnistropicPyramid3d.eps
+ Figures/Box2dxy.eps
+ Figures/Box2dxz.eps
+ Figures/Box3d.eps
+ Figures/Cone2dxy.eps
+ Figures/Cone2dxz.eps
+ Figures/Cone3d.eps
+ Figures/Sphere2dxy.eps
+ Figures/Sphere2dxz.eps
+ Figures/Sphere3d.eps
+ Figures/Spheroid2dxy.eps
+ Figures/Spheroid2dxz.eps
+ Figures/Spheroid3d.eps
+ Figures/Cone62dxy.eps
+ Figures/Cone62dxz.eps
+ Figures/Cone63d.eps
+ Figures/Cuboctahedron2dxy.eps
+ Figures/Cuboctahedron2dxz.eps
+ Figures/Cuboctahedron3d.eps
+ Figures/Cylinder2dxy.eps
+ Figures/Cylinder2dxz.eps
+ Figures/Cylinder3d.eps
+ Figures/EllipsoidalCylinder2dxy.eps
+ Figures/EllipsoidalCylinder2dxz.eps
+ Figures/EllipsoidalCylinder3d.eps
+ Figures/FullSphere2dxy.eps
+ Figures/FullSphere2dxz.eps
+ Figures/figffparallel.eps
+ Figures/FullSphere3d.eps
+ Figures/figffprism3.eps
+ Figures/FullSpheroid2dxy.eps
+ Figures/FullSpheroid2dxz.eps
+ Figures/figffpyramid.eps
+ Figures/FullSpheroid3d.eps
+ Figures/figffripple1.eps
+ Figures/HemiEllipsoid2dxy.eps
+ Figures/figffripple2.eps
+ Figures/HemiEllipsoid2dxz.eps
+ Figures/figffsphere.eps
+ Figures/HemiEllipsoid3d.eps
+ Figures/Parallelepiped2dxy.eps
+ Figures/Parallelepiped2dxz.eps
+ Figures/Parallelepiped3d.eps
+ Figures/Prism32dxy.eps
+ Figures/Prism32dxz.eps
+ Figures/Prism33d.eps
+ Figures/Prism62dxy.eps
+ Figures/Prism62dxz.eps
+ Figures/Prism63d.eps
+ Figures/Pyramid2dxy.eps
+ Figures/Pyramid2dxz.eps
+ Figures/Pyramid3d.eps
+ Figures/Ripple12dxy.eps
+ Figures/Ripple12dyz.eps
+ Figures/Ripple13d.eps
+ Figures/Ripple22dxy.eps
+ Figures/Ripple22dyz.eps
+ Figures/Ripple23d.eps
+ Figures/figffcone6.eps
+ Figures/Tetrahedron2dxz.eps
+ Figures/Tetrahedron2dxy.eps
+ Figures/Tetrahedron3d.eps
+ Figures/figffanisopyramid.eps
+ Figures/figffbox.eps
+ Figures/figffhemiellips.eps
+ Figures/figfftetrahedron.eps
+ Figures/figffcone.eps
+ Figures/figffcuboctah.eps
+ Figures/figffcylinder.eps
+ Figures/figffellipscylinder.eps
+ Figures/figfffsphere.eps
+ Figures/figfffspheroid.eps
+ Figures/figfffullsphere.eps
+ Figures/figffspheroid.eps
+ Figures/figffprism6.eps
+)
+
+
+file(GLOB tex_inputs RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.tex)
+
+ADD_LATEX_DOCUMENT(UserManual.tex
+ INPUTS ${tex_inputs}
+ BIBFILES jw7.bib
+ IMAGES ${UM_IMAGES}
+ DEFAULT_SAFEPDF
+)
+
+
diff --git a/Doc/UserManual/FittingImplementation.tex b/Doc/UserManual/FittingImplementation.tex
index f16c420692a..752f5d1edf6 100644
--- a/Doc/UserManual/FittingImplementation.tex
+++ b/Doc/UserManual/FittingImplementation.tex
@@ -240,7 +240,7 @@ can also be obtained using \Code{MinimizerFactory.printCatalogue()} command.
\hline
& \Code{SteepestDescent} & follows the downhill gradient of the function at each step\\
\hline
-\Code{GSLMultiFit} \cite{GSLMultiFitURL} & & Levenberg-Marquardt
+\Code{GSLLMA} \cite{GSLMultiFitURL} & & Levenberg-Marquardt
Algorithm\\
\hline
\Code{GSLSimAn} \cite{GSLSimAnURL}& & Simulated Annealing Algorithm\\
@@ -254,9 +254,7 @@ Algorithm\\
There are several options common to every minimization algorithm, which can be changed
before starting the minimization. They are handled by \Code{MinimizerOptions} class:
\begin{lstlisting}[language=python, style=eclipseboxed, numbers = none]
-options = MinimizerOptions()
-options.setMaxFunctionCalls(10)
-fit_suite.getMinimizer().setOptions(options)
+fit_suite.getMinimizer().getOptions().setMaxFunctionCalls(10)
\end{lstlisting}
In the above code snippet, a number of ``maximum function calls'',
namely the maximum number of times the minimizer is allowed to call the simulation, is limited to 10. %The minimizer will take that number into consideration and will try to limit number of iterations by that value.
diff --git a/Doc/UserManual/Installation.tex b/Doc/UserManual/Installation.tex
index 8c96a3bf828..a65e98217bd 100644
--- a/Doc/UserManual/Installation.tex
+++ b/Doc/UserManual/Installation.tex
@@ -5,7 +5,7 @@
It has been successfully compiled and tested on
\begin{itemize}
\item Microsoft Windows 7 64-bit, Windows 8 64-bit
-\item Mac OS X 10.8 (Mountain Lion)
+\item Mac OS X 10.8 (Mountain Lion), 10.9 (Maverick)
\item OpenSuse 12.3 64-bit
\item Ubuntu 12.10, 13.04 64-bit
\item Debian 7.1.0, 32-bit, 64-bit
@@ -38,7 +38,7 @@ The remainder of this section explains each step in detail.
To successfully build \BornAgain\ a number of prerequisite packages must be installed.
\begin{itemize}
-\item compilers: clang versions $\geq 3.1$ or GCC versions $\geq 4.2$
+\item compilers: clang versions $\geq 3.1$ or GCC versions $\geq 4.1.2$
\item cmake ($\geq 2.8.3$)
\item boost library ($\geq 1.48$)
\item GNU scientific library ($\geq 1.15$)
@@ -109,7 +109,7 @@ sudo zypper install libroot-* root-plugin-* root-system-* root-ttf libeigen3-dev
% ---------------
\noindent
\noindent
-{\large\bf Mac OS X 10.8} \newline
+{\large\bf Mac OS X 10.8, 10.9} \newline
To simplify the installation of third party open-source software on a Mac OS X system we recommend the use of \Code{MacPorts} package manager.
The easiest way to install MacPorts is by downloading the \Code{dmg}
from \url{www.macports.org/install.php} and running the system's installer.
@@ -304,7 +304,7 @@ Double-click on it to start the installation process. And then follow the instru
{\bf Step IV: $~$ run an example} \newline
Run an example located in \BornAgain\ installation directory:
\begin{lstlisting}[language=shell, style=commandline]
-python C:/BornAgain-0.9.2/Examples/python/simulation/ex001_CylindersAndPrisms/CylindersAndPrisms.py
+python C:/BornAgain-0.9.4/Examples/python/simulation/ex001_CylindersAndPrisms/CylindersAndPrisms.py
\end{lstlisting}
diff --git a/Doc/UserManual/QuickStart.tex b/Doc/UserManual/QuickStart.tex
index 77289e4f67f..612facaf8d6 100644
--- a/Doc/UserManual/QuickStart.tex
+++ b/Doc/UserManual/QuickStart.tex
@@ -75,7 +75,7 @@ Double-click on it to start the installation process. Then follow the instructio
{\bf Step III: $~$ running the example} \newline
Run an example located in \BornAgain\ installation directory:
\begin{lstlisting}[language=shell, style=commandline]
-python C:/BornAgain-0.9.2/Examples/python/simulation/ex001_CylindersAndPrisms/CylindersAndPrisms.py
+python C:/BornAgain-0.9.4/Examples/python/simulation/ex001_CylindersAndPrisms/CylindersAndPrisms.py
\end{lstlisting}
--
GitLab