Browse Source

Information on some new scripts

Yentl Van Tendeloo 3 years ago
parent
commit
f13d226d6e
1 changed files with 36 additions and 0 deletions
  1. 36 0
      doc/scripts.rst

+ 36 - 0
doc/scripts.rst

@@ -85,3 +85,39 @@ Run the relatively fast tests for the Modelverse.
 Invocation::
 
     python scripts/run_basic_tests.py
+
+test_compile.py
+---------------
+
+Run the compiler for a given input file, to detect whether it can be compiled or not.
+The command does not return anything if the file could be compiled, but prints an exception if there was a parsing error.
+Mostly used to validate large files for syntax errors or for profiling of the compiler.
+This script parses the file using Action Language syntax.
+
+Invocation::
+
+    python scripts/test_compile.py file.alc
+
+test_model_compile.py
+---------------------
+
+Identical to test_compile.py, mentioned above, but now expects a HUTN modelling syntax.
+
+Invocation::
+    
+    python scripts/test_model_compile.py file.mvc
+
+upload_core.py
+--------------
+
+Uploads the initial version of the bootstrap code as an actual Action Language model that will be loaded at startup.
+This does take some time and requires quite some resources of the Modelverse as well, as the bootstrap code is rather large.
+Normally this code is not necessary, although it would be if the bootstrap code has to be altered for different users.
+
+Note that this uploads the file stored in *bootstrap/merged.alm*, which is an automatically generated file from all bootstrap files.
+This file is automatically generated by the script *generate_bootstrap.py*, but can be manually edited to change the core library of a running Modelverse.
+After the core is uploaded, the model can also be incrementally modified from within the Modelverse itself.
+
+Invocation::
+
+    python scripts/upload_core.py