|
|
@@ -6,7 +6,7 @@
|
|
|
<head>
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
|
|
- <title>How to run — Modelverse 0.4.0 documentation</title>
|
|
|
+ <title>How to run — Modelverse 0.6.1 documentation</title>
|
|
|
|
|
|
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
|
@@ -14,7 +14,7 @@
|
|
|
<script type="text/javascript">
|
|
|
var DOCUMENTATION_OPTIONS = {
|
|
|
URL_ROOT: './',
|
|
|
- VERSION: '0.4.0',
|
|
|
+ VERSION: '0.6.1',
|
|
|
COLLAPSE_INDEX: false,
|
|
|
FILE_SUFFIX: '.html',
|
|
|
HAS_SOURCE: true
|
|
|
@@ -23,7 +23,7 @@
|
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
|
- <link rel="top" title="Modelverse 0.4.0 documentation" href="index.html" />
|
|
|
+ <link rel="top" title="Modelverse 0.6.1 documentation" href="index.html" />
|
|
|
<link rel="next" title="Action Language" href="actionlanguage.html" />
|
|
|
<link rel="prev" title="Modelverse components" href="components.html" />
|
|
|
</head>
|
|
|
@@ -40,7 +40,7 @@
|
|
|
<li class="right" >
|
|
|
<a href="components.html" title="Modelverse components"
|
|
|
accesskey="P">previous</a> |</li>
|
|
|
- <li class="nav-item nav-item-0"><a href="index.html">Modelverse 0.4.0 documentation</a> »</li>
|
|
|
+ <li class="nav-item nav-item-0"><a href="index.html">Modelverse 0.6.1 documentation</a> »</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
|
|
|
@@ -61,9 +61,9 @@ This script cannot be executed directly and is only a helper.</p>
|
|
|
<div class="section" id="compile-py">
|
|
|
<h2>compile.py<a class="headerlink" href="#compile-py" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>Compiles the provided code with the selected mode.
|
|
|
-This should also not be called by end-users, though it is possible.</p>
|
|
|
+This should also not be called by end-tasks, though it is possible.</p>
|
|
|
<p>Invocation:</p>
|
|
|
-<div class="highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="nb">compile</span><span class="o">.</span><span class="n">py</span> <span class="n">address</span> <span class="n">file</span> <span class="n">username</span> <span class="nb">object</span> <span class="n">mode</span>
|
|
|
+<div class="highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="nb">compile</span><span class="o">.</span><span class="n">py</span> <span class="n">address</span> <span class="n">file</span> <span class="n">taskname</span> <span class="nb">object</span> <span class="n">mode</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<table border="1" class="docutils">
|
|
|
@@ -87,9 +87,9 @@ This should also not be called by end-users, though it is possible.</p>
|
|
|
<td>File to be compiled</td>
|
|
|
<td>file.alc</td>
|
|
|
</tr>
|
|
|
-<tr class="row-even"><td>username</td>
|
|
|
-<td>Username to use when compiling</td>
|
|
|
-<td>test_user</td>
|
|
|
+<tr class="row-even"><td>taskname</td>
|
|
|
+<td>Taskname to use when compiling</td>
|
|
|
+<td>test_task</td>
|
|
|
</tr>
|
|
|
<tr class="row-odd"><td>object</td>
|
|
|
<td>Object name to export to</td>
|
|
|
@@ -108,7 +108,7 @@ This should also not be called by end-users, though it is possible.</p>
|
|
|
First, all models are added, and then the action language is executed, starting at function “main”.
|
|
|
Models being created are temporary, so they need to be exported before they can be accessed in the action language.</p>
|
|
|
<p>Invocation:</p>
|
|
|
-<div class="highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">execute_model</span><span class="o">.</span><span class="n">py</span> <span class="n">address</span> <span class="n">username</span> <span class="n">file1</span> <span class="n">file2</span> <span class="o">...</span>
|
|
|
+<div class="highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">execute_model</span><span class="o">.</span><span class="n">py</span> <span class="n">address</span> <span class="n">taskname</span> <span class="n">file1</span> <span class="n">file2</span> <span class="o">...</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<table border="1" class="docutils">
|
|
|
@@ -128,8 +128,8 @@ Models being created are temporary, so they need to be exported before they can
|
|
|
<td>Address of the Modelverse</td>
|
|
|
<td><a class="reference external" href="http://localhost:8001">http://localhost:8001</a></td>
|
|
|
</tr>
|
|
|
-<tr class="row-odd"><td>username</td>
|
|
|
-<td>Username to use when compiling</td>
|
|
|
+<tr class="row-odd"><td>taskname</td>
|
|
|
+<td>Taskname to use when compiling</td>
|
|
|
<td>test</td>
|
|
|
</tr>
|
|
|
<tr class="row-even"><td>file</td>
|
|
|
@@ -162,7 +162,7 @@ When changing the compiler, this file should be executed to flush these file cac
|
|
|
<div class="section" id="generate-bootstrap-py">
|
|
|
<h2>generate_bootstrap.py<a class="headerlink" href="#generate-bootstrap-py" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>Creates the bootstrap file for the Modelverse State.
|
|
|
-This creates the necessary initial graph which contains links to all primitive code that is executed by the Modelverse before users can communicate with it.
|
|
|
+This creates the necessary initial graph which contains links to all primitive code that is executed by the Modelverse before tasks can communicate with it.
|
|
|
Generally, this needs to be executed when any file in the <em>bootstrap/</em> folder is modified.
|
|
|
Compilation is fairly smart, only recompiling parts that have changed.</p>
|
|
|
<p>Invocation:</p>
|
|
|
@@ -173,9 +173,9 @@ Compilation is fairly smart, only recompiling parts that have changed.</p>
|
|
|
<div class="section" id="link-and-load-py">
|
|
|
<h2>link_and_load.py<a class="headerlink" href="#link-and-load-py" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>This takes a set of objects in the Modelverse, links them together in a single “executable” and executes it immediately.
|
|
|
-Generally not needed by end-users.</p>
|
|
|
+Generally not needed by end-tasks.</p>
|
|
|
<p>Invocation:</p>
|
|
|
-<div class="highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">link_and_load</span><span class="o">.</span><span class="n">py</span> <span class="n">address</span> <span class="n">username</span> <span class="n">object1</span> <span class="n">object2</span> <span class="o">...</span>
|
|
|
+<div class="highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">link_and_load</span><span class="o">.</span><span class="n">py</span> <span class="n">address</span> <span class="n">taskname</span> <span class="n">object1</span> <span class="n">object2</span> <span class="o">...</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<table border="1" class="docutils">
|
|
|
@@ -195,8 +195,8 @@ Generally not needed by end-users.</p>
|
|
|
<td>Address of the Modelverse</td>
|
|
|
<td><a class="reference external" href="http://localhost:8001">http://localhost:8001</a></td>
|
|
|
</tr>
|
|
|
-<tr class="row-odd"><td>username</td>
|
|
|
-<td>Username to use when compiling</td>
|
|
|
+<tr class="row-odd"><td>taskname</td>
|
|
|
+<td>Taskname to use when compiling</td>
|
|
|
<td>test</td>
|
|
|
</tr>
|
|
|
<tr class="row-even"><td>object</td>
|
|
|
@@ -208,10 +208,9 @@ Generally not needed by end-users.</p>
|
|
|
</div>
|
|
|
<div class="section" id="make-all-py">
|
|
|
<h2>make_all.py<a class="headerlink" href="#make-all-py" title="Permalink to this headline">¶</a></h2>
|
|
|
-<p>Compile a set of files and executes them immediately.
|
|
|
-This uses constructors by default, which is the most elegant, but also the slowest.</p>
|
|
|
+<p>Compile a set of files and executes them immediately.</p>
|
|
|
<p>Invocation:</p>
|
|
|
-<div class="highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">make_all</span><span class="o">.</span><span class="n">py</span> <span class="n">address</span> <span class="n">username</span> <span class="n">file1</span> <span class="n">file2</span> <span class="o">...</span>
|
|
|
+<div class="highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">make_all</span><span class="o">.</span><span class="n">py</span> <span class="n">address</span> <span class="n">taskname</span> <span class="n">file1</span> <span class="n">file2</span> <span class="o">...</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<table border="1" class="docutils">
|
|
|
@@ -231,8 +230,8 @@ This uses constructors by default, which is the most elegant, but also the slowe
|
|
|
<td>Address of the Modelverse</td>
|
|
|
<td><a class="reference external" href="http://localhost:8001">http://localhost:8001</a></td>
|
|
|
</tr>
|
|
|
-<tr class="row-odd"><td>username</td>
|
|
|
-<td>Username to use when compiling</td>
|
|
|
+<tr class="row-odd"><td>taskname</td>
|
|
|
+<td>Taskname to use when compiling</td>
|
|
|
<td>test</td>
|
|
|
</tr>
|
|
|
<tr class="row-even"><td>file</td>
|
|
|
@@ -244,11 +243,9 @@ This uses constructors by default, which is the most elegant, but also the slowe
|
|
|
</div>
|
|
|
<div class="section" id="make-parallel-py">
|
|
|
<h2>make_parallel.py<a class="headerlink" href="#make-parallel-py" title="Permalink to this headline">¶</a></h2>
|
|
|
-<p>A parallel version of make_all.py.
|
|
|
-This uses the direct graph compilation, and compiles these graphs in parallel.
|
|
|
-This is much faster than make_all, though much less elegant.</p>
|
|
|
+<p>A parallel version of make_all.py.</p>
|
|
|
<p>Invocation:</p>
|
|
|
-<div class="highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">make_parallel</span><span class="o">.</span><span class="n">py</span> <span class="n">address</span> <span class="n">username</span> <span class="n">file1</span> <span class="n">file2</span> <span class="o">...</span>
|
|
|
+<div class="highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">make_parallel</span><span class="o">.</span><span class="n">py</span> <span class="n">address</span> <span class="n">taskname</span> <span class="n">file1</span> <span class="n">file2</span> <span class="o">...</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<table border="1" class="docutils">
|
|
|
@@ -268,8 +265,8 @@ This is much faster than make_all, though much less elegant.</p>
|
|
|
<td>Address of the Modelverse</td>
|
|
|
<td><a class="reference external" href="http://localhost:8001">http://localhost:8001</a></td>
|
|
|
</tr>
|
|
|
-<tr class="row-odd"><td>username</td>
|
|
|
-<td>Username to use when compiling</td>
|
|
|
+<tr class="row-odd"><td>taskname</td>
|
|
|
+<td>Taskname to use when compiling</td>
|
|
|
<td>test</td>
|
|
|
</tr>
|
|
|
<tr class="row-even"><td>file</td>
|
|
|
@@ -282,7 +279,7 @@ This is much faster than make_all, though much less elegant.</p>
|
|
|
<div class="section" id="prompt-py">
|
|
|
<h2>prompt.py<a class="headerlink" href="#prompt-py" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>A generic prompt interface to the Modelverse.
|
|
|
-You can log in as a specific user and start sending input messages to the Modelverse as that user.
|
|
|
+You can log in as a specific task and start sending input messages to the Modelverse as that task.
|
|
|
All output sent by the Modelverse will be printed in the console.
|
|
|
There is no logic in the prompt itself, making it completely generic.</p>
|
|
|
<p>Invocation:</p>
|
|
|
@@ -394,7 +391,7 @@ To split them up, there just needs to be a statechart in between both of them (w
|
|
|
<li class="right" >
|
|
|
<a href="components.html" title="Modelverse components"
|
|
|
>previous</a> |</li>
|
|
|
- <li class="nav-item nav-item-0"><a href="index.html">Modelverse 0.4.0 documentation</a> »</li>
|
|
|
+ <li class="nav-item nav-item-0"><a href="index.html">Modelverse 0.6.1 documentation</a> »</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
<div class="footer" role="contentinfo">
|
