Installing SNOLIB and SNOMAN
Installing The SNOMAN Companion
Installing The SNO Database

Installing SNOLIB and SNOMAN

An outline of the installation procedure can be found in the User Manual and full instructions can be found in:-

..snoman/tools/exe/install.doc

A complete set of tools .scr for UNIX are provided, the most important are:-

Full Installation Tools

install_starter_kit - install tools, extract and utilities.
upgrade_snoman - ftp files, install and run standard job.
scp_snoman_gzip - set up and transfer files using gzip tar file.
install_snoman - pass code through EXTRACT and compile and link.
compile_snoman - full recompilation of the code.
link_snoman - build SNOMAN.

Incremental Build Tools

compile - compile selected files.
compile_inc - compile files involving specific inc file.
auto_snoman_compile.scr - like make (only rebuilds as required) and handles .h and .inc (but not nested)
update_library - update SNOlib after compiling selected files.
link_snolib - build non-standard SNOMAN/SNOlib application
remake_snoman - build non-standard SNOMAN/SNOlib applications when .inc files modified in a backward incompatible way.

Disk Management Tools

survey_dir - analyse directory contents by file type.

Installing The SNOMAN Companion

The Companion consists of a set of interlinked HTML files that all reside on:-

.../snoman/n_nn/doc/html

Links to Manuals and Source Files

There are links out of this directory to the User Manual and the Programmer Manual and to .for, .cmd, .dat and .cmd files in the code or prod directories. If you have trouble viewing these files then you need to update your browser However, all links use relative directory addressing so installation simply involves setting up this directory (which is automatic if you use the ftp_snoman tools or unpack the n_nn.tar.gz file) in the correct place. By default .dat and .cmd files are assumed to be in the prod directory. If, as happens at Oxford, you choose to put these files in the code directory then, to reset companion links correctly you need to:-

cd $SNO_ROOT/snoman/$SNO_SNOMAN_VER/doc/html
$SNO_TOOLS/set_companion_links.perl -use_code *.html

Links to the SNOMAN source code are used extensively in the Software Structure diagrams. If you frequently need to browse through the code, then you may want to generate a complete copy of the source code in a HTML form. See below.

HTML Version of the Code

Use the tool

   $SNO_TOOLS/make_html_snoman.scr

to generate an HTML version of the code. This vastly improves readability with comment lines highlighted differently to the code, and more importantly, full bi-directional hypertext links to any called subroutines or functions and to include files. The companion links are updated automatically to point to the hypertext version of the code.

Link to SNODB

Other Documents has a link to the SNODB documentation. It is assumed that this documentation can be found in the directory ...snoman/snodb/html. However, SNODB is not part of SNOMAN so the local software librarian may have decided to put the SNODB documentation elsewhere. In which case the link will have to be updated accordingly.

Link to the SNOMAN Tutorial 98

The tutorial files are not distributed as part of the release. If you want this link to work locally, grab a set from:-

    snoguest@surf.sno.laurentian.ca:snoman/tar/tutorial98.tar.gz

Store them in the directory tutorial98 below the snoman directory.

Viewing the Companion

To view the document make this directory the default, start an HMTL viewer (NETSCAPE is recommended), and open the local file:-

companion.html

File Organisation

companion top level document
- companion_* one for each section of the companion.
  - bank_* Event data structure bank description.
  - id_* ID code table
  - command_files Example .CMD files
  - media Region and media codes
  - structure_* SU structure diagram.
  - titles_* titles bank description.

Updating your Browser

The companion links directly into a number of file types, such as .for, that are part of the program source. You made have to configure your browser to view such files. For example, on Netscape version 4:-

Select Preferences... (its in the Edit Menu).
Select Category Navigator.
Select Applications.
Scroll to find Plain Text and press Edit.
Add any of the following extensions that are not there:-
Press O.K. to save changes.

Installing The SNO Database

The SNO database is not part of SNOMAN and has to be installed separately. Please contact Bruce Cleveland (bclevela@surf.sno.laurentian.ca). However, a stripped down version of the database is available at:-

  snoguest@surf.sno.laurentian.ca:snoman/tar/dbs_lite.tar.gz

which is suitable for laptop development work. See the README file it contains for instructions.

Go Back to the Snoman Companion Top Page