NodeStats Project
-----------------

This directory ( iac_proj/nstats/ ) contains all the V code, source
code, HTML documentation, and installation information for the Node
Statistics project.

The directory should be placed into your existing project directory,
which should already contain the IAC Project File structure, i.e., the
iac_proj/, iac_lib/ and v/ directories.

The file INSTALL contains information on how to edit the existing IAC
files: a single line addition to the iac_proj/iac_proj.v file, to add the
new NodeStats project, and additions to one or more of files in the
iac_lib/ directory, to link appropriate objects to the top-level IAC library
page.

Once the files have been correctly installed, the low-level module of the new
project may be compiled. If you opt to leave the process unspecified, it will
by default use the "express" process. Doing so means the module may be
compiled by using one of the following commands in the top-level directory of
your project (whilst AVS/Express is not running):

	base -comp_proc express -exit

or	make -f express.mk

	Using the 'make' command, requires that the express.mk file already
exists, and has been updated accordingly.

	If you modify the NodeStats project, and elect to specify the process
as "user" or another user-defined process, then the module may be compiled
without having to exit the AVS/Express application. Use the following command
in the VCP to compile the module:

	$compile IAC_PROJ.NodeStats.NStatsMods

	Users of the Developer's Edition may select the module in the 
relevant Templates library, and choose 'compile' from the Project menu.

This module uses functions in the cp_utils library (available from
IAC). It must be installed before compiling this project.

Files
-----

The following files can be found in the iac_proj/nstats/ directory.

INSTALL 	Contains installation instructions for editing the
		iac_proj.v and iac_lib/ data_io.v and examples.v
		files.  This file should not be edited as the future
		installation script will use this file.

nstats.v	Creates the IAC_PROJ.NodeStats library.

ns_mods.v	Creates the NStatsMods library containing the low-level
		module nstats_raw.

ns_macs.v 	Creates the NStatsMacs library containing the
		high-level macros node_statistics, nstats, nstats_UI
		and the example application Node_Stats_Eg.

node_stats.h	The C source code for the nstats_raw module.
node_stats.c
node_stats_vxp.c

doc_mod.html	HTML documentation for the nstats_raw module.

doc_umac.html	HTML documentation for the node_statistics User Macro.

README		This file.


Prerequisites
-------------

This project relies on the successful installation of the following components.
Without them it will not function correctly.

cp_utils project


Generated Files
---------------

When the project is compiled, the following files will be generated.
Once completed, you may safely remove these files; any future
recompilations will regenerate these files.

gen.h	AVS/Express generated header file.

gen.cxx	AVS/Express generated source code.

