===================
= DGAS-Sim v0.1.0 =
===================

DGAS-Sim is a Grid simulation tool written by the EU DataGrid for the
purpose of testing the impact on different resource pricing algorithms
on the workload distribution. 
This file describes the contents of the package. 

(a part of this file is "stolen" from the README file
of OptorSim v0.5.0 - thanks to the authors! ;o)

Brief History
-------------

0.1.0 - First stable release: doesn't contain DFPricingModule that still
        needs further development.
	Addtional utility module: RandPriceSensitiveUtilityModule.
	Added some scripts for generating diagrams with gnuplot. The scripts
	have to be customized according to the output files generated by your
	simulation!

0.0.4 - Additional utility modules: RandomUtilityModule,
	CompletionTimeUtilityModule and 
	LeastLoadedUtilityModule (absolute or relative load).
	DFPricingModule implemented, but doesn't work correctly.
	Added comments to the source code that allow to generate the
	API documentation in html format (javadoc).
	Bugfix: QWT wasn't written to output file if the price adjustment
		threshold was not exceeded.
	New tool: simple statistical analysis tool for DGAS-Sim output files.

0.0.3 - started the work on the derivative follower algorithm
	(DFPricingModule). Still under development, not yet
	ready for simulation purpose.

0.0.2 - Additional configuration possibilies:
	multiple queue types, job types and price authorities
	can be specified in configuration file.

0.0.1 - Additional configuration possibilites.

0.0.0 - First version: only Hybrid pricing model supported.
        Only price sensitive utility function implemented for the resource
        broker.


License
-------

Copyright (c) 2003-2004 INFN on behalf of the EU DataGrid.
For license conditions see LICENSE file or read

http://www.edg.org/license.html


Software Requirements
---------------------

DGAS-Sim has been tested on i386-Linux systems.
Other platforms should work as well.

Running DGAS-Sim requires:
 - Java(TM) 2 SDK: Version 1.4 or greater
   (most of the code is compliant to older Java versions as well, but
    not tests have been done)

Documentation
-------------

A manual has still to be written. For now, these files, the API documentation
and the comments in the configuration file (read them!) should be enough.

To generate the API documentation use the following script (the script needs
javadoc to be installed):

./make_doc.sh

The documentation will be created in the directory doc/html. Display the file
index.html with your browser.


Installing DGAS-Sim
-------------------

See INSTALL file.


Usage
-----

./start_DGAS-Sim.sh [configuration file]

If no configuration file is specified the default
etc/dgas-sim.conf is used. 

Users must have write access to the current directory
so output files can be written.


Known BUGS
----------

See BUGS file.


Future Plans
------------

See TODO file.


Contact
-------

The author can be contacted at:

piro@to.infn.it (Rosario M. Piro)

