Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove mentions of the removed F77 API from the documentation #189

Merged
merged 1 commit into from
Jun 7, 2024
Merged

Remove mentions of the removed F77 API from the documentation #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ LCIO ( **L**inear **C**ollider **I/O** ) is a persistency framework and event da
## Introduction

LCIO is intended to be used in both simulation studies and analysis frameworks. Its light weight and portability makes it also suitable for use in detector R&D
testbeam applications. It provides a C++ and optionally a Java implementation with a common interface (API) - a Fortran interface to the C++ implementation also exists,
if built with ROOT, Python bindings are available .
testbeam applications. It provides a C++ and optionally a Java implementation with a common interface (API) - if built with ROOT, Python bindings are available .

Using a common persistency format and event data model allows to easily share results and compare reconstruction algorithms.
LCIO is used by almost all groups involved in linear collider detector studies and thus has become a de facto standard.
Expand Down
36 changes: 2 additions & 34 deletions cmake/manual.tex.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ analysis frameworks. Its light weight and portability makes it also suitable
for use in detector R\&D applications.

It provides a C++ and a Java implementation with a common interface (API).
A Fortran interface to the C++ implementation is provided as well.

This manual is intended for application developers that want to incorporate LCIO in their
programs. This includes e.g. simulation developers as well as physicists that want to
Expand Down Expand Up @@ -231,11 +230,6 @@ Both ways of building LCIO will create the following libraries and executables:
lcio_event_counter
stdhepjob

./bin <-- f77 examples
anajob_F
simjob_F
recjob_F

\end{verbatim}


Expand Down Expand Up @@ -310,8 +304,6 @@ This section gives an introduction on how to use LCIO. We describe the user inte
provide some code examples. For most of the section we focus on Java and C++ as these are the main
languages supported by LCIO. Thanks to the AID~\cite{ref_aid} tool Java and C++ hava an API which is generated
from a common source and thus very similar.
The Fortran interface, implemented as a wrapper to the C++ implementation, is described
in \ref{f77api}.

\subsection{Java and C++ API} \label{sec_api}
Detailed documentation of the API is provided both for Java and C++ on the
Expand Down Expand Up @@ -1009,16 +1001,13 @@ Of course if you use your own implementation of the EVENT interface you are also
memory management.}



\input{f77api}

\section{Real world examples} \label{realworld}
All the examples described above show how to use LCIO with Java, C++ and Fortran. They are build
All the examples described above show how to use LCIO with Java and C++. They are build
with LCIO and provided as binaries in \verb#$LCIO/bin#.
%$
We also provide some examples that show how to use LCIO with some common physiscs simulation
and analysis packages, such as {\em Pythia, Root and AIDA (JAS)} in
\verb#$LCIO/examples/java[cpp,f77]#.
\verb#$LCIO/examples/java[cpp]#.
%$
As these examples depend on external tools and libraries they are not build by default with LCIO.
Please check the corresponding \verb$README$ files for instructions on how to build these examples:
Expand All @@ -1037,23 +1026,6 @@ This Java example creates an AIDA file from an LCIO file with some histograms
and an Ntuple. You can use any AIDA~\cite{ref_aida} compliant analysis tools for
viewing the histograms, e.g. JAS3~\cite{ref_jas}.

\subsection{lciohbook (Fortran, Hbook)} \label{rwhbook}

A Fortran example that creates an Hbook~\cite{ref_cernlib} file from an LCIO file with
some histograms to be analyzed with PAW~\cite{ref_cernlib}.

\subsection{pythia (Fortran, Pythia)} \label{rwpythia}

An ASCII file of generator output can be produced by the script \verb$pythiahepevt.sh$.
This script runs a Pythia~\cite{ref_pythia} job
using the Pythia routine {\bf PYHEPC} to fill the \verb$hepevt$ common block
and a modified version of {\bf LCWRITE} to create the ASCII file (is included in the script). To run this script
one has to provide \verb$cernlib$~\cite{ref_cernlib} 2002 or later. The script has to be modified if necessary
to provide a valid path to the \verb$cernlib$ libraries. \\
The program {\bf PYSIMJOB} (\verb$pysimjob.F$) reads the ASCII file, fills the \verb$hepevt$ common
block, and writes a LCIO file which is read again in a second pass to fill the \verb$hepevt$ common
block.


\newpage
%\begin{latexonly}
Expand Down Expand Up @@ -1158,10 +1130,6 @@ See UTIL::LCStdHepRdr and EXAMPLES/stdhepjob.cc.
%{\footnotesize \verbatiminput{../../../doc/lcio.xml} }
%\newpage

\section{Summary of Fortran API Functions} \label{ftn_summary}

\input{f77summary.tex}


\newpage
% Create the reference section using BibTeX:
Expand Down
Loading
Loading