glaville / mcmas

Commit a4185c0f3476766e3895ddc7aa19886b4b8b8923

Authored by glaville 2014-06-20 10:06:04 +0200

update README

Showing 1 changed file with 58 additions and 0 deletions Side-by-side Diff

README

	1	+======== REQUIREMENTS ========
	2	+
	3	+- Java 5 or newer
	4	+- Apache Ant
	5	+
	6	+======== DEPENDENCIES ========
	7	+
	8	+MCSMA use the Apache Ivy library to manage its dependencies,
	9	+using a format similar to Maven repositories.
	10	+
	11	+A copy is Ivy is bundled by default with the application in the ivy/ directory.
	12	+To update it to the last available online version, use:
	13	+
	14	+ant download-ivy
	15	+
	16	+To retrieve all project dependencies, in particular Geotools,
	17	+used by the Collembola model, use:
	18	+
	19	+ant resolve
	20	+
	21	+======== COMPILATION ========
	22	+
	23	+In the projet root, use:
	24	+
	25	+ant build
	26	+
	27	+======== JAR CREATION ========
	28	+
	29	+In the project root, use:
	30	+
	31	+ant jar
	32	+
	33	+======== JAVADOC ========
	34	+
	35	+To generate Java doc in doc/, use:
	36	+
	37	+ant doc
	38	+
	39	+======== EXECUTION ========
	40	+
	41	+The utils/run.sh script contains an exemple of invocation
	42	+of the framework.
	43	+
	44	+The src/mcsma/core/examples directory contains examples of MCSMA low-level
	45	+interface usage, in use cases such as Game of Life, Grid manipulations...
	46	+
	47	+The src/mcsma/plugins/ directory contains all plugins bundled with MCSMA:
	48	+For external plugins, please refer to their own archives.
	49	+
	50	+======== EXAMPLES ========
	51	+
	52	+src/ocl/examples contains various examples of usage for the base library
	53	+(compilation of GPU source code, execution on GPU and result retrieval)
	54	+
	55	+src/mior and src/collembola contains two research models implemented using
	56	+this base library, using more complex kernels and functionnalities
	57	+
	58	+kernels/ contains all the OpenCL GPU kernels used by these models and examples.