[QuantLibAddin-cvs] QuantLibAddin/Docs/pages overview.docs, NONE, 1.1.2.1

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/quantlibaddin/QuantLibAddin/Docs/pages
In directory sc8-pr-cvs7.sourceforge.net:/tmp/cvs-serv2301/Docs/pages

Added Files:
      Tag: R000313f0-branch
	overview.docs 
Log Message:
document restructuring of QuantLibAddin and related projects

--- NEW FILE: overview.docs ---

/*
 Copyright (C) 2006 Eric Ehlers

 This file is part of QuantLib, a free-software/open-source library
 for financial quantitative analysts and developers - http://quantlib.org/

 QuantLib is free software developed by the QuantLib Group; you can
 redistribute it and/or modify it under the terms of the QuantLib License;
 either version 1.0, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 QuantLib License for more details.

 You should have received a copy of the QuantLib License along with this
 program; if not, please email qua...@li...

 The QuantLib License is also available at http://quantlib.org/license.html
 The members of the QuantLib Group are listed in the QuantLib License
*/

/*! \page overview Project Overview

%QuantLibAddin and related projects have been restructured for release 0.3.13.
This document summarizes the current state of affairs.

\section po_list Project List

Below is a list of all projects related to QuantLibAddin, and a brief summary
of their status.

\subsection po_quantlib QuantLib

QuantLib (<a href="http://quantlib.org">http://quantlib.org</a>) is an open
source analytics library written in C++.  QuantLib provides the core
functionality and calculation engine which QuantLibAddin exports to end user
platforms.

\subsection po_objecthandler ObjectHandler

ObjectHandler (<a href="http://www.objecthandler.org">http://www.objecthandler.org</a>) 
implements an object repository allowing objects to be stored, shared, updated,
interrogated, and destroyed.  ObjectHandler facilitates the integration of the
object-oriented QuantLib library into procedural end-user environments such as
spreadsheets.

\subsection po_log4cxx log4cxx

ObjectHandler logging is performed by the log4cxx logging framework.  log4cxx
is a subproject of the Apache project.  The log4cxx project is in an
inconsistent state:  the last official release, version 0.9.7, is broken.  The
next version, possibly to be numbered 0.9.8, resolves the design flaws of
0.9.7, but it appears that work on 0.9.8 is stalled at the pre-release stage.

The ObjectHandler project addresses these issues by maintaining a customized
copy of log4cxx 0.9.7.  Most customizations are aimed at streamlining the
log4cxx build environment.  The many reported log4cxx 0.9.7 bugs and design
flaws haven't been addressed, however these bugs so far haven't manifested
themselves in the very rudimentary use which ObjectHandler makes of log4cxx.

Each ObjectHandler release is accompanied by a customized, updated build of
log4cxx 0.9.7.  When you build ObjectHandler you must ensure that you build it
against this corresponding log4cxx release.

\subsection po_quantlibaddin QuantLibAddin

%QuantLibAddin (<a href="http://www.quantlibaddin.org">http://www.quantlibaddin.org</a>) 
exports QuantLib functionality to a variety of platforms
%including Microsoft Excel and OpenOffice.org Calc.  QuantLib releases 0.3.10
%through 0.3.13 have been accompanied by a %QuantLibAddin release of the same
%version number.

\subsection po_quantlibxl QuantLibXL

The name QuantLibXL was originally applied to an Excel addin which supplemented
QuantLib releases 0.3.3 through 0.3.8.  That project was discontinued.

All %QuantLibAddin releases have included an Excel addin.  Beginning with
%QuantLibAddin version 0.3.13, the QuantLibXL name has been resurrected and
given to the %QuantLibAddin build for the Excel platform.  The new QuantLibXL
project reflects the fact that the majority of interest in %QuantLibAddin
originates from end business users on the Excel platform.  The new QuantLibXL
project has a separate web page 
(<a href="http://www.quantlibxl.org">http://www.quantlibxl.org</a>)
and provides a Windows installer for the compiled package.

For a breakdown of the differences between the old and new QuantLibXL projects,
please see the following item in the %QuantLibAddin FAQ: \ref faq_excel

\subsection po_gensrc gensrc

gensrc (<a href="http://www.gensrc.org">http://www.gensrc.org</a>) is a Python
application which takes XML descriptions of functions defined in a library and
generates source code for addins on supported platforms including Microsoft
Excel and OpenOffice.org Calc. gensrc is used to autogenerate source code for
%QuantLibAddin and ObjectHandler.

gensrc was previously called srcgen, and resided in a subdirectory of
%QuantLibAddin versions prior to 0.3.13.  gensrc has been separated from
%QuantLibAddin 0.3.13 into a standalone project.  In order to emphasize the
fact that gensrc is a standalone application independent of
QuantLib/%QuantLibAddin, gensrc has adopted the version numbering scheme from
ObjectHandler, hence %QuantLibAddin 0.3.13 relies on gensrc version 0.1.4.
gensrc was renamed from srcgen because of a conflict with another SourceForge
project.

\section po_cvs CVS

The following projects originated as modules in the QuantLib CVS repository:
\li %QuantLibAddin, including the projects that are now QuantLibXL and gensrc
\li ObjectHandler, including the corresponding customized copy of log4cxx

These modules were migrated into separate SourceForge projects:

\li <a href="http://sourceforge.net/projects/gensrc">http://sourceforge.net/projects/gensrc</a>
\li <a href="http://sourceforge.net/projects/objecthandler">http://sourceforge.net/projects/objecthandler</a>
\li <a href="http://sourceforge.net/projects/quantlibaddin">http://sourceforge.net/projects/quantlibaddin</a>
\li <a href="http://sourceforge.net/projects/quantlibxl">http://sourceforge.net/projects/quantlibxl</a>

Unfortunately, various legal and logistical problems arose from the above move,
and it is necessary to migrate the above code back into the QuantLib
SourceForge project.  If you want to acquire the latest CVS snapshot of these
projects, please first check with qua...@li....  The latest home
of these projects will also be indicated by the associated domain names:

\li <a href="http://www.gensrc.org">http://www.gensrc.org</a>
\li <a href="http://www.objecthandler.org">http://www.objecthandler.org</a>
\li <a href="http://www.quantlibaddin.org">http://www.quantlibaddin.org</a>
\li <a href="http://www.quantlibxl.org">http://www.quantlibxl.org</a>

All releases for the projects discussed in this document have always been hosted on the 
<a href="http://sourceforge.net/project/showfiles.php?group_id=12740">QuantLib downloads page</a>.

Apologies for the confusion on this issue.

*/