Skip to content
Snippets Groups Projects
Commit 3be674cd authored by Wuttke, Joachim's avatar Wuttke, Joachim
Browse files

Announce missing chapters in introduction,

explain release scheme and version number,
rearrange paragraphs.
Ready for release!
parent b79c3912
No related branches found
No related tags found
No related merge requests found
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
\section{Embedded particles} \section{Embedded particles}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\index{Particles!embedded|(}% \index{Particle assemblies|(}%
\index{Nanoparticles|see {Particles}}% \index{Nanoparticles|see {Particles}}%
\index{Mesoparticles|see {Particles}}% \index{Mesoparticles|see {Particles}}%
In many important GISAS applications, In many important GISAS applications,
...@@ -1309,5 +1309,5 @@ Function & Parameters & Comments\\ ...@@ -1309,5 +1309,5 @@ Function & Parameters & Comments\\
\caption{List of interference functions implemented in \BornAgain. pdf : probability distribution function, $\mathbf{a}, \mathbf{b}$ are the lattice base vectors, and $\mathbf{x}$ is the axis vector perpendicular to the detector plane.} \caption{List of interference functions implemented in \BornAgain. pdf : probability distribution function, $\mathbf{a}, \mathbf{b}$ are the lattice base vectors, and $\mathbf{x}$ is the axis vector perpendicular to the detector plane.}
\end{table} \end{table}
\index{Particles!embedded|)}% \index{Particle assemblies)}%
\fi \fi
...@@ -115,21 +115,50 @@ on the scattering theory and on the sample models implemented in \BornAgain, ...@@ -115,21 +115,50 @@ on the scattering theory and on the sample models implemented in \BornAgain,
and some documentation of the corresponding \Python\ functions. and some documentation of the corresponding \Python\ functions.
\Work{\indent This manual is incomplete. \Work{\indent This manual is incomplete.
Several important chapters are still missing. Several important chapters are still missing.}
We intend to publish additional material with each new software release.}
Specifically,
\Warn{\indent We urge users to subscribe to our newsletter we plan to provide documentation on
\begin{itemize}
\item X-ray propagation and scattering,
\index{X-rays!propagation and scattering}%
\index{Wave propagation!X-rays}%
\item polarized neutron propagation and magnetic scattering,
\index{Neutrons!polarization}%
\index{Wave propagation!neutrons, polarized}%
\index{Polarized neutron!propagation and magnetic scattering}%
\item mapping of $\partial\sigma/\partial\Omega$ onto flat detectors,
\index{Detector!mapping the cross section}%
\item scattering by rough interfaces,
\index{Roughness}%
\item scattering by particle assemblies.
\index{Particle assemblies}%
\end{itemize}
We intend to publish these chapters successively,
along with new software release.
To facilitate citation,
starting with release 1.2 the manual carries
the same version number as the software,
even though it is in a less mature state.
\Emph{\indent We urge users to subscribe to our newsletter
(see Sect.~\ref{Snews}), (see Sect.~\ref{Snews}),
and to contact us for any question not answered in the docs. and to contact us for any question not answered here
or in the online documentation.}
\index{Bug reports}% \index{Bug reports}%
We are grateful for all kind of feedback: We are grateful for all kind of feedback:
criticism, praise, bug reports, feature requests or contributed modules. criticism, praise, bug reports, feature requests or contributed modules.
If questions go beyond normal user support, If questions go beyond normal user support,
we will be glad to discuss a scientific collaboration.} we will be glad to discuss a scientific collaboration.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\isection{Typesetting conventions}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%\medskip In this manual, we use the following colored boxes to highlight
%\noindent certain information:
In this manual, we use the following typesetting conventions:
\def\demobox#1{\hspace{5em}\begin{minipage}{.75\textwidth}#1 \def\demobox#1{\hspace{5em}\begin{minipage}{.75\textwidth}#1
\end{minipage}\hfill\strut} \end{minipage}\hfill\strut}
...@@ -149,7 +178,8 @@ with the software or the documentation.}} ...@@ -149,7 +178,8 @@ with the software or the documentation.}}
\medskip \medskip
\demobox{\Emph{\indent Such a box contains \demobox{\Emph{\indent Such a box contains
an \textbf{important fact} that has a central role in an \textbf{important fact}, for instance an equation
that has a central role in
the further development of the theory.}} the further development of the theory.}}
\medskip \medskip
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment