Table of Contents
-----------------

1. Directory structure of the CloudSim Toolkit
2. Software requirements: Java version 1.6 or newer 
3. Installation and running the CloudSim Toolkit
4. Running the CloudSim examples
5. Learning CloudSim
6. Compiling CloudSim: using Ant



1. Directory structure of the CloudSim Toolkit
----------------------------------------------

cloudsim/			-- top level CloudSim directory
	docs/			-- CloudSim API Documentation
	examples/		-- CloudSim examples
	jars/			-- CloudSim jar archives
	sources/		-- CloudSim source code
	tests/			-- CloudSim unit tests


2. Software requirements: Java version 1.6 or newer
---------------------------------------------------

CloudSim has been tested and ran on Sun's Java version 1.6.0 or newer.
Older versions of Java are not compatible.
If you have non-Sun Java version, such as gcj or J++, they may not be compatible.
You also need to install Ant to compile CloudSim (explained in more details later).


3. Installation and running the CloudSim Toolkit
------------------------------------------------

You just need to unpack the CloudSim file to install.
If you want to remove CloudSim, then remove the whole cloudsim directory.
You do not need to compile CloudSim source code. The JAR files are
provided to compile and to run CloudSim applications:

  * jars/cloudsim-<VERSION>.jar						-- contains the CloudSim class files
  * jars/cloudsim-<VERSION>-sources.jar				-- contains the CloudSim source code files
  * jars/cloudsim-examples-<VERSION>.jar			-- contains the CloudSim examples class files
  * jars/cloudsim-examples-<VERSION>-sources.jar	-- contains the CloudSim examples source code files


4. Running the CloudSim examples
--------------------------------

Please read how to run the CloudSim examples in examples.txt


5. Learning CloudSim
--------------------

To understand how to use CloudSim, please go through the examples provided
in the examples/ directory.


6. Compiling CloudSim: using Ant
--------------------------------

This release contains a simple buildfile for compiling CloudSim classes.
You need to have ant installed (http://ant.apache.org/).
Ant can be used in both Windows and Unix/Linux environment.

Usage:

  * Being in the CloudSim root directory (cloudsim/), type 'ant' to compile all 
    cloudsim source files, put them into the classes/ directory and to create 
    a cloudsim-new.jar file in the jars/ directory
    
  * Being in the CloudSim root directory (cloudsim/), type 'ant clean' to delete 
    all the compiled classes and the classes/ directory itself. The generated 
    cloudsim-new.jar is not deleted.

Note:

  * You need to set up PATH for ant in Windows and/or Unix.
  
  
 7. Downloading and using external jars
---------------------------------------

Some of the algorithms in the power package require Michael Thomas Flanagan's 
Java Scientific Library. This library can be downloaded from

http://www.ee.ucl.ac.uk/~mflanaga/java/

Once the library is downloaded, copy it to the jars/ directory. If you are running 
Linux, you can just run the ./install-flanagan.sh script, that will download the
library and place it in the jars/ directory.

Please, make sure that, by using such library, you are respecting the terms of use
defined by the software's author.


