-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathREADME.html
313 lines (264 loc) · 10.5 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
<html>
<head>
<LINK href="style.css" rel="stylesheet" type="text/css">
<title> ScalaTion </title>
</head>
<body>
<center>
<h1> SCALAble SimulaTION - ScalaTion </h1>
<p>
<a href = "#papers">Papers</a> | <a href = "#scaladoc">Scaladoc</a> | <a href = "#source-code"> Source Code</a>
</center>
<p>
<b> Welcome to ScalaTion, the Scala-based system for Simulation, Optimization and Analytics. </b>
<p>
This system, coded in Scala, supports multi-paradigm simulation modeling including
'tableau', 'event', 'process', 'dynamics', 'dynamics_pde', 'activity' and 'state' oriented models.
<p>
<a href = "http://www.scala-lang.org">Scala</a> is a modern object-oriented, functional programming language
that is well-suited for developing simulation engines.
It is in the Java family of languages and can call Java code.
The inclusion of advanced and functional programming capabilities,
makes the code much more concise than Java.
ScalaTion also supports optimization and analytics as they nowadays go hand-in-hand with simulation modeling.
Some of the algorithms come in both sequential and parallel versions.
<p>
The <b>ScalaTion 2.0</b> version defines multiple .par subpackages that contain parallel versions of sequential algorithms.
Future directions include completing the 'scala3d' and 'physics' packages.
<p>
Please read the <a href = LICENSE.html> LICENSE </a> file (an MIT style license).
<p><hr><p>
<h3> Installation Instructions </h3>
Version 2.0 Requires:
<a href = "https://www.scala-lang.org/download">Scala 3.3.0</a> and
<a href = "https://www.oracle.com/java/technologies/javase-downloads.html">Java 17 to Java 20</a>
(or from <a href = "https://jdk.java.net/archive">Open JDK Archive</a>)
<br>
Recommended:
<a href = "http://www.scala-sbt.org/">sbt</a>
(see <a href = "http://www.scala-sbt.org/1.x/docs/Setup.html">Setup.html</a>)
<br>
Getting started: <a href = "https://www.scala-sbt.org/1.x/docs/Hello.html">sbt Hello, World</a>
<h4>1. Download one of the following two files</h4>
<a href = "../scalation_2.0.tar.gz"> scalation_2.0.tar.gz </a> <br> <b>OR</b> <br>
<a href = "../scalation_2.0.zip"> scalation_2.0.zip </a>
<p>
<h4>2. Untar or unzip the file</h4>
<pre><code>
$ tar xvfz scalation_2.0.tar.gz <br> <b>OR</b>
$ unzip scalation_2.0.zip
</code></pre>
<h4>3. To build all the modules, change into the ScalaTion base directory and run sbt</h4>
<pre><code>
$ cd scalation_2.0
$ sbt compile
</code></pre>
<h4>4. To compile code or run apps, enter sbt and type compile, runMain or exit </h4>
<pre><code>
$ sbt
> compile
> runMain scalation.modeling.simpleRegressionTest
> runMain scalation.modeling.regressionTest
> exit
</code></pre>
<p>
The compile command is optional, since runMain will automatically compile if need be.
<p>
ScalaTion is set up to use the Simple Build Tool <a href = "http://www.scala-sbt.org">sbt</a>.
ScalaTion 2.0 uses the following build specification file:
<ol>
<li>
Build Specification: <a href = "build.sbt">build.sbt</a>,
</ol>
Source packages are in the <b>src/main/scala</b> directory,
class files are in the <b>target/scala-3.3.0/classes</b> directory, and
documentation files are in the <b>target/scala-3.3.0/api</b> directory.
Unmanaged jar files are stored in a common library <b>lib</b> directory, <a href = "where_is_jar.txt">where_is_jar.txt</a>.
Data file input, output or analytics are stored in subdirectories of <b>data</b>,
while database files are stored in <b>store</b>.
<h4>5. To develop projects that use ScalaTion that are outside ScalaTion do the following </h4>
<pre><code>
$ cd your_project_dir
$ sbt new sbt/scala-seed.g8
$ cd hello
$ mkdir lib
copy jar files from <a href = "lib">lib</a>
$ cd src/main/scala/example
$ vim Hello.scala
</code></pre>
The second time you do this, you will want to use a more appropriate name than hello.
<p><hr><p>
<h4>6. Alternatively, you may use my_scalation_2.0</h4>
Downloading and (unzip/tar xvfz) either
<a href = "../my_scalation_2.0.zip">my_scalation_2.0.zip</a> <b>or</b>
<a href = "../my_scalation_2.0.tar.gz">my_scalation_2.0.tar.gz</a> and then
<pre><code>
$ cd my_scalation_2.0
$ ls -l lib
$ sbt
> run
</code></pre>
Check to make sure the ScalaTion .jar file is in the lib directory (ls -l lib).
The location of ScalaTion's .jar file may be found in
<a href = "where_is_jar.txt">where_is_jar.txt</a>.
The sbt run command will allow you to choose any main method to run (or you may use runMain).
<p><hr><p>
To develop using an Integrated Development Environment (IDE) [IntelliJ]:
<ol>
<li>
<a href = "https://www.jetbrains.com/idea/download">IntelliJ IDEA</a>
<li>
<a href = "https://www.jetbrains.com/help/idea/discover-intellij-idea-for-scala.html">Scala Plugin</a>
</ol>
<A name = "papers">
<p><hr><p>
<h3> Papers/Documentation </h3>
<p>
<ol>
<li>
John A. Miller, Jun Han and Maria Hybinette,
<a href = "http://informs-sim.org/wsc10papers/067.pdf">
"Using Domain Specific Languages for Modeling and Simulation: ScalaTion as a Case Study,"</a>
Proceedings of the 2010 ACM/IEEE Winter Simulation Conference (WSC'10),
Baltimore, Maryland (December 2010) pp. 741-752.
<p>
<li>
Michael E. Cotterell, John A. Miller, Tom Horton,
<a href = "http://arxiv.org/abs/1112.1751">
"Unicode in Domain-Specific Programming Languages for Modeling & Simulation:
ScalaTion as a Case Study,"</a>
Arxiv preprint arXiv:1112.175
(December 2011) pp. 1-10.
<p>
<li>
Michael E. Cotterell, John A. Miller, Jun Han and Tom Horton,
<a href = "../scalation_papers/alasim/alasim_extended_abstract.pdf">
"Extending ScalaTion, a Domain-Specific Language for Modeling & Simulation, for Simulation Optimization,"</a>
Proceedings of the AlaSim International Modeling and Simulation Conference & Exhibition (AlaSim'12),
Huntsville, Alabama (May 2012) pp. 1-1.
<p>
<li>
Yung Long Li,
<a href = "../home/theses/li_thesis/thesis/TR_Yung_Long_Li.pdf">
"Evaluation of Parallel Implementations of Dense and Sparse
Matrices for the ScalaTion Library," </a>
Technical Report,
University of Georgia (December 2012) pp. 1-60.
<p>
<li>
John A. Miller, Michael E. Cotterell and Stephen J. Buckley,
<a href = "http://informs-sim.org/wsc13papers/includes/files/104.pdf">
"Supporting a Modeling Continuum in ScalaTion: From Predictive Analytics to Simulation Modeling,"</a>
Proceedings of the 2013 ACM/IEEE Winter Simulation Conference (WSC'13),
Washington, DC (December 2013) pp. 1191-1202.
<p>
<li>
Matthew Saltz, Ayushi Jain, Abhishek Kothari, Arash Fard, John A. Miller, and Lakshmish Ramaswamy,
<a href = "http://www.thecloudcomputing.org/2014/AdvanceProgram-ICWS-SCC-CLOUD-MS-BigDataCongress-SERVICES-2014.pdf">
"DualIso: An Algorithm for Subgraph Pattern Matching on Very Large Labeled Graphs,"</a>
<I> Proceedings of the 3rd IEEE International Congress on Big Data </I>
(<a href = "http://www.ieeebigdata.org/2014">BigData'14</a>),
Anchorage, Alaska (June-July 2014) pp. 498-505.
<br>
Online <a href = "../home/theses/jain_thesis/bigdata_2014/BigDataCong2014_DualIso_Supplement.pdf">supplement</a>
</ol>
<A name = "scaladoc">
<p><hr><p>
<h3> Source Packages (doc) </h3>
<p>
<blockquote>
<table border = 3>
<tr>
<td> <b>Package</b>
<td> <b>Description</b>
<tr>
<tr>
<tr>
<td> <a href = "target/scala-3.3.0/api/index.html"><b>scalation</b></a>
<td> <b>The scalation foundational packages.</b>
<tr>
<tr>
<tr>
<td> <a href = "target/scala-3.3.0/api/scalation/animation.html"> animation </a>
<td> The `animation` package supports the animation of models.
<tr>
<td> <a href = "target/scala-3.3.0/api/scalation/calculus.html"> calculus </a>
<td> The `calculus` package supports numerical differentiation and integration.
<tr>
<td> <a href = "target/scala-3.3.0/api/scalation/database.html"> database </a>
<td> The `database` package supports relational and graph databases.
<tr>
<td> <a href = "target/scala-3.3.0/api/scalation/dynamics.html"> dynamics </a>
<td> The `dynamics` package supports the development of ODE models.
<tr>
<td> <a href = "target/scala-3.3.0/api/scalation/mathstat.html"> mathstat </a>
<td> The `mathstat` package supports basic math and statistics.
<tr>
<td> <a href = "target/scala-3.3.0/api/scalation/modeling.html"> modeling </a>
<td> The `modeling` package supports the development of several type of data science models.
<tr>
<td> <a href = "target/scala-3.3.0/api/scalation/optimization.html"> optimization </a>
<td> The `optimization` package supports linear and nonlinear optimization.
<tr>
<td> <a href = "target/scala-3.3.0/api/scalation/random.html"> random </a>
<td> The `random` package supports random variate generation.
<tr>
<td> <a href = "target/scala-3.3.0/api/scalation/scala2d.html"> scala2d </a>
<td> The `scala2d` package supports simple 2D graphics in scala, based upon `java.swing`, `java.awt` and `java_awt_geom`.
<tr>
<td> <a href = "target/scala-3.3.0/api/scalation/simulation.html"> simulation </a>
<td> The `simulation` package supports the development of simulation models.
<tr>
</table>
</blockquote>
<A name = "source-code">
<p>
<h3> Source Packages (src) </h3>
<p>
<blockquote>
<table border = 3>
<tr>
<td> <b>Package</b>
<td> <b>Description</b>
<tr>
<tr>
<tr>
<td> <a href = "src/main/scala/scalation"><b>scalation</b></a>
<td> <b>Scalation Foundational Packages.</b>
<tr>
<tr>
<tr>
<td> <a href = "src/main/scala/scalation/animation/"> animation </a>
<td> The `animation` package supports the animation of models.
<tr>
<td> <a href = "src/main/scala/scalation/calculus/"> calculus </a>
<td> The `calculus` package supports numerical differentiation and integration.
<tr>
<td> <a href = "src/main/scala/scalation/database/"> database </a>
<td> The `database` package supports relational and graph databases.
<tr>
<td> <a href = "src/main/scala/scalation/dynamics/"> dynamics </a>
<td> The `dynamics` package supports development of ODE models.
<tr>
<td> <a href = "src/main/scala/scalation/mathstat/"> mathstat </a>
<td> The `mathstat` package supports basic math and statistics.
<tr>
<td> <a href = "src/main/scala/scalation/modeling"> modeling </a>
<td> The `modeling` package supports the development of several type of data science models.
<tr>
<td> <a href = "src/main/scala/scalation/optimization/"> optimization </a>
<td> The `optimization` package supports linear and nonlinear optimization.
<tr>
<td> <a href = "src/main/scala/scalation/random/"> random </a>
<td> The `random` package supports random variate generation.
<tr>
<td> <a href = "src/main/scala/scalation/scala2d/"> scala2d </a>
<td> The `scala2d` package supports simple 2D graphics in scala, based upon `java.swing`, `java.awt` and `java_awt_geom`.
<tr>
<td> <a href = "src/main/scala/scalation/simulation/"> simulation </a>
<td> The `simulation` package supports the development of simulation models.
<tr>
</blockquote>
<p>
</body>
</html>