blob: da2cba1787f75daec60acc94ac68dde3637bf6cd [file] [log] [blame]
mparker8c858af2010-04-29 03:11:32 +00001=Installation Guide=
2
3==Tools==
4
5===Complete IDE===
6
7You may already have obtained a complete IDE bundled with AMP and other modeling tools. The project contributors offer open source and commercial versions of the AMP tools, which you can find at their sites. If so, you can mostly ignore this chapter unless you want to install an optional component like Repast.
8
9===Eclipse and the Agent Modeling Tools===
10
11You can find more detailed instructions [http://eclipse.org/amp/installing/ here], but here are the basic steps.
12
13#Install the latest version of Eclipse from [http://www.eclipse.org/downloads/ here]. AMP requires version 3.5.x (Gallieo) or higher. Version 3.6 (Hellos) which is currently a development (beta) release works well too. We recommend the "Classic" release at the bottom of the page as the other releases have a bunch of stuff you wont' need.
14#Add update sites for AMP and AMP dependencies. See the screenshot below and the [http://help.eclipse.org/galileo/topic/org.eclipse.platform.doc.user/tasks/tasks-124.htm Eclipse Documentation]. There are different versions of the update sites, depending on whether you want to use the most stable version of the toolset or the "latest and greatest". The update sites are listed below.
15#(Optional) If you install and AMP extensions, add Update Sites for them -- they're also listed below.
16#Select the features that you want to install.
17#Click the '''Next''' button, review the licenses, and then click '''Finish'''.
18
19Agent Modeling Platform update sites:
20 Milestones (recommended): http://download.eclipse.org/amp/updates/milestones
21 Interim (newer): http://download.eclipse.org/amp/updates/interim
22 Nightly (bleeding edge): http://download.eclipse.org/amp/updates/nightly
23
24Update sites for AMP Extensions
25 AGF 3D (recommended): http://lwjgl.org/update
26 AMF for Ascape (recommended for Java developers): http://ascape.sourceforge.net/eclipse
27 AMF for Repast (for people using Repast): http://mirror.anl.gov/pub/repastsimphony/site.xml (non P2)
28
29In the following screenshot, we've added the LWJGL site (not shown) as well as the Ascape site (not shown), but not the Repast site, and we're about to install the respective features.
30
31[[Image:images/resources/AMPUpdateSite.png]]
32
33Once you've done that, select the '''Help > Help Contents''' menu, find the Agent Modeling Guide and open this overview page within that guide.
34
35===Extensions===
36
37====Ascape====
38
39For licensing and copyright reasons we can't provide all of the Ascape tools and manual on the Eclipse hosted Agent Modeling Project site. None of these tools are necessary to use AMP (the core Ascape support is an IP approved part of the AMP distribution) but they're highly recommended. The Ascape tools include:
40
41#An excellent Manual covering programming Java models in Ascape and Escape. (The API is the same.)
42#Support for creating Ascape Java projects and executing the Swing-based Java Applications. Swing deployed Ascape Java Applications can be as small as 10MB and can be deployed to the web.
43#Eclipse based IDE support for plain Java Ascape projects.
44
45The Ascape update site is at:
46
47 http://ascape.sourceforge.net/eclipse
48
49To install Ascape, use the update manager. Select '''Help > Install New Software..."''', add the Ascape update site, select the Ascape category and click the '''Finish''' button.
50
51[[Image:images/resources/AscapeUpdateSite.png]]
52
53====Repast====
54
55The Repast update site is at:
56
57 http://mirror.anl.gov/pub/repastsimphony/site.xml
58
59More information on downloading and installing repast can be found [http://repast.sourceforge.net/docs/development.html here]. Follow the instrucitons for "Configuration B".
60
61==Models==
62
63===Obtaining Example Models===
64
65There is a cheat-sheet available for obtaining the example models. If you would rather obtain them yourself, here is the CVS information:
66
67====Team Project Sets====
68
69You can use the following team project sets. See [http://help.eclipse.org/galileo/topic/org.eclipse.platform.doc.user/tasks/tasks-cvs-project-set.htm this document] for more information about using project sets.
70
71 http://eclipse.org/amp/project-sets/ascape.psf
72 http://eclipse.org/amp/project-sets/escapeAMFExamples.psf
73
74====From Version Control Systems====
75
76Import the CVS projects from the AMP project repository. For help, see [http://help.eclipse.org/help32/index.jsp?topic=/org.eclipse.platform.doc.user/reference/ref-40a.htm this page]. Here are the details for CVS Access:
77
78CVS Repository:
79
80 Connection type: pserver
81 User: anonymous
82 Password: [none]
83 Host: dev.eclipse.org
84 Path: /cvsroot/modeling
85 Module: /org.eclipse.amp
86
87AMF Escape Models:
88
89 org.eclipse.amp/org.eclipse.amp.amf/examples/org.eclipse.amp.amf.examples.escape
90
91AMF Ascape and Repast Models:
92
93 org.eclipse.amp/org.eclipse.amp.amf/examples/org.eclipse.amp.amf.examples.ascape
94 org.eclipse.amp/org.eclipse.amp.amf/examples/org.eclipse.amp.amf.examples.repast
95
96The Ascape example projects are available at the Sourceforge SVN server. You can get them at the following locations. See the [[http://www.eclipse.org/subversive/documentation/teamSupport/find_check_wiz.php Subversive User Guide]] for more information about using SVN. (You'll need to install Subversion if you don't already have it.)
97
98Escape Java Models:
99
100 https://ascape.svn.sourceforge.net/svnroot/ascape/org.ascape.models.brook
101 https://ascape.svn.sourceforge.net/svnroot/ascape/org.ascape.models.examples
102
103Ascape (Swing-based) Java Models:
104
105
106 https://ascape.svn.sourceforge.net/svnroot/ascape/org.ascape.escape.models.examples
107 https://ascape.svn.sourceforge.net/svnroot/ascape/org.ascape.escape.models.brook
108