Where is the documentation?

From DANSE

DANSE is a big software system, encompassing several fields of neutron scattering science and several levels of software development. The reduction application for chopper spectrometers itself involves more than 4,000 files, for example, and its documentation spans from component design through a user manual. Other applications for inelastic scattering will use some of this component infrastructure, but these applications are large systems too. The other fields of neutron scattering science have their own applications development efforts, with some common infrastructure. Nevertheless, some differences in the style of documentation for different subfields are expected, depending on tastes of the subproject leaders and needs of their science communities.

We have selected a format for DANSE documentation as follows, which differs for released code and for code under development. The new format for released code is being completed for the data reduction applications for inelastic instruments. It has:

1) Documentation in LaTeX that includes higher-level archival information, such as this for inelastic scattering: http://www.cacr.caltech.edu/projects/ARCS/arcs-1.0/book/Inelastic_Book.pdf

2) The developers' documentation is extracted from formatted documentation in the code itself, and automatic analysis of inheritances, such as this: http://arcscluster.caltech.edu:5001/Docs/docs/reduction/reduction/html/index.html

3) Tutorials are web-based and are mostly located on this wiki site. Some of them also include documentation http://wiki.cacr.caltech.edu/danse/index.php/ARCS_1.0_applications and later will be availabel in html format ( example (http://arcscluster.caltech.edu:5001/Docs/docs/reduction/Software-UserGuide/html/index.html) ) or pdf format ( example (http://arcscluster.caltech.edu:5001/Docs/docs/reduction/Software-UserGuide/latex/main.pdf) )

Software under development is being documented at several stages from conceptual planning through detailed design. Some active tasks are tracked in the following site: http://danse.us/trac/tickets/wiki (You can explore this site to find documentation in various degrees of completion. It is all new, however.)

In the older style, the larger overall guide of the DANSE packages is found here: http://www.cacr.caltech.edu/projects/ARCS/arcs-1.0/web/Modules.html and a UML sketch of pyre-0.6 is here http://arcs.cacr.caltech.edu/arcs/pythia/dia.html

Other project resources are found here: http://wiki.cacr.caltech.edu/danse/index.php/Project_Resources